Typings - unihan_etl.types

Typings for unihan-etl.

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

data

os.PathLike or str

StrPath is based on typeshed’s.

unihan_etl.types.ColumnData

data

Sequence of UNIHAN field name strings.

alias of Sequence[str]

unihan_etl.types.UntypedNormalizedData

data

Normalized UNIHAN data as a sequence of field-value mappings.

alias of Sequence[Mapping[str, Any]]

unihan_etl.types.ExpandedExport

data

Expanded UNIHAN export with multi-value delimiters resolved.

alias of Sequence[Mapping[str, Any]]

class unihan_etl.types.Options

class

Bases: object

unihan-etl options.

source: str

attribute

destination: pathlib.Path

attribute

zip_path: pathlib.Path

attribute

work_dir: pathlib.Path

attribute

fields: tuple[str, ...]

attribute

format: UnihanFormats

attribute

input_files: list[str]

attribute

download: bool

attribute

expand: bool

attribute

prune_empty: bool

attribute

cache: bool

attribute

log_level: LogLevel

attribute

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

method

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

Bases: Protocol

Progress bar callback for download().

__init__(*args, **kwargs)

method

_abc_impl = <_abc._abc_data object>

attribute

_is_protocol = True

attribute

class unihan_etl.types.UrlRetrieveFn

class

Bases: Protocol

Type annotation for urllib.request.urlretrieve().

__init__(*args, **kwargs)

method

_abc_impl = <_abc._abc_data object>

attribute

_is_protocol = True

attribute