Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
unihan-etl 0.40.0 documentation
Light Logo Dark Logo
unihan-etl 0.40.0 documentation
  • Quickstart
  • Commands
    • unihan-etl export
    • unihan-etl download
    • unihan-etl search
    • unihan-etl fields
    • unihan-etl files
  • API
    • Core - unihan_etl.core
    • Options - unihan_etl.options
    • Expansion - unihan_etl.expansion
    • Typings - unihan_etl.types
    • Constants - unihan_etl.constants
    • Test helpers - unihan_etl.test
    • Utilities - unihan_etl.util
    • Internal API
      • App directories - unihan_etl._internal.app_dirs
  • pytest plugin

Project

  • About UNIHAN
  • Frequently Asked Questions
  • Changelog
  • Migration notes
  • Developer Guide
  • GitHub

team git-pull / Tony Narlock:

vcs-python vcspull (libvcs), g

tmux-python tmuxp (libtmux)

cihai unihan-etl (db) cihai (cli)

django django-slugify-processor django-docutils

docs + tests gp-libs

web social-embed

Back to top
View this page
Edit this page

unihan-etl search¶

Look up character data in the UNIHAN database.

Command¶

Search and look up UNIHAN characters.

Look up character data by character, UCN (U+XXXX), or hex codepoint. Requires UNIHAN data to be downloaded (will download if not cached).

Usage¶

usage: unihan-etl search [-h] [-f [FIELDS ...]] [--json | --ndjson] char

Examples¶

$ unihan-etl search 好
$ unihan-etl search U+597D
$ unihan-etl search 597D

Output Format¶

$ unihan-etl search 好 --json
$ unihan-etl search 好 --ndjson

Field Filtering¶

$ unihan-etl search 好 -f kDefinition kMandarin

Positional Arguments¶

char¶

Character, UCN (U+XXXX), or hex codepoint to look up.

Default
None
Required

Options¶

-f, --fields¶

Fields to include in output. Shows all non-empty fields by default.

Default
None
--json¶

Output as JSON

Default
False
--ndjson¶

Output as newline-delimited JSON (one record per line)

Default
False

Examples¶

Look up a character by its form:

$ unihan-etl search 一

Look up by UCN:

$ unihan-etl search U+4E00

Look up by hex codepoint:

$ unihan-etl search 4E00

Get JSON output for LLM consumption:

$ unihan-etl search 一 --json

Filter to specific fields:

$ unihan-etl search 一 -f kDefinition kMandarin
Next
unihan-etl fields
Previous
unihan-etl download
Copyright © Copyright 2013-present cihai software foundation (Tony Narlock)
Made with Sphinx and @pradyunsg's Furo
On this page
  • unihan-etl search
    • Command
      • Usage
      • Examples
        • Output Format
        • Field Filtering
      • Positional Arguments
      • Options
    • Examples