Fast and easy dependency injection framework.
Project description
Basic usage
Register an injectable
Note: If the class needs dependencies, these will be resolved when the instance is retrieved.
If you wish to inject a singleton, use singleton
decorator.
from injection import singleton
@singleton
class ServiceA:
""" class implementation """
If you wish to inject a new instance each time, use injectable
decorator.
from injection import injectable
@injectable
class ServiceB:
""" class implementation """
If you have a constant (such as a global variable) and wish to register it as an injectable, use set_constant
function.
from injection import set_constant
class ServiceC:
""" class implementation """
service_c = set_constant(ServiceC())
Inject an instance
To inject one or several instances, use inject
decorator.
Don't forget to annotate type of parameter to inject.
from injection import inject
@inject
def some_function(service_a: ServiceA):
""" function implementation """
If inject
decorates a class, it will be applied to the __init__
method.
Especially useful for dataclasses:
Note: Doesn't work with Pydantic
BaseModel
because the signature of the__init__
method doesn't contain the dependencies.
from dataclasses import dataclass
from injection import inject
@inject
@dataclass
class SomeDataClass:
service_a: ServiceA = ...
Get an instance
Example with get_instance
function:
from injection import get_instance
service_a = get_instance(ServiceA)
Example with get_lazy_instance
function:
from injection import get_lazy_instance
lazy_service_a = get_lazy_instance(ServiceA)
# ...
service_a = ~lazy_service_a
Inheritance
In the case of inheritance, you can use the decorator parameter on
to link the injection to one or several other
classes.
Warning: if the child class is in another file, make sure that file is imported before injection.
See load_package
function.
Example with one class:
class AbstractService(ABC):
...
@injectable(on=AbstractService)
class ConcreteService(AbstractService):
...
Example with several classes:
class AbstractService(ABC):
...
class ConcreteService(AbstractService):
...
@injectable(on=(AbstractService, ConcreteService))
class ConcreteServiceOverload(ConcreteService):
...
If a class is registered in a package, and you want to override it, there is the mode
parameter:
@injectable
class InaccessibleService:
...
# ...
@injectable(on=InaccessibleService, mode="override")
class ServiceOverload(InaccessibleService):
...
Recipes
A recipe is a function that tells the injector how to construct the instance to be injected. It is important to specify the return type annotation when defining the recipe.
from injection import injectable
@injectable
def service_d_recipe() -> ServiceD:
""" recipe implementation """
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python_injection-0.9.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5de6d7dd851572bf911444d4a31f134817fc27dfb0b54035a5db25d3a04f7a4b |
|
MD5 | 8f71cd4c8f0ebf94e451493d69da9f79 |
|
BLAKE2b-256 | a3db15bf5cff292d3da4a81d1d1c5d0fb226f7d0e7523d1af5b3bd84fc61f5f0 |