python-injection 0.9.0__tar.gz → 0.9.2__tar.gz

{python_injection-0.9.0 → python_injection-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-injection
-Version: 0.9.0
+Version: 0.9.2
 Summary: Fast and easy dependency injection framework.
 Home-page: https://github.com/100nm/python-injection
 License: MIT
@@ -15,7 +15,7 @@ Description-Content-Type: text/markdown
 
 # Basic usage
 
-## Create an injectable
+## Register an injectable
 
 > **Note**: If the class needs dependencies, these will be resolved when the instance is retrieved.
 

{python_injection-0.9.0 → python_injection-0.9.2}/documentation/basic-usage.md

@@ -1,6 +1,6 @@
 # Basic usage
 
-## Create an injectable
+## Register an injectable
 
 > **Note**: If the class needs dependencies, these will be resolved when the instance is retrieved.
 

python_injection-0.9.2/injection/__init__.py

@@ -0,0 +1,29 @@
+from .core import Injectable, Module
+from .core import Mode as InjectableMode
+from .core import Priority as ModulePriority
+
+__all__ = (
+    "Injectable",
+    "InjectableMode",
+    "Module",
+    "ModulePriority",
+    "get_instance",
+    "get_lazy_instance",
+    "inject",
+    "injectable",
+    "set_constant",
+    "should_be_injectable",
+    "singleton",
+)
+
+_module = Module.default()
+
+get_instance = _module.get_instance
+get_lazy_instance = _module.get_lazy_instance
+inject = _module.inject
+injectable = _module.injectable
+set_constant = _module.set_constant
+should_be_injectable = _module.should_be_injectable
+singleton = _module.singleton
+
+del _module

{python_injection-0.9.0 → python_injection-0.9.2}/injection/__init__.pyi

@@ -6,7 +6,6 @@ from types import UnionType
 from typing import (
     Any,
     ContextManager,
-    Final,
     Protocol,
     Self,
     final,
@@ -19,15 +18,17 @@ from .core import InjectableFactory
 from .core import ModeStr as InjectableModeStr
 from .core import PriorityStr as ModulePriorityStr
 
-default_module: Final[Module] = ...
+_module: Module = ...
 
-get_instance = default_module.get_instance
-get_lazy_instance = default_module.get_lazy_instance
-inject = default_module.inject
-injectable = default_module.injectable
-set_constant = default_module.set_constant
-should_be_injectable = default_module.should_be_injectable
-singleton = default_module.singleton
+get_instance = _module.get_instance
+get_lazy_instance = _module.get_lazy_instance
+inject = _module.inject
+injectable = _module.injectable
+set_constant = _module.set_constant
+should_be_injectable = _module.should_be_injectable
+singleton = _module.singleton
+
+del _module
 
 @final
 class Module:
@@ -178,6 +179,18 @@ class Module:
         Function to unlock the module by deleting cached instances of singletons.
         """
 
+    @classmethod
+    def from_name(cls, name: str) -> Self:
+        """
+        Class method for getting or creating a module by name.
+        """
+
+    @classmethod
+    def default(cls) -> Self:
+        """
+        Class method for getting the default module.
+        """
+
 @final
 class ModulePriority(StrEnum):
     LOW = ...

{python_injection-0.9.0 → python_injection-0.9.2}/injection/common/invertible.py

@@ -15,7 +15,7 @@ class Invertible[T](Protocol):
 
 @dataclass(repr=False, eq=False, frozen=True, slots=True)
 class SimpleInvertible[T](Invertible[T]):
-    callable: Callable[[], T]
+    callable: Callable[..., T]
 
     def __invert__(self) -> T:
         return self.callable()

{python_injection-0.9.0 → python_injection-0.9.2}/injection/common/lazy.py

@@ -9,7 +9,7 @@ __all__ = ("Lazy", "LazyMapping")
 class Lazy[T](Invertible[T]):
     __slots__ = ("__cache", "__is_set")
 
-    def __init__(self, factory: Callable[[], T]):
+    def __init__(self, factory: Callable[..., T]):
         self.__setup_cache(factory)
 
     def __invert__(self) -> T:
@@ -19,7 +19,7 @@ class Lazy[T](Invertible[T]):
     def is_set(self) -> bool:
         return self.__is_set
 
-    def __setup_cache(self, factory: Callable[[], T]):
+    def __setup_cache(self, factory: Callable[..., T]):
         def cache_generator() -> Iterator[T]:
             nonlocal factory
             cached = factory()

{python_injection-0.9.0 → python_injection-0.9.2}/injection/common/tools/threading.py

@@ -6,5 +6,7 @@ __all__ = ("synchronized",)
 
 @contextmanager
 def synchronized():
-    with RLock():
-        yield
+    lock = RLock()
+
+    with lock:
+        yield lock

{python_injection-0.9.0 → python_injection-0.9.2}/injection/common/tools/type.py

@@ -21,11 +21,13 @@ class TypeReport[T](NamedTuple):
     args: tuple[Any, ...]
 
     @property
-    def cls(self) -> type[T]:
-        if self.args:
-            return self.origin[*self.args]
+    def type(self) -> type[T]:
+        origin = self.origin
+
+        if args := self.args:
+            return origin[*args]
 
-        return self.origin
+        return origin
 
     @property
     def no_args(self) -> Self:

{python_injection-0.9.0 → python_injection-0.9.2}/injection/core/module.py

@@ -17,7 +17,7 @@ from dataclasses import dataclass, field
 from enum import StrEnum
 from functools import partialmethod, singledispatchmethod, update_wrapper
 from inspect import Signature, isclass
-from queue import Queue
+from queue import Empty, Queue
 from types import MethodType, UnionType
 from typing import (
     Any,
@@ -78,10 +78,10 @@ class ContainerDependenciesUpdated(ContainerEvent):
 
     def __str__(self) -> str:
         length = len(self.reports)
-        formatted_classes = ", ".join(f"`{report.cls}`" for report in self.reports)
+        formatted_types = ", ".join(f"`{report.type}`" for report in self.reports)
         return (
-            f"{length} container dependenc{'ies' if length > 1 else 'y'} have been "
-            f"updated{f': {formatted_classes}' if formatted_classes else ''}."
+            f"{length} container dependenc{'ies' if length > 1 else 'y'} have "
+            f"been updated{f': {formatted_types}' if formatted_types else ''}."
         )
 
 
@@ -161,7 +161,7 @@ class Injectable[T](Protocol):
 
 @dataclass(repr=False, frozen=True, slots=True)
 class BaseInjectable[T](Injectable[T], ABC):
-    factory: Callable[[], T]
+    factory: Callable[..., T]
 
 
 class NewInjectable[T](BaseInjectable[T]):
@@ -174,7 +174,7 @@ class NewInjectable[T](BaseInjectable[T]):
 class SingletonInjectable[T](BaseInjectable[T]):
     __slots__ = ("__dict__",)
 
-    __INSTANCE_KEY: ClassVar[str] = "$instance"
+    __key: ClassVar[str] = "$instance"
 
     @property
     def cache(self) -> MutableMapping[str, Any]:
@@ -182,18 +182,18 @@ class SingletonInjectable[T](BaseInjectable[T]):
 
     @property
     def is_locked(self) -> bool:
-        return self.__INSTANCE_KEY in self.cache
+        return self.__key in self.cache
 
     def unlock(self):
         self.cache.clear()
 
     def get_instance(self) -> T:
         with suppress(KeyError):
-            return self.cache[self.__INSTANCE_KEY]
+            return self.cache[self.__key]
 
         with synchronized():
             instance = self.factory()
-            self.cache[self.__INSTANCE_KEY] = instance
+            self.cache[self.__key] = instance
 
         return instance
 
@@ -340,7 +340,7 @@ class Container(Broker):
             else:
                 if mode == current_mode and mode != Mode.OVERRIDE:
                     raise RuntimeError(
-                        f"An injectable already exists for the class `{report.cls}`."
+                        f"An injectable already exists for the class `{report.type}`."
                     )
 
                 elif rank < current_mode.rank:
@@ -368,16 +368,27 @@ type PriorityStr = Literal["low", "high"]
 type InjectableFactory[T] = Callable[[Callable[..., T]], Injectable[T]]
 
 
-@dataclass(repr=False, eq=False, frozen=True, slots=True)
+@dataclass(eq=False, frozen=True, slots=True)
 class Module(EventListener, Broker):
     name: str | None = field(default=None)
-    __channel: EventChannel = field(default_factory=EventChannel, init=False)
-    __container: Container = field(default_factory=Container, init=False)
+    __channel: EventChannel = field(
+        default_factory=EventChannel,
+        init=False,
+        repr=False,
+    )
+    __container: Container = field(
+        default_factory=Container,
+        init=False,
+        repr=False,
+    )
     __modules: OrderedDict[Module, None] = field(
         default_factory=OrderedDict,
         init=False,
+        repr=False,
     )
 
+    __instances: ClassVar[dict[str, Module]] = {}
+
     def __post_init__(self):
         self.__container.add_listener(self)
 
@@ -394,9 +405,6 @@ class Module(EventListener, Broker):
     def __contains__(self, cls: type | UnionType, /) -> bool:
         return any(cls in broker for broker in self.__brokers)
 
-    def __str__(self) -> str:
-        return self.name or object.__str__(self)
-
     @property
     def is_locked(self) -> bool:
         return any(broker.is_locked for broker in self.__brokers)
@@ -611,6 +619,19 @@ class Module(EventListener, Broker):
                 f"`{module}` can't be found in the modules used by `{self}`."
             ) from exc
 
+    @classmethod
+    def from_name(cls, name: str) -> Self:
+        with suppress(KeyError):
+            return cls.__instances[name]
+
+        instance = cls(name)
+        cls.__instances[name] = instance
+        return instance
+
+    @classmethod
+    def default(cls) -> Self:
+        return cls.from_name("default")
+
 
 """
 InjectedFunction
@@ -641,7 +662,7 @@ class Dependencies:
 
     @classmethod
     def from_mapping(cls, mapping: Mapping[str, Injectable]) -> Self:
-        return cls(mapping=mapping)
+        return cls(mapping)
 
     @classmethod
     def empty(cls) -> Self:
@@ -702,10 +723,8 @@ class InjectedFunction(EventListener):
         update_wrapper(self, wrapped, updated=())
         self.__dependencies = Dependencies.empty()
         self.__owner = None
-
-        queue = Queue[Callable[[], Any]]()
-        queue.put_nowait(self.__set_signature)
-        self.__setup_queue = queue
+        self.__setup_queue = Queue[Callable[..., Any]](maxsize=2)
+        self.on_setup(self.__set_signature)
 
     def __repr__(self) -> str:  # pragma: no cover
         return repr(self.wrapped)
@@ -714,13 +733,7 @@ class InjectedFunction(EventListener):
         return str(self.wrapped)
 
     def __call__(self, /, *args, **kwargs) -> Any:
-        queue = self.__setup_queue
-
-        while not queue.empty():
-            setup = queue.get()
-            setup()
-            queue.task_done()
-
+        self.__setup()
         arguments = self.bind(args, kwargs)
         return self.wrapped(*arguments.args, **arguments.kwargs)
 
@@ -775,15 +788,15 @@ class InjectedFunction(EventListener):
         self.__dependencies = Dependencies.resolve(self.signature, module, self.__owner)
         return self
 
-    def on_setup(self, wrapped: Callable[[], Any] = None, /):
+    def on_setup(self, wrapped: Callable[..., Any] = None, /):
         def decorator(wp):
-            self.__setup_queue.put(wp)
+            self.__setup_queue.put_nowait(wp)
             return wp
 
         return decorator(wrapped) if wrapped else decorator
 
     @singledispatchmethod
-    def on_event(self, event: Event, /) -> None:  # type: ignore
+    def on_event(self, event: Event, /) -> ContextManager | None:  # type: ignore
         return None
 
     @on_event.register
@@ -792,6 +805,20 @@ class InjectedFunction(EventListener):
         yield
         self.update(event.on_module)
 
+    def __setup(self):
+        queue = self.__setup_queue
+
+        while True:
+            try:
+                task = queue.get_nowait()
+            except Empty:
+                break
+
+            task()
+            queue.task_done()
+
+        queue.join()
+
     def __set_signature(self) -> Self:
         self.__signature__ = inspect.signature(self.wrapped, eval_str=True)
         return self

{python_injection-0.9.0 → python_injection-0.9.2}/injection/integrations/blacksheep.py

@@ -2,7 +2,7 @@ from typing import Any
 
 from rodi import ContainerProtocol
 
-from injection import Module, default_module
+from injection import Module
 
 __all__ = ("InjectionServices",)
 
@@ -14,8 +14,8 @@ class InjectionServices(ContainerProtocol):
 
     __slots__ = ("__module",)
 
-    def __init__(self, module: Module = default_module):
-        self.__module = module
+    def __init__(self, module: Module = None):
+        self.__module = module or Module.default()
 
     def __contains__(self, item: Any) -> bool:
         return item in self.__module

python_injection-0.9.2/injection/testing/__init__.py

@@ -0,0 +1,40 @@
+from contextlib import contextmanager
+
+from injection import Module, ModulePriority
+
+__all__ = (
+    "set_test_constant",
+    "should_be_test_injectable",
+    "test_injectable",
+    "test_singleton",
+    "use_test_injectables",
+)
+
+
+def get_test_module() -> Module:
+    return Module.from_name("testing")
+
+
+_module = get_test_module()
+
+set_test_constant = _module.set_constant
+should_be_test_injectable = _module.should_be_injectable
+test_injectable = _module.injectable
+test_singleton = _module.singleton
+
+del _module
+
+
+@contextmanager
+def use_test_injectables(*, on: Module = None, test_module: Module = None):
+    on = on or Module.default()
+    test_module = test_module or get_test_module()
+
+    for module in (on, test_module):
+        module.unlock()
+
+    del module
+
+    with on.use_temporarily(test_module, priority=ModulePriority.HIGH):
+        yield
+        on.unlock()

python_injection-0.9.2/injection/testing/__init__.pyi

@@ -0,0 +1,22 @@
+from contextlib import ContextDecorator
+from typing import ContextManager
+
+from injection import Module
+
+_module: Module = ...
+
+set_test_constant = _module.set_constant
+should_be_test_injectable = _module.should_be_injectable
+test_injectable = _module.injectable
+test_singleton = _module.singleton
+
+del _module
+
+def use_test_injectables(
+    *,
+    on: Module = ...,
+    test_module: Module = ...,
+) -> ContextManager | ContextDecorator:
+    """
+    Context manager or decorator for temporary use test module.
+    """

{python_injection-0.9.0 → python_injection-0.9.2}/injection/utils.py

@@ -1,3 +1,4 @@
+from collections.abc import Callable
 from importlib import import_module
 from pkgutil import walk_packages
 from types import ModuleType
@@ -5,9 +6,10 @@ from types import ModuleType
 __all__ = ("load_package",)
 
 
-def load_package(package: ModuleType | str):
+def load_package(package: ModuleType | str, predicate: Callable[[str], bool] = None):
     """
     Function for importing all modules in a Python package.
+    Pass the `predicate` parameter if you want to filter the modules to be imported.
     """
 
     if isinstance(package, str):
@@ -20,8 +22,15 @@ def load_package(package: ModuleType | str):
             "Package has no `__path__` attribute, as it's probably a module."
         ) from exc
 
+    if predicate is None:
+
+        def predicate(_: str) -> bool:
+            return True
+
     for info in walk_packages(path=path, prefix=f"{package.__name__}."):
-        if info.ispkg:
+        name = info.name
+
+        if info.ispkg or not predicate(name):
             continue
 
-        import_module(info.name)
+        import_module(name)

{python_injection-0.9.0 → python_injection-0.9.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-injection"
-version = "0.9.0"
+version = "0.9.2"
 description = "Fast and easy dependency injection framework."
 authors = ["remimd"]
 keywords = ["dependencies", "inject", "injection"]
@@ -41,7 +41,7 @@ implicit_optional = true
 
 [tool.pytest.ini_options]
 python_files = "test_*.py"
-addopts = "-p no:warnings --tb=short"
+addopts = "-p no:warnings --tb=short --cov=./ --cov-report term-missing:skip-covered"
 asyncio_mode = "auto"
 testpaths = "**/tests/"
 

python_injection-0.9.0/injection/__init__.py

@@ -1,28 +0,0 @@
-from .core import Injectable, Module
-from .core import Mode as InjectableMode
-from .core import Priority as ModulePriority
-
-__all__ = (
-    "Injectable",
-    "InjectableMode",
-    "Module",
-    "ModulePriority",
-    "default_module",
-    "get_instance",
-    "get_lazy_instance",
-    "inject",
-    "injectable",
-    "set_constant",
-    "should_be_injectable",
-    "singleton",
-)
-
-default_module = Module(f"{__name__}:default_module")
-
-get_instance = default_module.get_instance
-get_lazy_instance = default_module.get_lazy_instance
-inject = default_module.inject
-injectable = default_module.injectable
-set_constant = default_module.set_constant
-should_be_injectable = default_module.should_be_injectable
-singleton = default_module.singleton