Merge branch 'release/3.41.0' into master

Author: rmk135

docs/examples-other/chained-factories.rst

@@ -0,0 +1,68 @@
+Chained Factories pattern
+=========================
+
+This example demonstrates "Chained Factories" pattern.
+
+The idea of the pattern is in wrapping ``Factory`` into another ``Factory`` that adds
+additional arguments.
+
+.. code-block:: python
+
+ base_factory = providers.Factory(
+ SomeClass,
+ base_argument=1,
+ )
+
+ concrete_factory = providers.Factory(
+ base_factory,
+ extra_argument=2,
+ )
+
+
+ if __name__ == '__main__':
+ instance = concrete_factory()
+ # Same as: # instance = SomeClass(base_argument=1, extra_argument=2)
+
+Sample code
+-----------
+
+Listing of the pattern example:
+
+.. literalinclude:: ../../examples/miniapps/factory-patterns/chained_factories.py
+ :language: python
+
+Arguments priority
+------------------
+
+Passing of the arguments works the same way like for any other :ref:`factory-provider`.
+
+.. code-block:: python
+
+ # 1. Keyword arguments of upper level factory are added to lower level factory
+ chained_dict_factory = providers.Factory(
+ providers.Factory(dict, arg1=1),
+ arg2=2,
+ )
+ print(chained_dict_factory()) # prints: {'arg1': 1, 'arg2': 2}
+
+ # 2. Keyword arguments of upper level factory have priority
+ chained_dict_factory = providers.Factory(
+ providers.Factory(dict, arg1=1),
+ arg1=2,
+ )
+ print(chained_dict_factory()) # prints: {'arg1': 2}
+
+ # 3. Keyword arguments provided from context have the most priority
+ chained_dict_factory = providers.Factory(
+ providers.Factory(dict, arg1=1),
+ arg1=2,
+ )
+ print(chained_dict_factory(arg1=3)) # prints: {'arg1': 3}
+
+
+Credits
+-------
+
+The "Chained Factories" pattern was suggested by the ``Dependency Injector`` users.
+
+.. disqus::

docs/examples-other/chained_factories.rst

@@ -0,0 +1,74 @@
+Factory of Factories pattern
+============================
+
+This example demonstrates "Factory of Factories" pattern.
+
+The idea of the pattern is in creating a ``Factory`` that creates another ``Factory`` and adds
+additional arguments.
+
+.. code-block:: python
+
+ base_factory = providers.Factory(
+ providers.Factory
+ SomeClass,
+ base_argument=1,
+ )
+
+ concrete_factory = providers.Factory(
+ OtherClass,
+ instance=base_factory(extra_argument=1),
+ )
+
+
+ if __name__ == '__main__':
+ instance = concrete_factory()
+ # Same as: # instance = SomeClass(base_argument=1, extra_argument=2)
+
+Sample code
+-----------
+
+Listing of the pattern example:
+
+.. literalinclude:: ../../examples/miniapps/factory-patterns/factory_of_factories.py
+ :language: python
+
+Arguments priority
+------------------
+
+Passing of the arguments works the same way like for any other :ref:`factory-provider`.
+
+.. code-block:: python
+
+ # 1. Keyword arguments of upper level factory are added to lower level factory
+ factory_of_dict_factories = providers.Factory(
+ providers.Factory,
+ dict,
+ arg1=1,
+ )
+ dict_factory = factory_of_dict_factories(arg2=2)
+ print(dict_factory()) # prints: {'arg1': 1, 'arg2': 2}
+
+ # 2. Keyword arguments of upper level factory have priority
+ factory_of_dict_factories = providers.Factory(
+ providers.Factory,
+ dict,
+ arg1=1,
+ )
+ dict_factory = factory_of_dict_factories(arg1=2)
+ print(dict_factory()) # prints: {'arg1': 2}
+
+ # 3. Keyword arguments provided from context have the most priority
+ factory_of_dict_factories = providers.Factory(
+ providers.Factory,
+ dict,
+ arg1=1,
+ )
+ dict_factory = factory_of_dict_factories(arg1=2)
+ print(dict_factory(arg1=3)) # prints: {'arg1': 3}
+
+Credits
+-------
+
+The "Factory of Factories" pattern was suggested by the ``Dependency Injector`` users.
+
+.. disqus::

docs/examples-other/factory-of-factories.rst

@@ -2,18 +2,16 @@ Other examples
 ==============
 
 .. meta::
- :keywords: Python,DI,Dependency injection,IoC,Inversion of Control
- :description: Current section of documentation is designed to provide 
- several example mini applications that are built on the top 
- of inversion of control principle and powered by 
- "Dependency Injector" framework.
+ :keywords: Python,Dependency Injection,Inversion of Control,Container,Example,Application,
+ Framework
+ :description: This sections contains assorted Dependency Injector examples.
 
 This sections contains assorted ``Dependency Injector`` examples.
 
 .. toctree::
  :maxdepth: 2
 
- use_cases_miniapp
- password_hashing_miniapp
- chained_factories
- factory_of_factories
+ use-cases
+ password-hashing
+ chained-factories
+ factory-of-factories

docs/examples-other/factory_of_factories.rst

@@ -0,0 +1,30 @@
+Password hashing example
+========================
+
+.. meta::
+ :keywords: Python,Dependency Injection,Inversion of Control,Container,Example,Application,
+ Framework,Callable
+ :description: This example demonstrates a usage of the Callable provider.
+
+This example demonstrates an injection of the ``Callable`` provider.
+
+The source code is available on the `Github <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/password-hashing>`_.
+
+Sample code
+-----------
+
+Listing of the pattern example:
+
+.. literalinclude:: ../../examples/miniapps/password-hashing/example.py
+ :language: python
+
+Run the example
+---------------
+
+Instructions for running:
+
+.. code-block:: bash
+
+ python example.py
+
+.. disqus::

docs/examples-other/index.rst

@@ -0,0 +1,74 @@
+Use cases example
+=================
+
+.. meta::
+ :keywords: Python,Dependency Injection,Inversion of Control,Container,Example,Application,
+ Framework,DependenciesContainer
+ :description: This example demonstrates a usage of the DependenciesContainer provider.
+
+This example demonstrates a usage of the ``DependenciesContainer`` provider.
+
+The source code is available on the `Github <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/decoupled-packages>`_.
+
+Application structure
+---------------------
+
+Example application has next structure:
+
+.. code-block:: bash
+
+
+ ./
+ └── example/
+ ├── __init__.py
+ ├── __main__.py
+ ├── adapters.py
+ ├── containers.py
+ └── usecases.py
+
+Containers
+----------
+
+Listing of the ``example/containers.py``:
+
+.. literalinclude:: ../../examples/miniapps/use-cases/example/containers.py
+ :language: python
+
+Main module
+-----------
+
+Listing of the ``example/__main__.py``:
+
+.. literalinclude:: ../../examples/miniapps/use-cases/example/__main__.py
+ :language: python
+
+
+Run the application
+-------------------
+
+Instructions for running in the "test" mode:
+
+.. code-block:: bash
+
+ python run.py test example@example.com
+
+Instructions for running in the "prod" mode:
+
+.. code-block:: bash
+
+ python run.py prod example@example.com
+
+Adapters and use cases
+----------------------
+
+Listing of the ``example/adapters.py``:
+
+.. literalinclude:: ../../examples/miniapps/use-cases/example/adapters.py
+ :language: python
+
+Listing of the ``example/usecases.py``:
+
+.. literalinclude:: ../../examples/miniapps/use-cases/example/usecases.py
+ :language: python
+
+.. disqus::

docs/examples-other/password-hashing.rst

@@ -1,3 +1,5 @@
+.. _decoupled-packages:
+
 Decoupled packages example (multiple containers)
 ================================================