Skip to main content

Dependency injection for python

Project description

drawing By: CenturyBoys

Witch-doctor

A simple dependency injection library for Python

Register

Witch Doctor provides a structured method to register interfaces, implementations, injection types, constructor arguments, and container scopes.

  • It validates the inheritance relationship between the interface and implementation. If there’s a mismatch, a TypeError is raised.

  • The injection type is also validated and must be either "singleton" or "factory".

    • "singleton" returns the same instance on every injection.
    • "factory" creates a new instance for each injection. An invalid type will raise a TypeError.
  • If no arguments are provided, the constructor will be called without parameters.

  • The container_name allows you to isolate dependency registrations by scope, enabling multi-context injection.

class WitchDoctor:
    @classmethod
    def register(
        cls,
        interface: Type[ABC],
        class_ref: Any,
        injection_type: InjectionType,
        args: List[any] = None,
        container: str = DEFAULT,
    ):
        """
        WitchDoctor.register will check inherit of the interface and class_ref.
        Will raise a TypeError on validation error\n
        :param interface: Interface that inherits from ABC
        :param class_ref: A implementation of the interface
        :param injection_type: The injection type that must be used for this register. Allowed Factory or Singleton
        :param args: List of args tha will be used to instantiate the class object
        :param container: Container name where the reference will be saved.
        """
        pass

Container

You can register your injections using containers. The method contianer will provide a container register with the same signature as teh register without the container param. To use the created container you need to load it using load_container. The base work load will set all registers in the DEFAULT group

from abc import ABC, abstractmethod

from witch_doctor import WitchDoctor, InjectionType

class IStubFromABCClass(ABC):
    @abstractmethod
    def sum(self, a: int, b: int):
        pass
    
class StubFromABCClass(IStubFromABCClass):
    def sum(self, a: int, b: int):
        return a + b

container = WitchDoctor.container("prod")
WitchDoctor.register(IStubFromABCClass, StubFromABCClass, InjectionType.SINGLETON)   
WitchDoctor.load_container("prod")

Injection

Witch Doctor can be used as decorator. The function signature will ber check and if some values was not provide Witch Doctor will search on the registered interfaces to inject the dependencies.

class WitchDoctor:
    @classmethod
    def injection(cls, function: Callable):
        """
        WitchDoctor.injection is a function decorator that will match the
        function params signature and inject the  dependencies.
        Will raise AttributeError is some args was pass throw\n

        :type function: Callable
        """
        pass

Usage example

from abc import ABC, abstractmethod

from witch_doctor import WitchDoctor, InjectionType


# Abstract class
class IStubFromABCClass(ABC):
    @abstractmethod
    def sum(self, a: int, b: int):
        pass

    
# Implementation
class StubFromABCClass(IStubFromABCClass):
    def __init__(self, a: int):
        self.a = a

    def sum(self, a: int, b: int):
        return a + b + self.a

# Usage
@WitchDoctor.injection
def func_t(a: int, b: int, c: IStubFromABCClass):
    return c.sum(a, b)

# Containers
container = WitchDoctor.container()
container(IStubFromABCClass, StubFromABCClass, InjectionType.FACTORY, args=[10])

container = WitchDoctor.container("prod")
container(IStubFromABCClass, StubFromABCClass, InjectionType.SINGLETON, args=[20])

# Loading and using
WitchDoctor.load_container()

result_a1 = func_t(a=1, b=2)
result_a2 = func_t(a=2, b=2)

assert result_a1 == 13
assert result_a2 == 14

WitchDoctor.load_container("prod")

result_a1 = func_t(a=1, b=2)
result_a2 = func_t(a=2, b=2)

assert result_a1 == 23
assert result_a2 == 24

Resolve

The resolve method is used to retrieve an instance of a class registered in Witch Doctor. It validates the class signature and searches for the matching implementation based on the registered interfaces. Dependencies are automatically injected.

class WitchDoctor:
    @classmethod
    def resolve(cls, interface: T, container_name: str = CURRENT) -> Type[T]:
        """
        WitchDoctor.resolve will return an instance of the registered class_ref interface.
        Will raise a TypeError if interface is not registered\n
        :param interface: A implementation of the interface
        :param container_name: You can specify the container name to be used by the resolve method
        """
        pass

Usage example

from abc import ABC, abstractmethod

from witch_doctor import WitchDoctor, InjectionType


# Abstract class
class IStubFromABCClass(ABC):
    @abstractmethod
    def sum(self, a: int, b: int):
        pass

    
# Implementation
class StubFromABCClass(IStubFromABCClass):
    def __init__(self, a: int):
        self.a = a

    def sum(self, a: int, b: int):
        return a + b + self.a

# Usage
@WitchDoctor.injection
def func_t(a: int, b: int, c: IStubFromABCClass):
    return c.sum(a, b)

# Containers
container = WitchDoctor.container()
container(IStubFromABCClass, StubFromABCClass, InjectionType.FACTORY, args=[10])

# Loading and using
WitchDoctor.load_container()

result_a1 = WitchDoctor.resolve(IStubFromABCClass)
result_a2 = WitchDoctor.resolve(IStubFromABCClass)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

witch_doctor-1.2.1.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

witch_doctor-1.2.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file witch_doctor-1.2.1.tar.gz.

File metadata

  • Download URL: witch_doctor-1.2.1.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.13.3 Linux/6.1.0-37-amd64

File hashes

Hashes for witch_doctor-1.2.1.tar.gz
Algorithm Hash digest
SHA256 60afea79c7556ea4bf574d0063c7e01b685d7bb973c93eed30226851716d76c1
MD5 8a2a088ce010b6b728106db06c615a2f
BLAKE2b-256 62a3d3d55f5ff52451f303ccaa896bd8e608ec440dafb681c290a6606e54efb2

See more details on using hashes here.

File details

Details for the file witch_doctor-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: witch_doctor-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.13.3 Linux/6.1.0-37-amd64

File hashes

Hashes for witch_doctor-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 22a63eee9fe26239b02ff93d9619e452c05252629083d4c0cca229478e724655
MD5 751a96d0e43daa2a2cbe813da3bd2f21
BLAKE2b-256 98b0526174904d1723613ef2835bf141f94e408982883a135fecb0370d0b5249

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page