Dependency Injector — Dependency injection framework for Python — Dependency Injector 4.46.0 documentation (original) (raw)

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, Dict, Configuration, Resource, Dependency, and Selector providers that help assemble 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. SeeProvider overriding.
• Configuration. Reads configuration from yaml, ini, and json files, pydantic settings, environment variables, and dictionaries. See Configuration provider.
• Resources. Helps with initialization and configuring of logging, event loop, thread or process pool, etc. Can be used for per-function execution scope in tandem with wiring. See Resource provider.
• Containers. Provides declarative and dynamic containers. See Containers.
• Wiring. Injects dependencies into functions and methods. Helps integrate with other frameworks: Django, Flask, Aiohttp, Sanic, FastAPI, etc. See Wiring.
• Asynchronous. Supports asynchronous injections. See Asynchronous injections.
• Typing. Provides typing stubs, mypy-friendly. See Typing and mypy.
• Performance. Fast. Written in Cython.
• Maturity. Mature and production-ready. Well-tested, documented, and supported.

from dependency_injector import containers, providers from dependency_injector.wiring import Provide, inject

class Container(containers.DeclarativeContainer):

config = providers.Configuration()

api_client = providers.Singleton(
    ApiClient,
    api_key=config.api_key,
    timeout=config.timeout,
)

service = providers.Factory(
    Service,
    api_client=api_client,
)

@inject def main(service: Service = Provide[Container.service]) -> None: ...

if name == "main": container = Container() container.config.api_key.from_env("API_KEY", required=True) container.config.timeout.from_env("TIMEOUT", as_=int, default=5) container.wire(modules=[name])

main()  # <-- dependency is injected automatically

with container.api_client.override(mock.Mock()):
    main()  # <-- overridden dependency is injected automatically

With the Dependency Injector, object assembling is consolidated in the container. Dependency injections are defined explicitly. This makes it easier to understand and change how the application works.

Explore the documentation to know more about the Dependency Injector.

Contents¶

• Introduction
  • Dependency injection and inversion of control in Python
  • Key features
  • Installation
• Examples
  • Application example (single container)
  • Application example (multiple containers)
  • Decoupled packages example (multiple containers)
  • Boto3 example
  • Django example
  • Flask example
  • Flask blueprints example
  • Aiohttp example
  • Sanic example
  • FastAPI example
  • FastAPI + Redis example
  • FastAPI + SQLAlchemy example
• Tutorials
  • Flask tutorial
  • Aiohttp tutorial
  • Asyncio daemon tutorial
  • CLI application tutorial
• Providers
  • Factory provider
  • Singleton provider
  • Callable provider
  • Coroutine provider
  • Object provider
  • List provider
  • Dict provider
  • Configuration provider
  • Resource provider
  • Aggregate provider
  • Selector provider
  • Dependency provider
  • Provider overriding
  • Injecting provided object attributes, items, or call its methods
  • Injecting container “self”
  • Creating a custom provider
  • Asynchronous injections
  • Typing and mypy
• Containers
  • Declarative container
  • Dynamic container
  • Specialization of the container provider type
  • Container overriding
  • Container copying
  • Reset container singletons
  • Check container dependencies
  • Container providers traversal
• Wiring
  • Decorator @inject
  • Markers
  • String identifiers
  • Making injections into modules and class attributes
  • Wiring with modules and packages
  • Wiring configuration
  • Asynchronous injections
  • Wiring of dynamically imported modules
  • Integration with other frameworks
• Other examples
  • Use cases example
  • Password hashing example
  • Chained Factories pattern
  • Factory of Factories pattern
• API Documentation
  • dependency_injector
  • dependency_injector.providers
  • dependency_injector.containers
  • dependency_injector.wiring
  • dependency_injector.errors
• Feedback
• Changelog
  • 4.46.0
  • 4.45.0
  • 4.44.0
  • 4.43.0
  • 4.42.0
  • 4.42.0b1
  • 4.41.0
  • 4.40.0
  • 4.39.1
  • 4.39.0
  • 4.38.0
  • 4.37.0
  • 4.36.2
  • 4.36.1
  • 4.36.0
  • 4.35.3
  • 4.35.2
  • 4.35.1
  • 4.35.0
  • 4.34.2
  • 4.34.1
  • 4.34.0
  • 4.33.0
  • 4.32.3
  • 4.32.2
  • 4.32.1
  • 4.32.0
  • 4.31.2
  • 4.31.1
  • 4.31.0
  • 4.30.0
  • 4.29.2
  • 4.29.1
  • 4.29.0
  • 4.28.1
  • 4.28.0
  • 4.27.0
  • 4.26.0
  • 4.25.1
  • 4.25.0
  • 4.24.0
  • 4.23.5
  • 4.23.4
  • 4.23.3
  • 4.23.2
  • 4.23.1
  • 4.23.0
  • 4.22.1
  • 4.22.0
  • 4.21.0
  • 4.20.2
  • 4.20.1
  • 4.20.0
  • 4.19.0
  • 4.18.0
  • 4.17.0
  • 4.16.0
  • 4.15.0
  • 4.14.0
  • 4.13.2
  • 4.13.1
  • 4.13.0
  • 4.12.0
  • 4.11.3
  • 4.11.2
  • 4.11.1
  • 4.11.0
  • 4.10.3
  • 4.10.2
  • 4.10.1
  • 4.10.0
  • 4.9.1
  • 4.9.0
  • 4.8.3
  • 4.8.2
  • 4.8.1
  • 4.8.0
  • 4.7.0
  • 4.6.1
  • 4.6.0
  • 4.5.4
  • 4.5.3
  • 4.5.2
  • 4.5.1
  • 4.5.0
  • 4.4.1
  • 4.4.0
  • 4.3.9
  • 4.3.8
  • 4.3.7
  • 4.3.6
  • 4.3.5
  • 4.3.4
  • 4.3.3
  • 4.3.2
  • 4.3.1
  • 4.3.0
  • 4.2.0
  • 4.1.8
  • 4.1.7
  • 4.1.6
  • 4.1.5
  • 4.1.4
  • 4.1.3
  • 4.1.2
  • 4.1.1
  • 4.1.0
  • 4.0.6
  • 4.0.5
  • 4.0.4
  • 4.0.3
  • 4.0.2
  • 4.0.1
  • 4.0.0
  • 3.44.0
  • 3.43.1
  • 3.43.0
  • 3.42.0
  • 3.41.0
  • 3.40.0
  • 3.39.0
  • 3.38.1
  • 3.38.0
  • 3.37.0
  • 3.36.0
  • 3.35.1
  • 3.35.0
  • 3.34.0
  • 3.33.0
  • 3.32.3
  • 3.32.2
  • 3.32.1
  • 3.32.0
  • 3.31.0
  • 3.30.4
  • 3.30.3
  • 3.30.2
  • 3.30.1
  • 3.30.0
  • 3.29.0
  • 3.28.1
  • 3.28.0
  • 3.27.0
  • 3.26.0
  • 3.25.1
  • 3.25.0
  • 3.24.1
  • 3.24.0
  • 3.23.2
  • 3.23.1
  • 3.23.0
  • 3.22.0
  • 3.21.2
  • 3.21.1
  • 3.21.0
  • 3.20.1
  • 3.20.0
  • 3.19.2
  • 3.19.1
  • 3.19.0
  • 3.18.1
  • 3.18.0
  • 3.17.1
  • 3.17.0
  • 3.16.1
  • 3.16.0
  • 3.15.6
  • 3.15.5
  • 3.15.4
  • 3.15.3
  • 3.15.2
  • 3.15.1
  • 3.15.0
  • 3.14.12
  • 3.14.11
  • 3.14.10
  • 3.14.9
  • 3.14.8
  • 3.14.7
  • 3.14.6
  • 3.14.5
  • 3.14.4
  • 3.14.3
  • 3.14.2
  • 3.14.1
  • 3.14.0
  • 3.13.2
  • 3.13.1
  • 3.13.0
  • 3.12.4
  • 3.12.3
  • 3.12.2
  • 3.12.1
  • 3.12.0
  • 3.11.3
  • 3.11.2
  • 3.11.1
  • 3.11.0
  • 3.10.0
  • 3.9.1
  • 3.9.0
  • 3.8.2
  • 3.8.1
  • 3.8.0
  • 3.7.1
  • 3.7.0
  • 3.6.1
  • 3.6.0
  • 3.5.0
  • 3.4.8
  • 3.4.7
  • 3.4.6
  • 3.4.5
  • 3.4.4
  • 3.4.3
  • 3.4.2
  • 3.4.1
  • 3.4.0
  • 3.3.7
  • 3.3.6
  • 3.3.5
  • 3.3.4
  • 3.3.3
  • 3.3.2
  • 3.3.1
  • 3.3.0
  • 3.2.5
  • 3.2.4
  • 3.2.3
  • 3.2.2
  • 3.2.1
  • 3.2.0
  • 3.1.5
  • 3.1.4
  • 3.1.3
  • 3.1.2
  • 3.1.1
  • 3.1.0
  • 3.0.1
  • 3.0.0
  • 2.2.10
  • 2.2.9
  • 2.2.8
  • 2.2.7
  • 2.2.6
  • 2.2.5
  • 2.2.4
  • 2.2.3
  • 2.2.2
  • 2.2.1
  • 2.2.0
  • 2.1.1
  • 2.1.0
  • 2.0.0
  • 1.17.0
  • 1.16.8
  • 1.16.7
  • 1.16.5
  • 1.16.4
  • 1.16.1
  • 1.15.2
  • 1.15.1
  • 1.15.0
  • 1.14.11
  • 1.14.10
  • 1.14.9
  • 1.14.8
  • 1.14.7
  • 1.14.6
  • 1.14.5
  • 1.14.4
  • 1.14.3
  • 1.14.2
  • 1.14.1
  • 1.14.0
  • 1.13.2
  • 1.13.1
  • 1.13.0
  • 1.12.0
  • 1.11.2
  • 1.11.1
  • 0.11.0
  • 0.10.5
  • 0.10.4
  • 0.10.3
  • 0.10.2
  • 0.10.1
  • 0.10.0
  • 0.9.5
  • 0.9.4
  • 0.9.3
  • 0.9.2
  • 0.9.1
  • 0.8.1
  • 0.7.8
  • 0.7.7
  • 0.7.6
  • Previous versions