Typings - `unihan_etl.types`¶

Typings for unihan-etl.

unihan_etl.types.StrPath: TypeAlias = str | ForwardRef('PathLike[str]') ¶ data data unihan_etl.types.StrPath: TypeAlias = str | ForwardRef('PathLike[str]') ¶: os.PathLike or str

StrPath is based on typeshed’s.

unihan_etl.types.ColumnData ¶ data data unihan_etl.types.ColumnData ¶: Sequence of UNIHAN field name strings.

alias of Sequence[str]

unihan_etl.types.UntypedNormalizedData ¶ data data unihan_etl.types.UntypedNormalizedData ¶: Normalized UNIHAN data as a sequence of field-value mappings.

alias of Sequence[Mapping[str, Any]]

unihan_etl.types.ExpandedExport ¶ data data unihan_etl.types.ExpandedExport ¶: Expanded UNIHAN export with multi-value delimiters resolved.

alias of Sequence[Mapping[str, Any]]

class unihan_etl.types.Options ¶ class[source] class[source] class unihan_etl.types.Options ¶

Bases: object

unihan-etl options.

__init__(source, destination, zip_path, work_dir, fields, format, input_files, download, expand, prune_empty, cache, log_level) ¶ method[source] method[source] __init__(source, destination, zip_path, work_dir, fields, format, input_files, download, expand, prune_empty, cache, log_level) ¶

Parameters:

source (str)
destination (Path)
zip_path (Path)
work_dir (Path)
fields (tuple[str, ...])
format (UnihanFormats)
input_files (list[str])
download (bool)
expand (bool)
prune_empty (bool)
cache (bool)
log_level (LogLevel)

Return type:

None

class unihan_etl.types.ReportHookFn ¶ class[source] class[source] class unihan_etl.types.ReportHookFn ¶

Bases: Protocol

Progress bar callback for download().

class unihan_etl.types.UrlRetrieveFn ¶ class[source] class[source] class unihan_etl.types.UrlRetrieveFn ¶

Bases: Protocol

Type annotation for urllib.request.urlretrieve().

Typings - unihan_etl.types¶

Typings - `unihan_etl.types`¶