inject 5.4.0__py3-none-any.whl

inject/__init__.py

@@ -0,0 +1,774 @@
+"""
+Python dependency injection framework.
+
+Usage:
+- Create an optional configuration::
+    def my_config(binder):
+        binder.bind(Cache, RedisCache('localhost:1234'))
+        binder.bind_to_provider(CurrentUser, get_current_user)
+
+- Create a shared injector::
+    inject.configure(my_config)
+
+- Use `inject.instance`, `inject.attr` or `inject.param` to inject dependencies::
+    class User(object):
+        cache = inject.attr(Cache)
+
+        @classmethod
+        def load(cls, id):
+            return cls.cache.load('user', id)
+
+        def save(self):
+            self.cache.save(self)
+
+    def foo(bar):
+        cache = inject.instance(Cache)
+        cache.save('bar', bar)
+
+    @inject.params(cache=Cache)
+    def bar(foo, cache=None):
+        cache.save('foo', foo)
+
+Binding types:
+- Instance bindings configured via `bind(cls, instance) which always return the same instance.
+- Constructor bindings `bind_to_constructor(cls, callable)` which create a singleton
+  on first access.
+- Provider bindings `bind_to_provider(cls, callable)` which call the provider
+  for each injection.
+- Runtime bindings which automatically create class singletons.
+
+Thread-safety:
+After configuration the injector is thread-safe and can be safely reused by multiple threads.
+
+Unit testing:
+In tests use `inject.clear_and_configure(callable)` to create a new injector on setup,
+and `inject.clear()` to clean-up on tear down.
+
+Runtime bindings greatly reduce the required configuration by automatically creating singletons
+on first access. For example, below only the Config class requires binding configuration,
+all other classes are runtime bindings::
+    class Cache(object):
+        config = inject.attr(Config)
+
+        def __init__(self):
+            self._redis = connect(self.config.redis_address)
+
+    class Db(object):
+        pass
+
+    class UserRepo(object):
+        cache = inject.attr(Cache)
+        db = inject.attr(Db)
+
+        def load(self, user_id):
+            return cache.load('user', user_id) or db.load('user', user_id)
+
+    class Config(object):
+        def __init__(self, redis_address):
+            self.redis_address = redis_address
+
+    def my_config(binder):
+        binder.bind(Config, load_config_file())
+
+    inject.configure(my_config)
+
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import contextlib
+import functools
+import inspect
+import logging
+import sys
+import threading
+import typing as t
+
+from inject._version import __version__ as __version__
+
+# PEP 604
+_HAS_PEP604_SUPPORT = sys.version_info[:3] >= (3, 10, 0)
+# PEP 560
+_HAS_PEP560_SUPPORT = _HAS_PEP604_SUPPORT or sys.version_info[:3] >= (3, 7, 0)
+
+_RETURN = "return"
+_MISSING = object()
+
+if _HAS_PEP604_SUPPORT:
+    from types import UnionType
+    from typing import _GenericAlias  # noqa: ICN003
+elif _HAS_PEP560_SUPPORT:
+    from typing import _GenericAlias  # noqa: ICN003, PLC2701
+else:
+    from typing import _Union  # noqa: ICN003, PLC2701
+
+if t.TYPE_CHECKING:
+    from typing_extensions import ParamSpec
+
+    P = ParamSpec("P")
+else:
+    P = object()
+
+logger = logging.getLogger("inject")
+
+_INJECTOR = None  # Shared injector instance.
+_INJECTOR_LOCK = threading.RLock()  # Guards injector initialization.
+_BINDING_LOCK = threading.RLock()  # Guards runtime bindings.
+
+Injectable = t.Union[object, t.Any]
+T = t.TypeVar("T", bound=Injectable)
+Binding = t.Union[type[Injectable], t.Hashable]
+Constructor = t.Callable[
+    [],
+    t.Union[
+        Injectable,
+        contextlib.AbstractContextManager[Injectable],
+        contextlib.AbstractAsyncContextManager[Injectable],
+    ],
+]
+Provider = Constructor
+BinderCallable = t.Callable[["Binder"], t.Optional["Binder"]]
+
+
+class ConstructorTypeError(TypeError):
+    def __init__(self, constructor: t.Callable, previous_error: TypeError) -> None:
+        super().__init__(f"{constructor} raised an error: {previous_error}")
+
+
+class Binder:
+    _bindings: dict[Binding, Constructor]
+
+    def __init__(self, allow_override: bool = False) -> None:  # noqa: FBT001, FBT002
+        self._bindings = {}
+        self.allow_override = allow_override
+
+    def install(self, config: BinderCallable) -> Binder:
+        """Install another callable configuration."""
+        config(self)
+        return self
+
+    def bind(self, cls: Binding, instance: T) -> Binder:
+        """Bind a class to an instance."""
+        self._check_class(cls)
+
+        b = lambda: instance  # noqa: E731
+        self._bindings[cls] = b
+        self._maybe_bind_forward(cls, b)
+
+        logger.debug("Bound %s to an instance %s", cls, instance)
+        return self
+
+    def bind_to_constructor(self, cls: Binding, constructor: Constructor) -> Binder:
+        """
+        Bind a class to a callable singleton constructor.
+
+        Raises:
+            InjectorException: if no constructor
+
+        """
+        self._check_class(cls)
+        if constructor is None:
+            raise InjectorException(f"Constructor cannot be None, key={cls}")
+
+        b = _ConstructorBinding(constructor)
+        self._bindings[cls] = b
+        self._maybe_bind_forward(cls, b)
+
+        logger.debug("Bound %s to a constructor %s", cls, constructor)
+        return self
+
+    def bind_to_provider(self, cls: Binding, provider: Provider) -> Binder:
+        """
+        Bind a class to a callable instance provider executed for each injection.
+
+        A provider can be a normal function or a context manager.
+        Both sync and async are supported.
+
+        Raises:
+            InjectorException: if no provider
+
+        """
+        self._check_class(cls)
+        if provider is None:
+            raise InjectorException(f"Provider cannot be None, key={cls}")
+
+        b = provider
+        self._bindings[cls] = b
+        self._maybe_bind_forward(cls, b)
+
+        logger.debug("Bound %s to a provider %s", cls, provider)
+        return self
+
+    def _check_class(self, cls: Binding) -> None:
+        if cls is None:
+            raise InjectorException("Binding key cannot be None")
+
+        if not self.allow_override and cls in self._bindings:
+            raise InjectorException(f"Duplicate binding, key={cls}")
+
+        if self._is_forward_str(cls):
+            ref = t.ForwardRef(cls)
+            if not self.allow_override and ref in self._bindings:
+                msg = f'Duplicate forward binding, i.e. "int" and int, key={cls}'
+                raise InjectorException(msg)
+
+    def _maybe_bind_forward(self, cls: Binding, binding: t.Any) -> None:  # noqa: ANN401
+        """Bind a string forward reference."""
+        if not _HAS_PEP560_SUPPORT:
+            return
+        if not isinstance(cls, str):
+            return
+
+        ref = t.ForwardRef(cls)
+        self._bindings[ref] = binding
+        logger.debug('Bound forward ref "%s"', cls)
+
+    @staticmethod
+    def _is_forward_str(kls: Binding) -> bool:
+        return _HAS_PEP560_SUPPORT and isinstance(kls, str)
+
+
+class Injector:
+    _bindings: dict[Binding, Constructor]
+
+    def __init__(
+        self,
+        config: t.Optional[BinderCallable] = None,
+        # TODO(pyctrl): force following flags to be kwargs
+        bind_in_runtime: bool = True,  # noqa: FBT001, FBT002
+        allow_override: bool = False,  # noqa: FBT001, FBT002
+    ) -> None:
+        self._bind_in_runtime = bind_in_runtime
+        if config:
+            binder = Binder(allow_override)
+            config(binder)
+            self._bindings = binder._bindings  # noqa: SLF001
+        else:
+            self._bindings = {}
+
+    # NOTE(pyctrl): only since 3.12
+    # @t.overload
+    # def get_instance(self, cls: type[T]) -> T: ...
+
+    @t.overload
+    def get_instance(self, cls: Binding) -> T: ...
+
+    @t.overload
+    def get_instance(self, cls: t.Hashable) -> Injectable: ...
+
+    def get_instance(self, cls: Binding) -> Injectable:
+        """
+        Return an instance for a class.
+
+        Raises:
+            InjectorException: on errors
+            ConstructorTypeError: over TypeError
+
+        """
+        binding = self._bindings.get(cls)
+        if binding:
+            return binding()
+
+        # Try to create a runtime binding.
+        with _BINDING_LOCK:
+            binding = self._bindings.get(cls)
+            if binding:
+                return binding()
+
+            if not self._bind_in_runtime:
+                msg = f"No binding was found for key={cls}"
+                raise InjectorException(msg)
+
+            if not callable(cls):
+                msg = (
+                    "Cannot create a runtime binding, the key is not callable,"
+                    f" key={cls}",
+                )
+                raise InjectorException(msg)
+
+            try:
+                instance = cls()
+            except TypeError as previous_error:
+                raise ConstructorTypeError(cls, previous_error)  # noqa: B904
+
+            self._bindings[cls] = lambda: instance
+
+            msg = "Created a runtime binding for key=%s, instance=%s"
+            logger.debug(msg, cls, instance)
+            return instance
+
+
+class InjectorException(Exception):
+    pass
+
+
+class _ConstructorBinding(t.Generic[T]):
+    _instance: t.Optional[T]
+
+    def __init__(self, constructor: t.Callable[[], T]) -> None:
+        self._constructor = constructor
+        self._created = False
+        self._instance = None
+
+    def __call__(self) -> T:
+        if self._created and self._instance is not None:
+            return self._instance
+
+        with _BINDING_LOCK:
+            if self._created and self._instance is not None:
+                return self._instance
+            self._instance = self._constructor()
+            self._created = True
+        return self._instance
+
+
+# NOTE(pyctrl): we MUST inherit `_AttributeInjection` from `property`
+#   0. (personal opinion, based on a bunch of cases including this one)
+#      dataclasses are mess
+#   1. dataclasses treat all non-`property` descriptors by the very specific logic
+#     https://docs.python.org/3/library/dataclasses.html#descriptor-typed-fields
+#   2. and treat `property` descriptors in a special way — like we used to know:
+#      ```
+#          @dataclass
+#          class MyDataclass:
+#              @property
+#              def my_prop(self) -> int:
+#                  return 42
+#          MyDataclass.my_prop    # gives '<property at 0x73055337f150>' on class
+#          MyDataclass().my_prop  # and on instance will show you '42'
+#      ```
+#      it behaves the same in the case of alternative notation:
+#      ```
+#          @dataclass
+#          class MyDataclass2:
+#              my_prop = property(fget=lambda _: 42)
+#          MyDataclass2.my_prop    # gives '<property at 0x73055337ec00>' on class
+#          MyDataclass2().my_prop  # and on instance will show you '42'
+#      ```
+#      which is more relevant to the `inject.attr` case
+#   3. but the behavior around `property`-ies has an exception
+#        - you can't annotate `property` attribute when using the second notation
+#          (this one `my_prop: int = property(fget=lambda _: 42)` will fail)
+#        - so the type hinting the very matters
+#        - in this case dataclasses don't treat class member as property
+#          (even if it's inherited from `property` or used directly)
+#        - dataclasses behave greedy when discover their attributes
+#          and class member annotations are "must have" markers
+#   4. so for `inject.attr`s case we should follow 2 rules:
+#        - `attr` implementation is inherited from `property`
+#        - `attr` class member is not annotated
+class _AttributeInjection(property):
+    def __init__(self, cls: t.Union[type[T], t.Hashable]) -> None:
+        self._cls = cls
+        super().__init__(
+            fget=lambda _: instance(self._cls),
+            doc="Return an attribute injection",
+        )
+
+    def __set_name__(self, owner: type[T], name: str) -> None:
+        if self._cls is _MISSING:
+            self._cls = _unwrap_cls_annotation(owner, name)
+
+
+class _ParameterInjection(t.Generic[T]):
+    __slots__ = ("_cls", "_name")
+
+    def __init__(self, name: str, cls: t.Optional[Binding] = None) -> None:
+        self._name = name
+        self._cls = cls
+
+    def __call__(
+        self, func: t.Callable[..., t.Union[T, t.Awaitable[T]]]
+    ) -> t.Callable[..., t.Union[T, t.Awaitable[T]]]:
+        if inspect.iscoroutinefunction(func):
+
+            @functools.wraps(func)
+            async def async_injection_wrapper(*args: t.Any, **kwargs: t.Any) -> T:  # noqa: ANN401
+                if self._name not in kwargs:
+                    kwargs[self._name] = instance(self._cls or self._name)
+                async_func = t.cast("t.Callable[..., t.Awaitable[T]]", func)
+                return await async_func(*args, **kwargs)
+
+            return async_injection_wrapper
+
+        @functools.wraps(func)
+        def injection_wrapper(*args: t.Any, **kwargs: t.Any) -> T:  # noqa: ANN401
+            if self._name not in kwargs:
+                kwargs[self._name] = instance(self._cls or self._name)
+            sync_func = t.cast("t.Callable[..., T]", func)
+            return sync_func(*args, **kwargs)
+
+        return injection_wrapper
+
+
+class _ParametersInjection(t.Generic[T]):
+    __slots__ = ("_params",)
+
+    def __init__(self, **kwargs: Binding) -> None:
+        self._params = kwargs
+
+    @staticmethod
+    def _aggregate_sync_stack(
+        sync_stack: contextlib.ExitStack,
+        provided_params: frozenset[str],
+        kwargs: dict[str, t.Any],
+    ) -> None:
+        """
+        Manage context stack.
+
+        Extracts context managers, aggregate them in an ExitStack
+        and swap out the param value with results of running `__enter__()`.
+        The result is equivalent to using `with` multiple times.
+        """
+        executed_kwargs = {
+            param: sync_stack.enter_context(inst)
+            for param, inst in kwargs.items()
+            if param not in provided_params
+            and isinstance(inst, contextlib.AbstractContextManager)
+        }
+        kwargs.update(executed_kwargs)
+
+    @staticmethod
+    async def _aggregate_async_stack(
+        async_stack: contextlib.AsyncExitStack,
+        provided_params: frozenset[str],
+        kwargs: dict[str, t.Any],
+    ) -> None:
+        """Similar to _aggregate_sync_stack, but for async context managers."""
+        executed_kwargs = {
+            param: await async_stack.enter_async_context(inst)
+            for param, inst in kwargs.items()
+            if param not in provided_params
+            and isinstance(inst, contextlib.AbstractAsyncContextManager)
+        }
+        kwargs.update(executed_kwargs)
+
+    def __call__(
+        self, func: t.Callable[..., t.Union[t.Awaitable[T], T]]
+    ) -> t.Callable[..., t.Union[t.Awaitable[T], T]]:
+        arg_names = inspect.getfullargspec(func).args
+        params_to_provide = self._params
+
+        if inspect.iscoroutinefunction(func):
+
+            @functools.wraps(func)
+            async def async_injection_wrapper(*args: t.Any, **kwargs: t.Any) -> T:  # noqa: ANN401
+                provided_params = frozenset(arg_names[: len(args)]) | frozenset(
+                    kwargs.keys()
+                )
+                for param, cls in params_to_provide.items():
+                    if param not in provided_params:
+                        kwargs[param] = instance(cls)
+                async_func = t.cast("t.Callable[..., t.Awaitable[T]]", func)
+                try:
+                    with contextlib.ExitStack() as sync_stack:
+                        async with contextlib.AsyncExitStack() as async_stack:
+                            self._aggregate_sync_stack(
+                                sync_stack, provided_params, kwargs
+                            )
+                            await self._aggregate_async_stack(
+                                async_stack, provided_params, kwargs
+                            )
+                            return await async_func(*args, **kwargs)
+                except TypeError as previous_error:
+                    raise ConstructorTypeError(func, previous_error)  # noqa: B904
+
+            return async_injection_wrapper
+
+        @functools.wraps(func)
+        def injection_wrapper(*args: t.Any, **kwargs: t.Any) -> T:  # noqa: ANN401
+            provided_params = frozenset(arg_names[: len(args)]) | frozenset(
+                kwargs.keys()
+            )
+            for param, cls in params_to_provide.items():
+                if param not in provided_params:
+                    kwargs[param] = instance(cls)
+            sync_func = t.cast("t.Callable[..., T]", func)
+            try:
+                with contextlib.ExitStack() as sync_stack:
+                    self._aggregate_sync_stack(sync_stack, provided_params, kwargs)
+                    return sync_func(*args, **kwargs)
+            except TypeError as previous_error:
+                raise ConstructorTypeError(func, previous_error)  # noqa: B904
+
+        return injection_wrapper
+
+
+def configure(
+    config: t.Optional[BinderCallable] = None,
+    # TODO(pyctrl): force following flags to be kwargs
+    bind_in_runtime: bool = True,  # noqa: FBT001, FBT002
+    allow_override: bool = False,  # noqa: FBT001, FBT002
+    clear: bool = False,  # noqa: FBT001, FBT002
+    once: bool = False,  # noqa: FBT001, FBT002
+) -> Injector:
+    """
+    Create an injector using callable config.
+
+    Raises:
+        InjectorException: if already configured.
+
+    """
+    global _INJECTOR  # noqa: PLW0603
+
+    if clear and once:
+        msg = "clear and once are mutually exclusive, only one can be True"
+        raise InjectorException(msg)
+
+    with _INJECTOR_LOCK:
+        if _INJECTOR:
+            if clear:
+                _clear_injector()
+            elif once:
+                return _INJECTOR
+            else:
+                raise InjectorException("Injector is already configured")
+
+        _INJECTOR = Injector(
+            config,
+            bind_in_runtime=bind_in_runtime,
+            allow_override=allow_override,
+        )
+        logger.debug("Created and configured an injector, config=%s", config)
+        return _INJECTOR
+
+
+def configure_once(
+    config: t.Optional[BinderCallable] = None,
+    # TODO(pyctrl): force following flags to be kwargs
+    bind_in_runtime: bool = True,  # noqa: FBT001, FBT002
+    allow_override: bool = False,  # noqa: FBT001, FBT002
+) -> Injector:
+    """
+    Create an injector with a callable config if not present, otherwise, do nothing.
+
+    Deprecated, use `configure(once=True)` instead.
+    """
+    with _INJECTOR_LOCK:
+        if _INJECTOR:
+            return _INJECTOR
+
+        return configure(
+            config, bind_in_runtime=bind_in_runtime, allow_override=allow_override
+        )
+
+
+def clear_and_configure(
+    config: t.Optional[BinderCallable] = None,
+    # TODO(pyctrl): force following flags to be kwargs
+    bind_in_runtime: bool = True,  # noqa: FBT001, FBT002
+    allow_override: bool = False,  # noqa: FBT001, FBT002
+) -> Injector:
+    """
+    Clear an existing injector and create another one with a callable config.
+
+    Deprecated, use configure(clear=True) instead.
+    """
+    with _INJECTOR_LOCK:
+        _clear_injector()
+        return configure(
+            config,
+            bind_in_runtime=bind_in_runtime,
+            allow_override=allow_override,
+        )
+
+
+def is_configured() -> bool:
+    """Return true if an injector is already configured."""
+    with _INJECTOR_LOCK:
+        return _INJECTOR is not None
+
+
+def clear() -> None:
+    """Clear an existing injector if present."""
+    _clear_injector()
+
+
+def _clear_injector() -> None:
+    """Clear an existing injector if present."""
+    global _INJECTOR  # noqa: PLW0603
+
+    with _INJECTOR_LOCK:
+        if _INJECTOR is None:
+            return
+
+        _INJECTOR = None
+        logger.debug("Cleared an injector")
+
+
+@t.overload
+def instance(cls: type[T]) -> T: ...
+
+
+@t.overload
+def instance(cls: t.Hashable) -> Injectable: ...
+
+
+def instance(cls: Binding) -> Injectable:
+    """Inject an instance of a class."""
+    return get_injector_or_die().get_instance(cls)
+
+
+@t.overload
+def attr() -> Injectable: ...
+
+
+@t.overload
+def attr(cls: t.Hashable) -> Injectable: ...
+
+
+@t.overload
+def attr(cls: type[T]) -> T: ...
+
+
+def attr(cls=_MISSING):
+    """Return an attribute injection (descriptor)."""
+    return _AttributeInjection(cls)
+
+
+# Deprecated, use `attr`
+attr_dc = attr
+
+
+def param(name: str, cls: t.Optional[Binding] = None) -> t.Callable:
+    """
+    Return a decorator which injects an arg into a function.
+
+    Deprecated, use @inject.params.
+    """
+    return _ParameterInjection(name, cls)
+
+
+def params(**args_to_classes: Binding) -> t.Callable:
+    """
+    Return a decorator which injects args into a function.
+
+    For example::
+
+        @inject.params(cache=RedisCache, db=DbInterface)
+        def sign_up(name, email, cache, db):
+            pass
+    """
+    return _ParametersInjection(**args_to_classes)
+
+
+@t.overload
+def autoparams(fn: t.Callable[P, T]) -> t.Callable[P, T]: ...
+
+
+@t.overload
+def autoparams(*selected: str) -> t.Callable[[T], T]: ...
+
+
+def autoparams(*selected: t.Callable[P, T] | str) -> t.Callable[..., T]:
+    """
+    Return a decorator injecting args based on function type hints, only since 3.5.
+
+    For example::
+
+        @inject.autoparams
+        def refresh_cache(cache: RedisCache, db: DbInterface):
+            pass
+
+    There is an option to specify which arguments we want to
+    inject without attempts of injecting everything:
+
+    For example::
+
+        @inject.autoparams('cache', 'db')
+        def sign_up(name, email, cache: RedisCache, db: DbInterface):
+            pass
+    """
+    only_these: set[str] = set()
+
+    def autoparams_decorator(fn: t.Callable[..., T]) -> t.Callable[..., T]:
+        if inspect.isclass(fn):
+            types = t.get_type_hints(fn.__init__)
+        else:
+            types = t.get_type_hints(fn)
+
+        # Skip the return annotation.
+        types = {name: typ for name, typ in types.items() if name != _RETURN}
+
+        # Convert Union types into single types, i.e. Union[A, None] => A.
+        types = {name: _unwrap_union_arg(typ) for name, typ in types.items()}
+
+        # Filter types if selected args present.
+        if only_these:
+            types = {name: typ for name, typ in types.items() if name in only_these}
+
+        wrapper: _ParametersInjection[T] = _ParametersInjection(**types)
+        return wrapper(fn)
+
+    target = selected[0] if selected else None
+    if len(selected) == 1 and callable(target):
+        return autoparams_decorator(target)
+
+    only_these.update(selected)
+    return autoparams_decorator
+
+
+def get_injector() -> t.Optional[Injector]:
+    """Return the current injector or None."""
+    return _INJECTOR
+
+
+def get_injector_or_die() -> Injector:
+    """
+    Return the current injector or raise an InjectorException.
+
+    Raises:
+        InjectorException: If injector is not configured.
+
+    Returns:
+      Configured injector.
+
+    """
+    injector = _INJECTOR
+    if not injector:
+        raise InjectorException("No injector is configured")
+
+    return injector
+
+
+def _unwrap_union_arg(typ: type) -> type:
+    """Return the first type A in typing.Union[A, B] or typ if not Union."""
+    if not _is_union_type(typ):
+        return typ
+    return typ.__args__[0]
+
+
+def _is_union_type(typ: type) -> bool:
+    """
+    Test if the type is a union type.
+
+    Examples::
+        is_union_type(int) == False
+        is_union_type(Union) == True
+        is_union_type(Union[int, int]) == False
+        is_union_type(Union[T, int]) == True
+
+    Source: https://github.com/ilevkivskyi/typing_inspect/blob/master/typing_inspect.py
+    """
+    if _HAS_PEP604_SUPPORT:
+        return (
+            typ is t.Union
+            or isinstance(typ, UnionType)
+            or (isinstance(typ, _GenericAlias) and typ.__origin__ is t.Union)
+        )
+    if _HAS_PEP560_SUPPORT:
+        return typ is t.Union or (
+            isinstance(typ, _GenericAlias) and typ.__origin__ is t.Union
+        )
+    return type(typ) is _Union
+
+
+def _unwrap_cls_annotation(cls: type, attr_name: str) -> type:
+    types = t.get_type_hints(cls)
+    try:
+        attr_type = types[attr_name]
+    except KeyError:
+        msg = f"Couldn't find type annotation for {attr_name}"
+        raise InjectorException(msg) from None
+
+    return _unwrap_union_arg(attr_type)

inject/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '5.4.0'
+__version_tuple__ = version_tuple = (5, 4, 0)
+
+__commit_id__ = commit_id = None

inject-5.4.0.dist-info/METADATA

@@ -0,0 +1,364 @@
+Metadata-Version: 2.4
+Name: inject
+Version: 5.4.0
+Summary: Python dependency injection framework.
+Project-URL: homepage, https://github.com/ivankorobkov/python-inject
+Project-URL: source, https://github.com/ivankorobkov/python-inject
+Project-URL: issues, https://github.com/ivankorobkov/python-inject/issues
+Author-email: Ivan Korobkov <ivan.korobkov@gmail.com>
+Maintainer-email: Ivan Korobkov <ivan.korobkov@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# python-inject [![Build Status](https://travis-ci.org/ivankorobkov/python-inject.svg?branch=master)](https://travis-ci.org/ivankorobkov/python-inject)
+Dependency injection the python way, the good way.
+
+## Key features
+* Fast.
+* Thread-safe.
+* Simple to use.
+* Does not steal class constructors.
+* Does not try to manage your application object graph.
+* Transparently integrates into tests.
+* Autoparams leveraging type annotations.
+* Supports type hinting in Python 3.5+.
+* Supports Python 3.9+ (`v5.*`), 3.5-3.8 (`v4.*`) and Python 2.7–3.5 (`v3.*`).
+* Supports context managers.
+
+## Python Support
+
+| Python  | Inject Version |
+|---------|----------------|
+| 3.9+    | 5.0+           |
+| 3.6-3.8 | 4.1+, < 5.0    |
+| 3.5     | 4.0            |
+| < 3.5   | 3.*            |
+
+
+## Installation
+Use pip to install the lastest version:
+
+```bash
+pip install inject
+```
+
+## Autoparams example
+`@inject.autoparams` returns a decorator which automatically injects arguments into a function 
+that uses type annotations. This is supported only in Python >= 3.5.
+
+```python
+@inject.autoparams
+def refresh_cache(cache: RedisCache, db: DbInterface):
+    pass
+```
+
+There is an option to specify which arguments we want to inject without attempts of 
+injecting everything:
+
+```python
+@inject.autoparams('cache', 'db')
+def sign_up(name, email, cache: RedisCache, db: DbInterface):
+    pass
+```
+
+It is also acceptable to use explicit curly braces notation (`@inject.autoparams()`)
+for non-parameterized decorations — it will be treated the same as `@inject.autoparams`.
+
+## Step-by-step example
+```python
+# Import the inject module.
+import inject
+
+
+# `inject.instance` requests dependencies from the injector.
+def foo(bar):
+    cache = inject.instance(Cache)
+    cache.save('bar', bar)
+
+
+# `inject.params` injects dependencies as keyword arguments or positional argument. 
+# Also you can use @inject.autoparams in Python 3.5, see the example above.
+@inject.params(cache=Cache, user=CurrentUser)
+def baz(foo, cache=None, user=None):
+    cache.save('foo', foo, user)
+
+# this can be called in different ways:
+# with injected arguments
+baz('foo')
+
+# with positional arguments
+baz('foo', my_cache)
+
+# with keyword arguments
+baz('foo', my_cache, user=current_user)
+
+
+# `inject.param` is deprecated, use `inject.params` instead.
+@inject.param('cache', Cache)
+def bar(foo, cache=None):
+    cache.save('foo', foo)
+
+
+# `inject.attr` creates properties (descriptors) which request dependencies on access.
+class User(object):
+    cache = inject.attr(Cache)
+            
+    def __init__(self, id):
+        self.id = id
+
+    def save(self):
+        self.cache.save('users', self)
+    
+    @classmethod
+    def load(cls, id):
+        return cls.cache.load('users', id)
+
+
+# Create an optional configuration.
+def my_config(binder):
+    binder.bind(Cache, RedisCache('localhost:1234'))
+
+# Configure a shared injector.
+inject.configure(my_config)
+
+
+# Instantiate User as a normal class. Its `cache` dependency is injected when accessed.
+user = User(10)
+user.save()
+
+# Call the functions, the dependencies are automatically injected.
+foo('Hello')
+bar('world')
+```
+
+
+## Context managers
+Binding a class to an instance of a context manager (through `bind` or `bind_to_constructor`) 
+or to a function decorated as a context manager leads to the context manager to be used as is, 
+not via with statement.
+
+```python
+@contextlib.contextmanager
+def get_file_sync():
+    obj = MockFile()
+    yield obj
+    obj.destroy()
+
+@contextlib.asynccontextmanager
+async def get_conn_async():
+    obj = MockConnection()
+    yield obj
+    obj.destroy()
+
+def config(binder):
+    binder.bind_to_provider(MockFile, get_file_sync)
+    binder.bind(int, 100)
+    binder.bind_to_provider(str, lambda: "Hello")
+    binder.bind_to_provider(MockConnection, get_conn_sync)
+
+    inject.configure(config)
+
+@inject.autoparams()
+def example(conn: MockConnection, file: MockFile):
+    # Connection and file will be automatically destroyed on exit.
+    pass
+```
+
+
+## Usage with Django
+Django can load some modules multiple times which can lead to 
+`InjectorException: Injector is already configured`. You can use `configure(once=True)` which
+is guaranteed to run only once when the injector is absent:
+```python
+import inject
+inject.configure(my_config, once=True)
+```
+
+## Testing
+In tests use `inject.configure(callable, clear=True)` to create a new injector on setup,
+and optionally `inject.clear()` to clean up on tear down:
+```python
+class MyTest(unittest.TestCase):
+    def setUp(self):
+        inject.configure(lambda binder: binder
+            .bind(Cache, MockCache()) \
+            .bind(Validator, TestValidator()),
+            clear=True)
+    
+    def tearDown(self):
+        inject.clear()
+```
+
+## Composable configurations
+You can reuse configurations and override already registered dependencies to fit the needs 
+in different environments or specific tests.
+```python
+    def base_config(binder):
+        # ... more dependencies registered here
+        binder.bind(Validator, RealValidator())
+        binder.bind(Cache, RedisCache('localhost:1234'))
+
+    def tests_config(binder):
+        # reuse existing configuration
+        binder.install(base_config)
+
+        # override only certain dependencies
+        binder.bind(Validator, TestValidator())
+        binder.bind(Cache, MockCache())
+    
+    inject.configure(tests_config, allow_override=True, clear=True)
+        
+```
+
+## Thread-safety
+After configuration the injector is thread-safe and can be safely reused by multiple threads.
+
+## Binding types
+**Instance** bindings always return the same instance:
+
+```python
+redis = RedisCache(address='localhost:1234')
+def config(binder):
+    binder.bind(Cache, redis)
+```
+    
+**Constructor** bindings create a singleton on injection:
+
+```python
+def config(binder):
+    # Creates a redis cache singleton on first injection.
+    binder.bind_to_constructor(Cache, lambda: RedisCache(address='localhost:1234'))
+```
+
+**Provider** bindings call the provider on injection:
+
+```python
+def get_my_thread_local_cache():
+    pass
+
+def config(binder):
+    # Executes the provider on each injection.
+    binder.bind_to_provider(Cache, get_my_thread_local_cache) 
+```
+
+**Runtime** bindings automatically create singletons on injection, require no configuration.
+For example, only the `Config` class binding is present, other bindings are runtime:
+
+```python
+class Config(object):
+    pass
+
+class Cache(object):
+    config = inject.attr(Config)
+
+class Db(object):
+    config = inject.attr(Config)
+
+class User(object):
+    cache = inject.attr(Cache)
+    db = inject.attr(Db)
+    
+    @classmethod
+    def load(cls, user_id):
+        return cls.cache.load('users', user_id) or cls.db.load('users', user_id)
+    
+inject.configure(lambda binder: binder.bind(Config, load_config_file()))
+user = User.load(10)
+```
+## Disabling runtime binding
+Sometimes runtime binding leads to unexpected behaviour.  Say if you forget
+to bind an instance to a class, `inject` will try to implicitly instantiate it.
+
+If an instance is unintentionally created with default arguments it may lead to
+hard-to-debug bugs.  To disable runtime binding and make sure that only 
+explicitly bound instances are injected, pass `bind_in_runtime=False` to `inject.configure`.
+
+In this case `inject` immediately raises `InjectorException` when the code
+tries to get an unbound instance.
+
+## Keys
+It is possible to use any hashable object as a binding key. For example:
+
+```python
+import inject
+
+inject.configure(lambda binder: \
+    binder.bind('host', 'localhost') \
+    binder.bind('port', 1234))
+```
+
+## Why no scopes?
+I've used Guice and Spring in Java for a lot of years, and I don't like their scopes.
+`python-inject` by default creates objects as singletons. It does not need a prototype scope
+as in Spring or NO_SCOPE as in Guice because `python-inject` does not steal your class 
+constructors. Create instances the way you like and then inject dependencies into them.
+
+Other scopes such as a request scope or a session scope are fragile, introduce high coupling,
+and are difficult to test. In `python-inject` write custom providers which can be thread-local, 
+request-local, etc.
+
+For example, a thread-local current user provider:
+
+```python
+import inject
+import threading
+
+# Given a user class.
+class User(object):
+    pass
+
+# Create a thread-local current user storage.
+_LOCAL = threading.local()
+
+def get_current_user():
+    return getattr(_LOCAL, 'user', None)
+
+def set_current_user(user):
+    _LOCAL.user = user
+
+# Bind User to a custom provider.
+inject.configure(lambda binder: binder.bind_to_provider(User, get_current_user))
+
+# Inject the current user.
+@inject.params(user=User)
+def foo(user):
+    pass
+```
+
+## Links
+* Project: https://github.com/ivankorobkov/python-inject
+
+## License
+Apache License 2.0
+
+## Contributors
+* Ivan Korobkov [@ivankorobkov](https://github.com/ivankorobkov)
+* Jaime Wyant [@jaimewyant](https://github.com/jaimewyant)
+* Sebastian Buczyński [@Enforcer](https://github.com/Enforcer)
+* Oleksandr Fedorov [@Fedorof](https://github.com/Fedorof)
+* cselvaraj [@cselvaraj](https://github.com/cselvaraj)
+* 陆雨晴 [@SixExtreme](https://github.com/SixExtreme)
+* Andrew William Borba [@andrewborba10](https://github.com/andrewborba10)
+* jdmeyer3 [@jdmeyer3](https://github.com/jdmeyer3)
+* Alex Grover [@ajgrover](https://github.com/ajgrover)
+* Harro van der Kroft [@wisepotato](https://github.com/wisepotato)
+* Samiur Rahman [@samiur](https://github.com/samiur)
+* 45deg [@45deg](https://github.com/45deg)
+* Alexander Nicholas Costas [@ancostas](https://github.com/ancostas)
+* Dmitry Balabka [@dbalabka](https://github.com/dbalabka)
+* Dima Burmistrov [@pyctrl](https://github.com/pyctrl)

inject-5.4.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+inject/__init__.py,sha256=MuOsUjyTAP-tLLmGN5b-YwlC-WMKrgI2pv7NofNAxik,24292
+inject/_version.py,sha256=rjYYiDuH70jBUooDgzK9RqknoeUzpbWyI0r8auWj3DI,520
+inject/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+inject-5.4.0.dist-info/METADATA,sha256=hBf2pXd-plZgg88FWSz9UtCg0EUmk8p_84wbDLs4s50,10937
+inject-5.4.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+inject-5.4.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+inject-5.4.0.dist-info/RECORD,,

inject-5.4.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

inject-5.4.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.