Typings - cihai.types

Typings for cihai.

This is meant to be imported from inside typing.TYPE_CHECKING so it does not require typing_extensions at runtime:

>>> from typing import TYPE_CHECKING
>>> if TYPE_CHECKING:
...     from .types import DirsConfigDict
>>> def my_fn(dir_config: "DirsConfigDict") -> None:
...     pass
class cihai.types.RawPluginConfigDict
class[source]
class[source]
class cihai.types.RawPluginConfigDict

Bases: TypedDict

Barebones plugin config dictionary.

class cihai.types.RawDirsConfigDict
class[source]
class[source]
class cihai.types.RawDirsConfigDict

Bases: TypedDict

Raw directory config dictionary.

cache: str | pathlib.Path
attribute
attribute
cache: str | pathlib.Path
log: str | pathlib.Path
attribute
attribute
log: str | pathlib.Path
data: str | pathlib.Path
attribute
attribute
data: str | pathlib.Path
class cihai.types.DirsConfigDict
class[source]
class[source]
class cihai.types.DirsConfigDict

Bases: TypedDict

Directory config dictionary.

cache: pathlib.Path
attribute
attribute
cache: pathlib.Path
log: pathlib.Path
attribute
attribute
log: pathlib.Path
data: pathlib.Path
attribute
attribute
data: pathlib.Path
class cihai.types.RawDatabaseConfigDict
class[source]
class[source]
class cihai.types.RawDatabaseConfigDict

Bases: TypedDict

Raw database config dictionary.

url: str
attribute
attribute
url: str
class cihai.types.RawConfigDict
class[source]
class[source]
class cihai.types.RawConfigDict

Bases: TypedDict

Raw, unresolved configuration dictionary.

plugins: NotRequired[dict[str, RawPluginConfigDict]]
attribute
attribute
plugins: NotRequired[dict[str, RawPluginConfigDict]]
datasets: dict[str, str | Dataset]
attribute
attribute
datasets: dict[str, str | Dataset]
database: RawDatabaseConfigDict
attribute
attribute
database: RawDatabaseConfigDict
dirs: RawDirsConfigDict
attribute
attribute
dirs: RawDirsConfigDict
debug: bool
attribute
attribute
debug: bool
class cihai.types.ConfigDict
class[source]
class[source]
class cihai.types.ConfigDict

Bases: TypedDict

Cihai Configuration dictionary.

plugins: dict[str, RawPluginConfigDict]
attribute
attribute
plugins: dict[str, RawPluginConfigDict]
datasets: dict[str, str | Dataset]
attribute
attribute
datasets: dict[str, str | Dataset]
database: RawDatabaseConfigDict
attribute
attribute
database: RawDatabaseConfigDict
dirs: RawDirsConfigDict
attribute
attribute
dirs: RawDirsConfigDict
debug: bool
attribute
attribute
debug: bool