Dependency Injector is a dependency injection framework for Python.
It helps implementing the dependency injection principle.
Key features of the Dependency Injector:
- Providers. Provides
Factory,Singleton,Callable,Coroutine,Object,List,Configuration,DependencyandSelectorproviders that help assembling your objects. See Providers. - Overriding. Can override any provider by another provider on the fly. This helps in testing and configuring dev / stage environment to replace API clients with stubs etc. See Provider overriding.
- Configuration. Read configuration from
yaml&inifiles, environment variables and dictionaries. See Configuration provider. - Containers. Provides declarative and dynamic containers. See Containers.
- Performance. Fast. Written in
Cython. - Typing. Provides typing stubs,
mypy-friendly. See Typing and mypy. - Maturity. Mature and production-ready. Well-tested, documented and supported.
from dependency_injector import containers, providers
from dependency_injector.wiring import Provide
class Container(containers.DeclarativeContainer):
config = providers.Configuration()
api_client = providers.Singleton(
ApiClient,
api_key=config.api_key,
timeout=config.timeout.as_int(),
)
service = providers.Factory(
Service,
api_client=api_client,
)
def main(service: Service = Provide[Container.service]):
...
if __name__ == '__main__':
container = Container()
container.config.api_key.from_env('API_KEY')
container.config.timeout.from_env('TIMEOUT')
container.wire(modules=[sys.modules[__name__]])
main()With the Dependency Injector you keep application structure in one place.
This place is called the container. You use the container to manage all the components of the
application. All the component dependencies are defined explicitly. This provides the control on
the application structure. It is easy to understand and change it.
The container is like a map of your application. You always know what depends on what.
Visit the docs to know more about the Dependency injection and inversion of control in Python.
The package is available on the PyPi:
pip install dependency-injector
The documentation is available on the Read T 7FD5 he Docs
Choose one of the following:
- Application example (single container)
- Application example (multiple containers)
- Decoupled packages example (multiple containers)
Choose one of the following:
- Flask web application tutorial
- Aiohttp REST API tutorial
- Asyncio monitoring daemon tutorial
- CLI application tutorial
Dependency Injector stands on two principles:
- Explicit is better than implicit (PEP20).
- Do no magic to your code.
How is it different from the other frameworks?
- No autowiring. The framework does NOT do any autowiring / autoresolving of the dependencies. You need to specify everything explicitly. Because "Explicit is better than implicit" (PEP20).
- Does not pollute your code. Your application does NOT know and does NOT depend on the framework. No
@injectdecorators, annotations, patching or any other magic tricks.
Dependency Injector makes a simple contract with you:
- You tell the framework how to assemble your objects
- The framework does it for you
The power of the Dependency Injector is in its simplicity and straightforwardness. It is a simple tool for the powerful concept.
- What is the dependency injection?
- dependency injection is a principle that decreases coupling and increases cohesion
- Why should I do the dependency injection?
- your code becomes more flexible, testable and clear
- you have no problems when you need to understand how it works or change it 😎
- How do I start doing the dependency injection?
- you start writing the code following the dependency injection principle
- you register all of your application components and their dependencies in the container
- when you need a component, you get it from the container
- Why do I need a framework for this?
- you need the framework for this to not create it by your own
- this framework gives you the container and the providers
- the container is like a dictionary with the batteries 🔋
- the providers manage the lifetime of your components, you will need factories, singletons, smart config object etc
- What price do I pay and what do I get?
- you need to explicitly specify the dependencies in the container
- it will be extra work in the beginning
- it will payoff when project grows or in two weeks 😊 (when you forget what project was about)
- What features does the framework have?
- building objects graph
- smart configuration object
- providers: factory, singleton, thread locals registers, etc
- positional and keyword context injections
- overriding of the objects in any part of the graph
- What features the framework does NOT have?
- autowiring / autoresolving of the dependencies
- the annotations and
@inject-like decorators
- Have a question?
- Open a Github Issue
- Found a bug?
- Open a Github Issue
- Want to help?
- ⭐️ Star the
Dependency Injectoron the Github - 🆕 Start a new project with the
Dependency Injector - 💬 Tell your friend about the
Dependency Injector
- ⭐️ Star the
- Want to contribute?
- 🔀 Fork the project
- ⬅️ Open a pull request to the
developbranch