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

Cihai (core)

Application object. Bootstrap datasets, run lookups.

Core - cihai.core
Config

Configuration loading and expansion.

Config - cihai.config
Database

SQLAlchemy engine/session setup and helpers.

Database - cihai.db
Extend

Base classes for datasets and plugins.

Extending - cihai.extend

Supporting Modules

Constants

Default paths and configuration values.

Constants - cihai.constants
Conversion

CJK encoding conversion utilities.

Conversion - cihai.conversion
Exceptions

Exception hierarchy.

Exceptions - cihai.exc
Log

Logging helpers.

Logging - cihai.log
Types

Public type aliases.

Typings - cihai.types
Utils

Import and general utility helpers.

Utilities - cihai.utils