Source code for betty.config.collections

"""
Define and provide collections of :py:class:`betty.config.Configuration` instances.
"""

from __future__ import annotations

from abc import abstractmethod
from reprlib import recursive_repr
from typing import (
    Generic,
    MutableSequence,
    MutableMapping,
    Iterable,
    Iterator,
    Any,
    TypeAlias,
    TypeVar,
    SupportsIndex,
    Hashable,
    TYPE_CHECKING,
)

from typing_extensions import override

from betty.config import Configuration
from betty.repr import repr_instance

if TYPE_CHECKING:
    from betty.serde.dump import Dump


_ConfigurationT = TypeVar("_ConfigurationT", bound=Configuration)
ConfigurationKey: TypeAlias = SupportsIndex | Hashable | type[Any]
_ConfigurationKeyT = TypeVar("_ConfigurationKeyT", bound=ConfigurationKey)


[docs] class ConfigurationCollection( Configuration, Generic[_ConfigurationKeyT, _ConfigurationT] ): """ Any collection of :py:class:`betty.config.Configuration` values. To test your own subclasses, use :py:class:`betty.test_utils.config.collections.ConfigurationCollectionTestBase`. """ _configurations: ( MutableSequence[_ConfigurationT] | MutableMapping[_ConfigurationKeyT, _ConfigurationT] )
[docs] def __init__( self, configurations: Iterable[_ConfigurationT] | None = None, ): super().__init__() if configurations is not None: self.append(*configurations)
@abstractmethod def __iter__(self) -> Iterator[_ConfigurationKeyT] | Iterator[_ConfigurationT]: pass @abstractmethod def __getitem__(self, configuration_key: _ConfigurationKeyT) -> _ConfigurationT: pass def __delitem__(self, configuration_key: _ConfigurationKeyT) -> None: self.remove(configuration_key) def __len__(self) -> int: return len(self._configurations) @override # type: ignore[callable-functiontype] @recursive_repr() def __repr__(self) -> str: return repr_instance(self, configurations=list(self.values()))
[docs] @abstractmethod def replace(self, *configurations: _ConfigurationT) -> None: """ Replace any existing values with the given ones. """ pass
[docs] def remove(self, *configuration_keys: _ConfigurationKeyT) -> None: """ Remove the given keys from the collection. """ for configuration_key in configuration_keys: try: configuration = self._configurations[configuration_key] # type: ignore[call-overload] except LookupError: continue else: del self._configurations[configuration_key] # type: ignore[call-overload] self._post_remove(configuration)
[docs] def clear(self) -> None: """ Clear all items from the collection. """ self.remove(*self.keys())
def _pre_add(self, configuration: _ConfigurationT) -> None: pass def _post_remove(self, configuration: _ConfigurationT) -> None: pass @abstractmethod def _load_item(self, dump: Dump) -> _ConfigurationT: """ Create and load a new item from the given dump, or raise an assertion error. :raise betty.assertion.error.AssertionFailed: Raised when the dump is invalid and cannot be loaded. """ pass
[docs] @abstractmethod def keys(self) -> Iterator[_ConfigurationKeyT]: """ Get all keys in this collection. """ pass
[docs] @abstractmethod def values(self) -> Iterator[_ConfigurationT]: """ Get all values in this collection. """ pass
[docs] @abstractmethod def prepend(self, *configurations: _ConfigurationT) -> None: """ Prepend the given values to the beginning of the sequence. """ pass
[docs] @abstractmethod def append(self, *configurations: _ConfigurationT) -> None: """ Append the given values to the end of the sequence. """ pass
[docs] @abstractmethod def insert(self, index: int, *configurations: _ConfigurationT) -> None: """ Insert the given values at the given index. """ pass