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

Bases: TypedDict

Barebones plugin config dictionary.

class cihai.types.RawDirsConfigDict

class

Bases: TypedDict

Raw directory config dictionary.

cache: str | pathlib.Path

attribute

log: str | pathlib.Path

attribute

data: str | pathlib.Path

attribute

class cihai.types.DirsConfigDict

class

Bases: TypedDict

Directory config dictionary.

cache: pathlib.Path

attribute

log: pathlib.Path

attribute

data: pathlib.Path

attribute

class cihai.types.RawDatabaseConfigDict

class

Bases: TypedDict

Raw database config dictionary.

url: str

attribute

class cihai.types.RawConfigDict

class

Bases: TypedDict

Raw, unresolved configuration dictionary.

plugins: NotRequired[dict[str, RawPluginConfigDict]]

attribute

datasets: dict[str, str | Dataset]

attribute

database: RawDatabaseConfigDict

attribute

dirs: RawDirsConfigDict

attribute

debug: bool

attribute

class cihai.types.ConfigDict

class

Bases: TypedDict

Cihai Configuration dictionary.

plugins: dict[str, RawPluginConfigDict]

attribute

datasets: dict[str, str | Dataset]

attribute

database: RawDatabaseConfigDict

attribute

dirs: RawDirsConfigDict

attribute

debug: bool

attribute