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[source]

Bases: TypedDict

Barebones plugin config dictionary.

class cihai.types.RawDirsConfigDict[source]

Bases: TypedDict

Raw directory config dictionary.

cache: Union[str, Path]
log: Union[str, Path]
data: Union[str, Path]
class cihai.types.DirsConfigDict[source]

Bases: TypedDict

Directory config dictionary.

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

Bases: TypedDict

Raw database config dictionary.

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

Bases: TypedDict

Raw, unresolved configuration dictionary.

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

Bases: TypedDict

Cihai Configuration dictionary.

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