big_corporation_inc.id_translation.config

Configuration constants.

Module Attributes

IdType	The kind of IDs we wish to translate.
NameType	Type of names we wish to translate, such as a pandas.Dataframe column name.
SourceType	Name types for sources, such as SQL table names.
TRANSLATOR_TYPE	The Translator implementation to use.
MAIN_CONFIGURATION_PATH	Contains all configuration which is not specific to a single fetcher.
FETCHING_CONFIGURATION_PATHS	Contains configuration for sources, typically databases.
BASE_CACHE_DIR	Root location for cached data and persistent instances.
TRANSLATOR_CACHE_DIR	Location where the persistent Translator instance is stored.

Classes

NameType	Type of names we wish to translate, such as a pandas.Dataframe column name.
SourceType	Name types for sources, such as SQL table names.

IdType = int | str | uuid.UUID

The kind of IDs we wish to translate.

NameType

Type of names we wish to translate, such as a pandas.Dataframe column name.

SourceType

Name types for sources, such as SQL table names.

TRANSLATOR_TYPE

The Translator implementation to use.

alias of Translator[str, str, int | str | UUID]

MAIN_CONFIGURATION_PATH = PosixPath('/home/runner/work/id-translation-project/id-translation-project/demo/bci-id-translation/src/big_corporation_inc/id_translation/config/main.toml')

Contains all configuration which is not specific to a single fetcher.

FETCHING_CONFIGURATION_PATHS = [PosixPath('/home/runner/work/id-translation-project/id-translation-project/demo/bci-id-translation/src/big_corporation_inc/id_translation/config/fetching/dvd-rental-store.toml'), PosixPath('/home/runner/work/id-translation-project/id-translation-project/demo/bci-id-translation/src/big_corporation_inc/id_translation/config/fetching/geography.toml')]

Contains configuration for sources, typically databases.

BASE_CACHE_DIR = PosixPath('/home/runner/.big_corporation_inc/id-translation')

Root location for cached data and persistent instances.

Default location is ~/.big_corporation_inc/id-translation/.

Combining Translator and Fetcher caching has its use cases, but should be done with care as calls to id_translation.Translator.go_offline() does NOT invalidate the individual Fetcher caches.

TRANSLATOR_CACHE_DIR = PosixPath('/home/runner/.big_corporation_inc/id-translation/translator')

Location where the persistent Translator instance is stored.