mirror of
https://github.com/ets-labs/python-dependency-injector.git
synced 2024-11-22 17:47:02 +03:00
feed916f46
* Add support of async injections into wiring * Add support of async functions and async generators for resources * Update resource provider typing stub for stutdown * Add resource base class for async resources * Fix tests * Add tests for async injections in wiring @inject * Refactor provider tests * Add tests for async resources * Rework async resources callbacks to .add_done_callback() style (fixes pypy3 issue) * Add awaits into async resource class test * Refactor FastAPI tests * Implement async resources initialization in container * Move container async resource tests to a separate module for Python 3.6+ * Fix init async resources in container on Python 2 * Add first dirty async injections implementation * Fix isawaitable error * Turm asyncio import to conditional for safer Py2 usage * Refactor kwargs injections * Implement positional injections, add tests and make refactoring * Implement attribute injections and add tests * Add singleton implementation + tests for all singleton types * Implement injections in thread-local and thread-safe singleton providers * Update .provided + fix resource concurent initialization issue * Implement async mode for Dependency provider * Add async mode for the provider * Add overload for Factory typing * Add typing stubs for async resource * Refactor abstract* providers __call__() * Add async mode API + tests * Add typing stubs & tests for async mode API * Add tests for async mode auto configuration * Refactor Provider.__call__() to use async mode api * Refactor Dependency provider to use async mode api * Add tests for Dependency provider async mode * Add support of async mode for FactoryAggregate provider + tests * Refactor Singleton provider to use async mode api * Refactor ThreadSafeSingleton provider to use async mode api * Refactor ThreadLocalSingleton provider to use async mode api * Finish Singleton refactoring to use async mode api * Refactor Resource provider to use async mode api * Add Provider.async_() method + tests * Add typing stubs for async_() method + tests * Refactor Singleton typing stubs to return singleton from argument methods * Refactor provider typing stubs * Improve resource typing stub * Add tests for async context kwargs injections * Fix typo in resource provider tests * Cover shutdown of not initialized resource * Add test to cover resource initialization with an error * Fix Singleton and ThreadLocalSingleton to handle initialization errors * Add FastAPI + Redis example * Make cosmetic fixes to FastAPI + Redis example * Add missing development requirements * Update module docblock in fastapi + redis example * Add FastAPI + Redis example docs * Add references to FastAPI + Redis example * Refactor resource docs * Add asynchronous resources docs * Refactor wiring docs * Add async injections docs for wiring * Add async injections page and update docs index, readme, and key features pages * Add providers async injections example * Add docs on provider async mode enabling * Reword async provider docs * Add provider async mode docs * Add cross links to async docs * Mute flake8 errors in async provider examples * Update changelog * Make cosmetic fix to containers.pyx
56 lines
1.4 KiB
ReStructuredText
56 lines
1.4 KiB
ReStructuredText
.. _providers:
|
|
|
|
Providers
|
|
=========
|
|
|
|
Providers help to assemble the objects. They create objects and inject the dependencies.
|
|
|
|
Each provider is a callable. You call the provider like a function when you need to create an
|
|
object. Provider retrieves the underlying dependencies and inject them into the created object.
|
|
It causes the cascade effect that helps to assemble object graphs. See ``Factory``, ``Singleton``,
|
|
``Callable`` and other provider docs below.
|
|
|
|
.. code-block:: bash
|
|
|
|
provider1()
|
|
│
|
|
├──> provider2()
|
|
│
|
|
├──> provider3()
|
|
│ │
|
|
│ └──> provider4()
|
|
│
|
|
└──> provider5()
|
|
│
|
|
└──> provider6()
|
|
|
|
Another providers feature is an overriding. You can override any provider with another provider.
|
|
This helps in testing. This also helps in overriding API clients with stubs for the development
|
|
or staging environment. See the example at :ref:`provider-overriding`.
|
|
|
|
If you need to inject not the whole object but the parts see :ref:`provided-instance`.
|
|
|
|
To create a new provider see :ref:`create-provider`.
|
|
|
|
Providers module API docs - :py:mod:`dependency_injector.providers`
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
factory
|
|
singleton
|
|
callable
|
|
coroutine
|
|
object
|
|
list
|
|
dict
|
|
configuration
|
|
resource
|
|
selector
|
|
dependency
|
|
overriding
|
|
provided_instance
|
|
custom
|
|
async
|
|
typing_mypy
|