Internal API

See also

cihai’s API

Internals

Warning

These APIs are purely internal not covered by versioning policies, they can and will break between versions. If you need an internal API stabilized please file an issue.

CLI functionality for cihai-cli.

cihai_cli.cli.HUMAN_UNIHAN_FIELDS = ['char', 'ucn', 'kDefinition', 'kCantonese', 'kHangul', 'kJapaneseOn', 'kKorean', 'kMandarin', 'kVietnamese', 'kTang', 'kTotalStrokes']

data

fields which are human friendly

cihai_cli.cli.build_description(intro, example_blocks)

function

Assemble help text with optional example sections.

Parameters:

• intro (str) – Introduction text to display at the top of the help.

• example_blocks (Sequence[tuple[str | None, Sequence[str]]]) – List of (heading, commands) tuples. If heading is None, displays as “examples:”, otherwise as “{heading} examples:”.

Returns:

Formatted help text with examples.

Return type:

str

cihai_cli.cli.create_parser()

function

Create argparse for cihai-cli.

Return type:

ArgumentParser

class cihai_cli.cli.CLILoadNamespace

class

Bases: Namespace

Typing for CLI namespace.

config_file: str | None

attribute

version: bool

attribute

log_file: str | None

attribute

__annotations__ = {'config_file': 'str | None', 'log_file': 'str | None', 'version': 'bool'}

attribute

__firstlineno__ = 183

attribute

__module__ = 'cihai_cli.cli'

attribute

__static_attributes__ = ()

attribute

cihai_cli.cli.cli(_args=None)

function

Retrieve CJK information via CLI.

For help and example usage, see documentation:

https://cihai-cli.git-pull.com and https://cihai.git-pull.com

Parameters:

_args (list[str] | None)

Return type:

None

cihai_cli.cli.create_info_subparser(parser)

function

Create cihai info subparser.

Parameters:

parser (ArgumentParser)

Return type:

ArgumentParser

cihai_cli.cli.command_info(c, char, show_all)

function

Look up a definition by term.

Parameters:

• c (Cihai)

• char (str)

• show_all (bool)

Return type:

None

cihai_cli.cli.create_reverse_subparser(parser)

function

Create cihai reverse subparser.

Parameters:

parser (ArgumentParser)

Return type:

ArgumentParser

cihai_cli.cli.command_reverse(c, char, show_all)

function

Lookup a word or phrase by searching definitions.

Parameters:

• c (Cihai)

• char (str)

• show_all (bool)

Return type:

None

cihai_cli.cli.setup_logger(logger=None, level='INFO')

function

Configure logging for CLI use.

Parameters:

• logger (Logger) – Instance of logger, if one set up.

• level (str)

Return type:

None