Replace PluginTypeRepository and PluginRepository with KeyedCollection

Author: bartfeenstra

betty/plugin/__init__.py

@@ -8,8 +8,7 @@
 from __future__ import annotations
 
 from functools import update_wrapper
-from importlib import metadata
-from typing import TYPE_CHECKING, Any, Generic, Self, final
+from typing import TYPE_CHECKING, Generic, Self, final
 
 from typing_extensions import TypeVar, override
 
@@ -21,7 +20,7 @@
 
 if TYPE_CHECKING:
     import builtins
-    from collections.abc import Iterable, Iterator, Mapping
+    from collections.abc import Iterable
 
     from betty.locale.localizable import (
         CountableLocalizable,
@@ -171,34 +170,3 @@ def plugin(cls) -> _PluginDefinitionCoT:
         raise NotImplementedError(
             f"{fully_qualified_name(cls)} was not decorated with a {fully_qualified_name(PluginDefinition)} subclass."
         )
-
-
-_PluginT = TypeVar("_PluginT", bound=Plugin, default=Plugin)
-
-
-@final
-class PluginTypeRepository:
-    """
-    A repository of available plugin types.
-    """
-
-    def __init__(self):
-        self._plugin_types: Mapping[MachineName, type[PluginDefinition]] | None = None
-
-    def _get_plugin_types(self) -> Mapping[MachineName, type[PluginDefinition]]:
-        if self._plugin_types is None:
-            self._plugin_types = {
-                plugin.type().id: plugin
-                for entry_point in metadata.entry_points(group="betty.plugin")
-                if (plugin := entry_point.load())
-            }
-        return self._plugin_types
-
-    def __contains__(self, value: Any) -> bool:
-        return value in self._get_plugin_types()
-
-    def __getitem__(self, plugin_type_id: MachineName, /) -> type[PluginDefinition]:
-        return self._get_plugin_types()[plugin_type_id]
-
-    def __iter__(self) -> Iterator[type[PluginDefinition]]:
-        return iter(self._get_plugin_types().values())

betty/plugin/manager/__init__.py

@@ -13,8 +13,9 @@
 from betty.typing import threadsafe
 
 if TYPE_CHECKING:
+    from betty.collections import KeyedCollection
     from betty.machine_name import MachineName
-    from betty.plugin.repository import PluginRepository
+    from betty.plugin.resolve import ResolvableId
 
 _PluginDefinitionT = TypeVar(
     "_PluginDefinitionT", bound=PluginDefinition, default=PluginDefinition
@@ -30,7 +31,9 @@ class PluginManager(ABC):
     @abstractmethod
     async def plugins(
         self, plugin_type: type[_PluginDefinitionT] | MachineName, /
-    ) -> PluginRepository[_PluginDefinitionT]:
+    ) -> KeyedCollection[
+        MachineName, ResolvableId[_PluginDefinitionT], _PluginDefinitionT
+    ]:
         """
         Get the available plugins for the given type.
         """

betty/plugin/manager/service.py

@@ -18,8 +18,10 @@
 if TYPE_CHECKING:
     from collections.abc import MutableMapping
 
+    from betty.collections import KeyedCollection
     from betty.machine_name import MachineName
     from betty.plugin.repository import PluginRepository
+    from betty.plugin.resolve import ResolvableId
     from betty.service.level import ServiceLevel
 
 
@@ -51,7 +53,9 @@ def types(self) -> plugin.PluginTypeRepository:
     @override
     async def plugins(
         self, plugin_type: type[_PluginDefinitionT] | MachineName, /
-    ) -> PluginRepository[_PluginDefinitionT]:
+    ) -> KeyedCollection[
+        MachineName, ResolvableId[_PluginDefinitionT], _PluginDefinitionT
+    ]:
         if isinstance(plugin_type, str):
             plugin_type = cast(type[_PluginDefinitionT], self.types[plugin_type])
         repository: PluginRepository[_PluginDefinitionT] | None

betty/plugin/repository/__init__.py

@@ -4,53 +4,22 @@
 
 from __future__ import annotations
 
-from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Generic
+from abc import ABC
+from typing import Generic
 
 from typing_extensions import TypeVar
 
 from betty.plugin import PluginDefinition
 
-if TYPE_CHECKING:
-    import builtins
-    from collections.abc import Iterator
-
-    from betty.machine_name import MachineName
-
 _PluginDefinitionT = TypeVar(
     "_PluginDefinitionT", bound=PluginDefinition, default=PluginDefinition
 )
 
 
+# @todo Remove this
+# @todo
+# @todo
 class PluginRepository(ABC, Generic[_PluginDefinitionT]):
     """
     Access discovered plugins.
     """
-
-    def __init__(self, plugin_type: builtins.type[_PluginDefinitionT]):
-        self._type = plugin_type
-
-    @property
-    def type(self) -> builtins.type[_PluginDefinitionT]:
-        """
-        The plugin type contained by this repository.
-        """
-        return self._type
-
-    @abstractmethod
-    def get(self, plugin_id: MachineName, /) -> _PluginDefinitionT:
-        """
-        Get a single plugin by its ID.
-
-        :raises PluginUnavailable: if no plugin can be found for the given ID.
-        """
-
-    def __len__(self) -> int:
-        return len(list(self.__iter__()))
-
-    @abstractmethod
-    def __iter__(self) -> Iterator[_PluginDefinitionT]:
-        pass
-
-    def __getitem__(self, plugin_id: MachineName) -> _PluginDefinitionT:
-        return self.get(plugin_id)

betty/tests/plugin/test___init__.py

@@ -1,12 +1,7 @@
 from __future__ import annotations
 
 from betty.locale.localize import DEFAULT_LOCALIZER
-from betty.model import EntityDefinition
-from betty.plugin import (
-    PluginDefinition,
-    PluginTypeDefinition,
-    PluginTypeRepository,
-)
+from betty.plugin import PluginDefinition, PluginTypeDefinition
 from betty.plugin.dependent import DependentPluginDefinition
 from betty.plugin.ordered import OrderedPluginDefinition
 from betty.service.level import universe
@@ -136,17 +131,3 @@ class _PluginDefinition(PluginDefinition[DummyPlugin]):
         actual = sut.reference_label_with_type.localize(DEFAULT_LOCALIZER)
         assert id in actual
         assert plugin_type_label in actual
-
-
-class TestPluginTypeRepository:
-    def test___contains__(self) -> None:
-        sut = PluginTypeRepository()
-        assert "entity" in sut
-
-    def test___getitem__(self) -> None:
-        sut = PluginTypeRepository()
-        assert sut["entity"].type().id == "entity"
-
-    def test___iter__(self) -> None:
-        sut = PluginTypeRepository()
-        assert EntityDefinition in list(iter(sut))