API Reference

cihai’s public API for CJK character lookups and dataset management.

Warning

cihai is pre-1.0. APIs may change between minor versions. Pin to a range: cihai>=0.36,<0.37.

If you need an API stabilized please file an issue.

Core

Core application

cihai.core.Cihai application object. Bootstrap datasets and run lookups.

Core
Config

Configuration loading and expansion.

Config
Database

SQLAlchemy engine/session setup and helpers.

Database
Extend

Base classes for datasets and plugins.

Extending

Supporting Modules

Constants

Default paths and configuration values.

Constants
Conversion

CJK encoding conversion utilities.

Conversion
Exceptions

Exception hierarchy.

Exceptions
Log

Logging helpers.

Logging
Types

Public type aliases.

Typings
Utils

Import and general utility helpers.

Utilities