Core - cihai.core

Cihai core functionality.

exception cihai.core.CihaiConfigError

exception

Bases: CihaiException

Cihai Configuration error.

__init__()

method

Return type:

None

cihai.core.is_valid_config(config)

function

Upcast cihai configuration.

NOTE: This does not validate configuration yet!

Parameters:

config (UntypedDict)

Return type:

TypeGuard[ConfigDict]

class cihai.core.Cihai

class

Bases: object

Central application object.

By default, this automatically adds the UNIHAN dataset.

Notes

Inspired by the early pypa/warehouse application object.

Configuration templates

The config dict parameter supports a basic template system for replacing XDG Base Directory directory variables, tildes and environmentas variables. This is done by passing the option dict through cihai.config.expand_config() during initialization.

Examples

To use cihai programmatically, invoke and install the UNIHAN dataset — see Examples for a runnable walkthrough based on examples/basic_usage.py.

is_bootstrapped can check if the system has the database installed.

default_config: UntypedDict = {'database': {'url': 'sqlite:///{user_data_dir}/cihai.db'}, 'datasets': {}, 'debug': False, 'dirs': {'cache': PosixPath('/home/runner/.cache/cihai'), 'data': PosixPath('/home/runner/.local/share/cihai'), 'log': PosixPath('/home/runner/.cache/cihai/log')}, 'plugins': {}}

attribute

dict of default config, can be monkey-patched during tests

unihan: Unihan

attribute

__init__(config=None, unihan=True)

method

Initialize Cihai application.

Parameters:

• config (dict, optional)

• unihan (boolean, optional) – Bootstrap the core UNIHAN dataset (recommended)

Return type:

None

config: ConfigDict

attribute

sql: Database

attribute

cihai.db.Database : Database instance

bootstrap()

method

Initialize Cihai.

Return type:

None

add_dataset(cls, namespace)

method

Add dataset to Cihai.

Parameters:

• cls (DS | str)

• namespace (str)

Return type:

None

classmethod from_file(config_path, *args, **kwargs)

classmethod method

Create a Cihai instance from a JSON or YAML config.

Parameters:

• config_path (str, optional) – path to custom config file

• args (object)

• kwargs (object)

Returns:

application object

Return type:

Cihai