"""Configuration base classes."""
from abc import ABC, abstractmethod
from typing import Any, Iterator, Mapping, Optional, Type, TypeVar
from ..core.error import BaseError
InjectType = TypeVar("InjectType")
[docs]class ConfigError(BaseError):
"""A base exception for all configuration errors."""
[docs]class SettingsError(ConfigError):
"""The base exception raised by `BaseSettings` implementations."""
[docs]class BaseSettings(Mapping[str, Any]):
"""Base settings class."""
[docs] @abstractmethod
def get_value(self, *var_names, default: Optional[Any] = None) -> Any:
"""Fetch a setting.
Args:
var_names: A list of variable name alternatives
default: The default value to return if none are defined
Returns:
The setting value, if defined, otherwise the default value
"""
[docs] def get_bool(self, *var_names, default: Optional[bool] = None) -> Optional[bool]:
"""Fetch a setting as a boolean value.
Args:
var_names: A list of variable name alternatives
default: The default value to return if none are defined
"""
value = self.get_value(*var_names, default)
if value is not None:
value = bool(value and value not in ("false", "False", "0"))
return value
[docs] def get_int(self, *var_names, default: Optional[int] = None) -> Optional[int]:
"""Fetch a setting as an integer value.
Args:
var_names: A list of variable name alternatives
default: The default value to return if none are defined
"""
value = self.get_value(*var_names, default)
if value is not None:
value = int(value)
return value
[docs] def get_str(self, *var_names, default: Optional[str] = None) -> Optional[str]:
"""Fetch a setting as a string value.
Args:
var_names: A list of variable name alternatives
default: The default value to return if none are defined
"""
value = self.get_value(*var_names, default=default)
if value is not None:
value = str(value)
return value
@abstractmethod
def __iter__(self) -> Iterator:
"""Iterate settings keys."""
def __getitem__(self, index):
"""Fetch as an array index."""
if not isinstance(index, str):
raise TypeError(f"Index {index} must be a string")
missing = object()
result = self.get_value(index, default=missing)
if result is missing:
raise KeyError("Undefined index: {}".format(index))
return result
@abstractmethod
def __len__(self):
"""Fetch the length of the mapping."""
[docs] @abstractmethod
def copy(self) -> "BaseSettings":
"""Produce a copy of the settings instance."""
[docs] @abstractmethod
def extend(self, other: Mapping[str, Any]) -> "BaseSettings":
"""Merge another mapping to produce a new settings instance."""
[docs] @abstractmethod
def to_dict(self) -> dict:
"""Return a dict of the settings instance."""
def __repr__(self) -> str:
"""Provide a human readable representation of this object."""
items = ("{}={}".format(k, self[k]) for k in self)
return "<{}({})>".format(self.__class__.__name__, ", ".join(items))
[docs]class InjectionError(ConfigError):
"""The base exception raised by Injector and Provider implementations."""
[docs]class BaseInjector(ABC):
"""Base injector class."""
[docs] @abstractmethod
def inject(
self,
base_cls: Type[InjectType],
settings: Optional[Mapping[str, Any]] = None,
) -> InjectType:
"""Get the provided instance of a given class identifier.
Args:
cls: The base class to retrieve an instance of
settings: An optional mapping providing configuration to the provider
Returns:
An instance of the base class, or None
"""
[docs] @abstractmethod
def inject_or(
self,
base_cls: Type[InjectType],
settings: Optional[Mapping[str, Any]] = None,
default: Optional[InjectType] = None,
) -> Optional[InjectType]:
"""Get the provided instance of a given class identifier or default if not found.
Args:
base_cls: The base class to retrieve an instance of
settings: An optional dict providing configuration to the provider
default: default return value if no instance is found
Returns:
An instance of the base class, or None
"""
[docs] @abstractmethod
def copy(self) -> "BaseInjector":
"""Produce a copy of the injector instance."""
[docs]class BaseProvider(ABC):
"""Base provider class."""
[docs] def provide(self, settings: BaseSettings, injector: BaseInjector) -> Any:
"""Provide the object instance given a config and injector."""