rats-apps 0.2.0.dev20240904170114__py3-none-any.whl → 0.3.0.dev20240928043035__py3-none-any.whl

rats/apps/__init__.py

@@ -7,7 +7,9 @@ domain.
 
 from ._annotations import (
     autoid,
+    autoid_factory_service,
     autoid_service,
+    factory_service,
     fallback_group,
     fallback_service,
     group,
@@ -63,4 +65,6 @@ __all__ = [
     "StandardRuntime",
     "StandardRuntime",
     "SimpleApplication",
+    "factory_service",
+    "autoid_factory_service",
 ]

rats/apps/_annotations.py

@@ -1,5 +1,5 @@
-from collections.abc import Callable
-from typing import Any, NamedTuple, ParamSpec, cast
+from collections.abc import Callable, Iterator
+from typing import Any, Concatenate, Generic, NamedTuple, ParamSpec, TypeVar, cast
 
 from rats import annotations
 
@@ -8,6 +8,8 @@ from ._namespaces import ProviderNamespaces
 from ._scoping import scope_service_name
 
 P = ParamSpec("P")
+R = TypeVar("R")
+T_Container = TypeVar("T_Container")
 
 
 def service(
@@ -24,7 +26,7 @@ def autoid_service(fn: Callable[P, T_ServiceType]) -> Callable[P, T_ServiceType]
 
 def group(
     group_id: ServiceId[T_ServiceType],
-) -> Callable[[Callable[P, T_ServiceType]], Callable[P, T_ServiceType]]:
+) -> Callable[[Callable[P, Iterator[T_ServiceType]]], Callable[P, Iterator[T_ServiceType]]]:
     """A group is a collection of services."""
     return annotations.annotation(ProviderNamespaces.GROUPS, cast(NamedTuple, group_id))
 
@@ -41,7 +43,7 @@ def fallback_service(
 
 def fallback_group(
     group_id: ServiceId[T_ServiceType],
-) -> Callable[[Callable[P, T_ServiceType]], Callable[P, T_ServiceType]]:
+) -> Callable[[Callable[P, Iterator[T_ServiceType]]], Callable[P, Iterator[T_ServiceType]]]:
     """A fallback group gets used if no group is defined."""
     return annotations.annotation(
         ProviderNamespaces.FALLBACK_GROUPS,
@@ -49,6 +51,61 @@ def fallback_group(
     )
 
 
+def _factory_to_factory_provider(
+    method: Callable[Concatenate[T_Container, P], R],
+) -> Callable[[T_Container], Callable[P, R]]:
+    """Convert a factory method a factory provider method returning the original method."""
+
+    def new_method(self: T_Container) -> Callable[P, R]:
+        def factory(*args: P.args, **kwargs: P.kwargs) -> R:
+            return method(self, *args, **kwargs)
+
+        return factory
+
+    new_method.__name__ = method.__name__
+    new_method.__module__ = method.__module__
+    new_method.__qualname__ = method.__qualname__
+    new_method.__doc__ = method.__doc__
+    return new_method
+
+
+class _FactoryService(Generic[P, R]):
+    """
+    A decorator to create a factory service.
+
+    Decorate a method that takes any number of arguments and returns an object.  The resulting
+    service will be that factory - taking the same arguments and returning a new object each time.
+    """
+
+    _service_id: ServiceId[Callable[P, R]]
+
+    def __init__(self, service_id: ServiceId[Callable[P, R]]) -> None:
+        self._service_id = service_id
+
+    def __call__(
+        self, method: Callable[Concatenate[T_Container, P], R]
+    ) -> Callable[[T_Container], Callable[P, R]]:
+        new_method = _factory_to_factory_provider(method)
+        return service(self._service_id)(new_method)
+
+
+# alias so we can think of it as a function
+factory_service = _FactoryService
+
+
+def autoid_factory_service(
+    method: Callable[Concatenate[T_Container, P], R],
+) -> Callable[[T_Container], Callable[P, R]]:
+    """
+    A decorator to create a factory service, with an automatically generated service id.
+
+    Decorate a method that takes any number of arguments and returns an object.  The resulting
+    service will be that factory - taking the same arguments and returning a new object each time.
+    """
+    new_method = _factory_to_factory_provider(method)
+    return autoid_service(new_method)
+
+
 def autoid(method: Callable[..., T_ServiceType]) -> ServiceId[T_ServiceType]:
     """
     Get a service id for a method.

rats/apps/_container.py

@@ -1,7 +1,9 @@
 import logging
 from abc import abstractmethod
 from collections.abc import Callable, Iterator
-from typing import Generic, NamedTuple, ParamSpec, Protocol, cast
+from typing import Any, Generic, NamedTuple, ParamSpec, Protocol, cast
+
+from typing_extensions import NamedTuple as ExtNamedTuple
 
 from rats import annotations
 
@@ -109,9 +111,13 @@ class Container(Protocol):
     ) -> Iterator[T_ServiceType]:
         """Retrieve a service group by its id."""
         if not self.has_namespace(ProviderNamespaces.GROUPS, group_id):
-            yield from self.get_namespaced_group(ProviderNamespaces.FALLBACK_GROUPS, group_id)
+            # groups are expected to return iterable services
+            # TODO: we need to clean up the meaning of groups and services somehow
+            for i in self.get_namespaced_group(ProviderNamespaces.FALLBACK_GROUPS, group_id):
+                yield from cast(Iterator[T_ServiceType], i)
 
-        yield from self.get_namespaced_group(ProviderNamespaces.GROUPS, group_id)
+        for i in self.get_namespaced_group(ProviderNamespaces.GROUPS, group_id):
+            yield from cast(Iterator[T_ServiceType], i)
 
     def get_namespaced_group(
         self,
@@ -119,31 +125,67 @@ class Container(Protocol):
         group_id: ServiceId[T_ServiceType],
     ) -> Iterator[T_ServiceType]:
         """Retrieve a service group by its id, within a given service namespace."""
-        tates = annotations.get_class_annotations(type(self))
-        # containers are a special service namespace that we look through recursively
-        containers = tates.with_namespace(ProviderNamespaces.CONTAINERS)
-        groups = tates.with_group(namespace, cast(NamedTuple, group_id))
-
-        for annotation in groups.annotations:
-            if not hasattr(self, f"__rats_cache_{annotation.name}_{group_id.name}"):
-                setattr(
-                    self,
-                    f"__rats_cache_{annotation.name}_{group_id.name}",
-                    getattr(self, annotation.name)(),
-                )
-
-            yield getattr(self, f"__rats_cache_{annotation.name}_{group_id.name}")
-
-        for annotation in containers.annotations:
-            if not hasattr(self, f"__rats_container_cache_{annotation.name}"):
-                setattr(
-                    self,
-                    f"__rats_container_cache_{annotation.name}",
-                    getattr(self, annotation.name)(),
-                )
-
-            c: Container = getattr(self, f"__rats_container_cache_{annotation.name}")
-            yield from c.get_namespaced_group(namespace, group_id)
+        yield from _get_cached_services_for_group(self, namespace, group_id)
+
+        for subcontainer in _get_subcontainers(self):
+            yield from subcontainer.get_namespaced_group(namespace, group_id)
+
+
+def _get_subcontainers(c: Container) -> Iterator[Container]:
+    yield from _get_cached_services_for_group(
+        c, ProviderNamespaces.CONTAINERS, DEFAULT_CONTAINER_GROUP
+    )
+
+
+class _ProviderInfo(ExtNamedTuple, Generic[T_ServiceType]):
+    attr: str
+    group_id: ServiceId[T_ServiceType]
+
+
+def _get_cached_services_for_group(
+    c: Container,
+    namespace: str,
+    group_id: ServiceId[T_ServiceType],
+) -> Iterator[T_ServiceType]:
+    provider_cache = _get_provider_cache(c)
+    info_cache = _get_provider_info_cache(c)
+
+    if (namespace, group_id) not in info_cache:
+        info_cache[(namespace, group_id)] = list(_get_providers_for_group(c, namespace, group_id))
+
+    for provider in info_cache[(namespace, group_id)]:
+        if provider not in provider_cache:
+            provider_cache[provider] = getattr(c, provider.attr)()
+
+        yield provider_cache[provider]
+
+
+def _get_provider_cache(obj: object) -> dict[_ProviderInfo[Any], Any]:
+    if not hasattr(obj, "__rats_apps_provider_cache__"):
+        obj.__rats_apps_provider_cache__ = {}  # type: ignore[reportAttributeAccessIssue]
+
+    return obj.__rats_apps_provider_cache__  # type: ignore[reportAttributeAccessIssue]
+
+
+def _get_provider_info_cache(
+    obj: object,
+) -> dict[tuple[str, ServiceId[Any]], list[_ProviderInfo[Any]]]:
+    if not hasattr(obj, "__rats_apps_provider_info_cache__"):
+        obj.__rats_apps_provider_info_cache__ = {}  # type: ignore[reportAttributeAccessIssue]
+
+    return obj.__rats_apps_provider_info_cache__  # type: ignore[reportAttributeAccessIssue]
+
+
+def _get_providers_for_group(
+    c: Container,
+    namespace: str,
+    group_id: ServiceId[T_ServiceType],
+) -> Iterator[_ProviderInfo[T_ServiceType]]:
+    tates = annotations.get_class_annotations(type(c))
+    groups = tates.with_group(namespace, cast(NamedTuple, group_id))
+
+    for annotation in groups.annotations:
+        yield _ProviderInfo(annotation.name, group_id)
 
 
 DEFAULT_CONTAINER_GROUP = ServiceId[Container](f"{__name__}:__default__")

rats/logs/_plugin.py

@@ -1,4 +1,5 @@
 import logging.config
+from collections.abc import Iterator
 
 from rats import apps
 
@@ -22,9 +23,9 @@ class PluginContainer(apps.Container):
         self._app = app
 
     @apps.group(PluginServices.EVENTS.CONFIGURE_LOGGING)
-    def _configure_logging(self) -> apps.Executable:
+    def _configure_logging(self) -> Iterator[apps.Executable]:
         # in the future, we can use this plugin to make logging easily configurable
-        return apps.App(
+        yield apps.App(
             lambda: logging.config.dictConfig(
                 {
                     "version": 1,

{rats_apps-0.2.0.dev20240904170114.dist-info → rats_apps-0.3.0.dev20240928043035.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rats-apps
-Version: 0.2.0.dev20240904170114
+Version: 0.3.0.dev20240928043035
 Summary: research analysis tools for building applications
 Home-page: https://github.com/microsoft/rats/
 License: MIT

{rats_apps-0.2.0.dev20240904170114.dist-info → rats_apps-0.3.0.dev20240928043035.dist-info}/RECORD

@@ -2,11 +2,11 @@ rats/annotations/__init__.py,sha256=wsGhRQzZrV2oJTnBAX0aGgpyT1kYT235jkP3Wb8BTRY,
 rats/annotations/__main__.py,sha256=vlzQOM9y82P0OL5tYcmSM_4jTg0s8jayAcvEoi9cBvI,1065
 rats/annotations/_functions.py,sha256=UkHh3zdBivluE7dBeGQ17zoIfGdyIokMAkFmpWaIlDc,4284
 rats/annotations/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rats/apps/__init__.py,sha256=KtAsBY62BS5lYom6j5x69BDItfEYeOxu5EY0kbRWC0g,1601
+rats/apps/__init__.py,sha256=SlqFKChSf661J6nlcuSGNQO-fLceqZrwOGn1YoyYDzs,1703
 rats/apps/__main__.py,sha256=KjdadN4rdP0xhWiLzdmtCsXejWx_gxOK-ah-L1r1dTI,1818
-rats/apps/_annotations.py,sha256=yOf4MKFGQz3x4hpaWgMf2y2GlbXtbIh4uED15voXzyY,2566
+rats/apps/_annotations.py,sha256=6M_M7K8haNVda0Tx02EpFf3s9EjnWYacNMjTIkNEdRU,4617
 rats/apps/_composite_container.py,sha256=s_of6NyyrjFVYWGVehyEHe9WJIPRCnbB-tyWyNF8zyc,585
-rats/apps/_container.py,sha256=rLUPnsDfLR26YjFUGGu3YYpqIta1l0q8p077Hzfflwo,5989
+rats/apps/_container.py,sha256=Gb7jJmGyKGDZFjoe0s0C_gC7ymSpXaqordfQaJZGJf4,7283
 rats/apps/_executables.py,sha256=QJ5_UPdZPmDQ1a3cLRJDUoeUMzNMwa3ZHYhYeS3AVq4,971
 rats/apps/_ids.py,sha256=T8Onrj79t8NPfBMQBk0xI6fIWDKF0m2JfFNrdtXAbWg,353
 rats/apps/_namespaces.py,sha256=THUV_Xj5PtweC23Ob-zsSpk8exC4fT-qRwjpQ6IDm0U,188
@@ -25,9 +25,9 @@ rats/cli/_container.py,sha256=VddjrsH1lqiarJ6rXf4KUbuNtNXEduCr38UH_TwGgFE,1872
 rats/cli/_plugin.py,sha256=o5emP-E0LLOGvD14ZBYNY6h407pngrJf8ODMB5Wdd8U,711
 rats/cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rats/logs/__init__.py,sha256=fCn4pfpYiAcTtt5CsnUZX68CjOB3KJHxMSiYxsma4qE,183
-rats/logs/_plugin.py,sha256=eAAG4ci-XS9A9ituXj9PrcI6zH-xlCqhJlUbSGC-MYM,2175
+rats/logs/_plugin.py,sha256=OQ5fXToBm60YJRrMUVJ9_HVytUs3c69vaHY57jpivb0,2221
 rats/logs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rats_apps-0.2.0.dev20240904170114.dist-info/METADATA,sha256=MbekP29Jvud3udbD7O3YU986gUyhy7d61wtIsx9KlIM,774
-rats_apps-0.2.0.dev20240904170114.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-rats_apps-0.2.0.dev20240904170114.dist-info/entry_points.txt,sha256=9oOvf2loQr5ACWQgvuu9Q3KZIVIxKE5Aa-rLuUII5WQ,91
-rats_apps-0.2.0.dev20240904170114.dist-info/RECORD,,
+rats_apps-0.3.0.dev20240928043035.dist-info/METADATA,sha256=k0UESmQA1tr66nQVFUMKtsfhQicSC75kzJS6hFTcyBQ,774
+rats_apps-0.3.0.dev20240928043035.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+rats_apps-0.3.0.dev20240928043035.dist-info/entry_points.txt,sha256=9oOvf2loQr5ACWQgvuu9Q3KZIVIxKE5Aa-rLuUII5WQ,91
+rats_apps-0.3.0.dev20240928043035.dist-info/RECORD,,