UNIHAN - cihai.data.unihan

Bootstrapping

Fetch + extract + transform + load UNIHAN dataset to Cihai.

cihai.data.unihan.bootstrap.bootstrap_unihan(engine, metadata, options=None)

function

function

cihai.data.unihan.bootstrap.bootstrap_unihan(engine, metadata, options=None)

UNIHAN bootstrap script (download from web, import to database).

Parameters:

• engine (Engine)

• metadata (MetaData)

• options (dict[str, object] | Options | None)

Return type:

None

cihai.data.unihan.bootstrap.is_bootstrapped(metadata)

function

function

cihai.data.unihan.bootstrap.is_bootstrapped(metadata)

Return True if cihai is correctly bootstrapped.

Parameters:

metadata (MetaData)

Return type:

bool

cihai.data.unihan.bootstrap.create_unihan_table(columns, metadata)

function

function

cihai.data.unihan.bootstrap.create_unihan_table(columns, metadata)

Create table and return sqlalchemy.sql.schema.Table.

Parameters:

• columns (list) – columns for table, e.g. ['kDefinition', 'kCantonese']

• metadata (sqlalchemy.schema.MetaData) – Instance of sqlalchemy metadata

Returns:

Newly created table with columns and index.

Return type:

sqlalchemy.schema.Table

class cihai.data.unihan.dataset.Unihan

class

class

class cihai.data.unihan.dataset.Unihan

Bases: Dataset, SQLAlchemyMixin

UNIHAN Dataset for cihai.

char: str

attribute

attribute

char: str

kDefinition: str

attribute

attribute

kDefinition: str

kTraditionhalVariant: str

attribute

attribute

kTraditionhalVariant: str

kSimplifiedVariant: str

attribute

attribute

kSimplifiedVariant: str

tagged_vars: Callable[[str], ParsedVars]

attribute

attribute

tagged_vars: Callable[[str], ParsedVars]

untagged_vars: Callable[[str], UntaggedVars]

attribute

attribute

untagged_vars: Callable[[str], UntaggedVars]

bootstrap(options=None)

method

method

bootstrap(options=None)

Fetch, extract, import UNIHAN to DB, and initialize DB mapping.

Parameters:

options (dict[str, object] | None)

Return type:

None

lookup_char(char)

method

method

lookup_char(char)

Return character information from datasets.

Parameters:

char (str) – character / string to lookup

Returns:

list of matches

Return type:

sqlalchemy.orm.query.Query

reverse_char(hints)

method

method

reverse_char(hints)

Return QuerySet of objects from SQLAlchemy of results.

Parameters:

hints (list of str) – strings to lookup

Returns:

reverse matches

Return type:

sqlalchemy.orm.query.Query

with_fields(fields)

method

method

with_fields(fields)

Return list of characters with information for certain fields.

Parameters:

*fields (list of str) – fields for which information should be available

Returns:

list of matches

Return type:

sqlalchemy.orm.query.Query

property is_bootstrapped: bool

property

property

property is_bootstrapped: bool

Return True if UNIHAN and database is set up.

Returns:

True if Unihan application fixture data installed.

Return type:

bool

add_plugin(_cls, namespace, bootstrap=True)

method

method

add_plugin(_cls, namespace, bootstrap=True)

Add plugin for Cihai dataset.

Parameters:

• _cls (DSP | str)

• namespace (str)

• bootstrap (bool)

Return type:

None

sql: Database

attribute

attribute

sql: Database

engine: Engine

attribute

attribute

engine: Engine

sqlalchemy.engine.Engine instance.

metadata: MetaData

attribute

attribute

metadata: MetaData

sqlalchemy.schema.MetaData instance.

session: Session

attribute

attribute

session: Session

sqlalchemy.orm.session.Session instance.

base: AutomapBase

attribute

attribute

base: AutomapBase

sqlalchemy.ext.automap.AutomapBase instance.

Constants for UNIHAN cihai dataset.

cihai.data.unihan.constants.UNIHAN_FIELDS: list[str] = <...truncated, 529 chars>

data

data

cihai.data.unihan.constants.UNIHAN_FIELDS: list[str] = <...truncated, 529 chars>

Mapping of field names from unihan-etl (UNIHAN database)

cihai.data.unihan.constants.UNIHAN_ETL_DEFAULT_OPTIONS = <...truncated, 761 chars>

data

data

cihai.data.unihan.constants.UNIHAN_ETL_DEFAULT_OPTIONS = <...truncated, 761 chars>

Default settings passed to unihan-etl

Variants plugin

class cihai.data.unihan.dataset.UnihanVariants

class

class

class cihai.data.unihan.dataset.UnihanVariants

Bases: DatasetPlugin, SQLAlchemyMixin

Support for CJK Variant lookups through UNIHAN dataset.

bootstrap()

method

method

bootstrap()

Map custom lookup for UNIHAN variants to Unihan SQLAlchemy table.

Return type:

None

sql: Database

attribute

attribute

sql: Database

engine: Engine

attribute

attribute

engine: Engine

sqlalchemy.engine.Engine instance.

metadata: MetaData

attribute

attribute

metadata: MetaData

sqlalchemy.schema.MetaData instance.

session: Session

attribute

attribute

session: Session

sqlalchemy.orm.session.Session instance.

base: AutomapBase

attribute

attribute

base: AutomapBase

sqlalchemy.ext.automap.AutomapBase instance.