mirror of
https://github.com/ets-labs/python-dependency-injector.git
synced 2024-11-22 09:36:48 +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
99 lines
2.8 KiB
ReStructuredText
99 lines
2.8 KiB
ReStructuredText
.. _fastapi-redis-example:
|
|
|
|
FastAPI + Redis example
|
|
=======================
|
|
|
|
.. meta::
|
|
:keywords: Python,Dependency Injection,FastAPI,Redis,Example
|
|
:description: This example demonstrates a usage of the FastAPI, Redis, and Dependency Injector.
|
|
|
|
This example shows how to use ``Dependency Injector`` with `FastAPI <https://fastapi.tiangolo.com/>`_ and
|
|
`Redis <https://redis.io/>`_.
|
|
|
|
The source code is available on the `Github <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/fastapi-redis>`_.
|
|
|
|
See also:
|
|
|
|
- Provider :ref:`async-injections`
|
|
- Resource provider :ref:`resource-async-initializers`
|
|
- Wiring :ref:`async-injections-wiring`
|
|
|
|
Application structure
|
|
---------------------
|
|
|
|
Application has next structure:
|
|
|
|
.. code-block:: bash
|
|
|
|
./
|
|
├── fastapiredis/
|
|
│ ├── __init__.py
|
|
│ ├── application.py
|
|
│ ├── containers.py
|
|
│ ├── redis.py
|
|
│ ├── services.py
|
|
│ └── tests.py
|
|
├── docker-compose.yml
|
|
├── Dockerfile
|
|
└── requirements.txt
|
|
|
|
Redis
|
|
-----
|
|
|
|
Module ``redis`` defines Redis connection pool initialization and shutdown. See ``fastapiredis/redis.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/fastapi-redis/fastapiredis/redis.py
|
|
:language: python
|
|
|
|
Service
|
|
-------
|
|
|
|
Module ``services`` contains example service. Service has a dependency on Redis connection pool.
|
|
It uses it for getting and setting a key asynchronously. Real life service will do something more meaningful.
|
|
See ``fastapiredis/services.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/fastapi-redis/fastapiredis/services.py
|
|
:language: python
|
|
|
|
Container
|
|
---------
|
|
|
|
Declarative container wires example service with Redis connection pool. See ``fastapiredis/containers.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/fastapi-redis/fastapiredis/containers.py
|
|
:language: python
|
|
|
|
Application
|
|
-----------
|
|
|
|
Module ``application`` creates ``FastAPI`` app, setup endpoint, and init container.
|
|
|
|
Endpoint ``index`` has a dependency on example service. The dependency is injected using :ref:`wiring` feature.
|
|
|
|
Listing of ``fastapiredis/application.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/fastapi-redis/fastapiredis/application.py
|
|
:language: python
|
|
|
|
Tests
|
|
-----
|
|
|
|
Tests use :ref:`provider-overriding` feature to replace example service with a mock. See ``fastapiredis/tests.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/fastapi-redis/fastapiredis/tests.py
|
|
:language: python
|
|
:emphasize-lines: 24
|
|
|
|
Sources
|
|
-------
|
|
|
|
The source code is available on the `Github <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/fastapi-redis>`_.
|
|
|
|
See also:
|
|
|
|
- Provider :ref:`async-injections`
|
|
- Resource provider :ref:`resource-async-initializers`
|
|
- Wiring :ref:`async-injections-wiring`
|
|
|
|
.. disqus::
|