ets-labs/python-dependency-injector
1
1
Fork 0
mirror of https://github.com/ets-labs/python-dependency-injector.git synced 2024-11-26 11:33:58 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update short description

Browse Source
This commit is contained in:
Roman Mogilatov 2016-10-06 23:15:41 +03:00
parent 8798ea1a56
commit 8e290fb674
1 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.rst
View File

@ -3,8 +3,8 @@ Dependency Injector - Python dependency injection framework
=========================================================== ===========================================================
*Dependency Injector* is a Python dependency injection framework. It was *Dependency Injector* is a Python dependency injection framework. It was
designed to be unified, developer-friendly tool for managing any kind designed to be unified, developer-friendly tool that helps to implement
of Python objects and their dependencies in formal, pretty way. dependency injection pattern in formal, pretty, Pythonic way.
*Dependency Injector* framework key features are: *Dependency Injector* framework key features are:
@ -45,16 +45,22 @@ Status
Installation Installation
------------ ------------
*Dependency Injector* library is available on PyPi_:: *Dependency Injector* library is available on `PyPi`_::
pip install dependency_injector pip install dependency_injector
Example Dependency Injection
------- --------------------
Inversion of control
--------------------
Example of dependency injection
-------------------------------
Brief example below demonstrates usage of *Dependency Injector* containers and Brief example below demonstrates usage of *Dependency Injector* containers and
providers for definition of several IoC containers for some microservice providers for definition of several IoC containers for some microservice
system that consists from several business and platform services: system:
.. code-block:: python .. code-block:: python
@ -110,7 +116,8 @@ system that consists from several business and platform services:
auth_service=Services.auth, auth_service=Services.auth,
photos_service=Services.photos) photos_service=Services.photos)
Next example demonstrates usage of IoC containers & providers defined above: Next example demonstrates run of dependency injection example application
defined above:
.. code-block:: python .. code-block:: python
@ -161,8 +168,8 @@ Next example demonstrates usage of IoC containers & providers defined above:
# User 1 has been successfully authenticated # User 1 has been successfully authenticated
# Photo photo.jpg has been successfully uploaded by user 1 # Photo photo.jpg has been successfully uploaded by user 1
Alternative definition styles Alternative definition styles of providers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Dependecy Injector* supports few other styles of dependency injections *Dependecy Injector* supports few other styles of dependency injections
definition. definition.
@ -174,6 +181,9 @@ IoC containers from previous example could look like these:
class Platform(containers.DeclarativeContainer): class Platform(containers.DeclarativeContainer):
"""IoC container of platform service providers.""" """IoC container of platform service providers."""
logger = providers.Singleton(logging.Logger) \
.add_kwargs(name='example')
database = providers.Singleton(sqlite3.connect) \ database = providers.Singleton(sqlite3.connect) \
.add_args(':memory:') .add_args(':memory:')
@ -188,6 +198,9 @@ or like this these:
class Platform(containers.DeclarativeContainer): class Platform(containers.DeclarativeContainer):
"""IoC container of platform service providers.""" """IoC container of platform service providers."""
logger = providers.Singleton(logging.Logger)
logger.add_kwargs(name='example')
database = providers.Singleton(sqlite3.connect) database = providers.Singleton(sqlite3.connect)
database.add_args(':memory:') database.add_args(':memory:')
@ -195,6 +208,7 @@ or like this these:
s3.add_kwargs(aws_access_key_id='KEY', s3.add_kwargs(aws_access_key_id='KEY',
aws_secret_access_key='SECRET') aws_secret_access_key='SECRET')
You can get more *Dependency Injector* examples in ``/examples`` directory on You can get more *Dependency Injector* examples in ``/examples`` directory on
GitHub: GitHub:
@ -222,7 +236,3 @@ Your feedback is quite important!
.. _PyPi: https://pypi.python.org/pypi/dependency_injector .. _PyPi: https://pypi.python.org/pypi/dependency_injector
.. _User's guide: http://python-dependency-injector.ets-labs.org/en/stable/ .. _User's guide: http://python-dependency-injector.ets-labs.org/en/stable/
.. _API docs: http://python-dependency-injector.ets-labs.org/en/stable/api/ .. _API docs: http://python-dependency-injector.ets-labs.org/en/stable/api/
.. _SLOC: http://en.wikipedia.org/wiki/Source_lines_of_code
.. _SOLID: http://en.wikipedia.org/wiki/SOLID_%28object-oriented_design%29
.. _IoC: http://en.wikipedia.org/wiki/Inversion_of_control
.. _dependency injection: http://en.wikipedia.org/wiki/Dependency_injection