Core

cihai.core.Cihai is the application object that owns configuration, database access, and datasets. Most code creates one instance, runs cihai.core.Cihai.bootstrap() when needed, then queries the attached datasets.

Cihai core functionality.

exception cihai.core.CihaiConfigError
exception[source]
exception[source]
exception cihai.core.CihaiConfigError

Bases: CihaiException

Cihai Configuration error.

__init__()
method[source]
method[source]
__init__()
Return type:

None

cihai.core.is_valid_config(config)
function[source]
function[source]
cihai.core.is_valid_config(config)

Upcast cihai configuration.

NOTE: This does not validate configuration yet!

Parameters:

config (dict[str, object])

Return type:

TypeGuard[ConfigDict]

class cihai.core.Cihai
class[source]
class[source]
class cihai.core.Cihai

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: dict[str, object] = <...truncated, 270 chars>
attribute
attribute
default_config: dict[str, object] = <...truncated, 270 chars>

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

unihan: Unihan
attribute
attribute
unihan: Unihan
__init__(config=None, unihan=True)
method[source]
method[source]
__init__(config=None, unihan=True)

Initialize Cihai application.

Parameters:

  • config (dict | None)

  • unihan (bool) – Bootstrap the core UNIHAN dataset (recommended)

Return type:

None

config: ConfigDict
attribute
attribute
config: ConfigDict
sql: Database
attribute
attribute
sql: Database

cihai.db.Database : Database instance

bootstrap()
method[source]
method[source]
bootstrap()

Initialize Cihai.

Return type:

None

add_dataset(cls, namespace)
method[source]
method[source]
add_dataset(cls, namespace)

Add dataset to Cihai.

Parameters:
Return type:

None

classmethod from_file(config_path, *args, **kwargs)
classmethod method[source]
classmethod method[source]
classmethod from_file(config_path, *args, **kwargs)

Create a Cihai instance from a JSON or YAML config.

Parameters:

  • config_path (str) – path to custom config file

  • args (object)

  • kwargs (object)

Returns:

application object

Return type:

Cihai