dlt.common.configuration.providers.provider

ConfigProvider Objects

class ConfigProvider(abc.ABC)

[view_source]

get_value

@abc.abstractmethod
def get_value(key: str, hint: Type[Any], pipeline_name: str, *sections:
              str) -> Tuple[Optional[Any], str]

[view_source]

Looks for a value under key in section(s) sections and tries to coerce the value to type hint. A pipeline context (top level section) will be added if pipeline_name was specified.

supports_secrets

@property
@abc.abstractmethod
def supports_secrets() -> bool

[view_source]

If true, provider is allowed to store secret. Configuration resolution fails if a secret value is discovered in a config provider that does not support secrets.

supports_sections

@property
@abc.abstractmethod
def supports_sections() -> bool

[view_source]

If true, config resolution will query this provider for all allowed section combinations otherwise values are queried only by field name.

name

@property
@abc.abstractmethod
def name() -> str

[view_source]

Human readable name of config provider

is_empty

@property
def is_empty() -> bool

[view_source]

Tells if config provider holds any values

is_writable

@property
def is_writable() -> bool

[view_source]

Tells if set_value may be used

locations

@property
def locations() -> Sequence[str]

[view_source]

Returns a list of locations where secrets are stored, human readable