Merge branch 'release/4.36.0' into master

Author: rmk135

.coveragerc

@@ -3,5 +3,8 @@ source = src/dependency_injector
 omit = tests/unit
 plugins = Cython.Coverage
 
+[report]
+show_missing = true
+
 [html]
 directory=reports/unittests/

CONTRIBUTORS.rst

@@ -18,3 +18,5 @@ Dependency Injector Contributors
 + Shubhendra Singh Chauhan (withshubh)
 + sonthonaxrk (sonthonaxrk)
 + Ngo Thanh Loi (Leonn) (loingo95)
++ Thiago Hiromi (thiromi)
++ Felipe Rubio (krouw)

docs/main/changelog.rst

@@ -7,12 +7,32 @@ that were made in every particular version.
 From version 0.7.6 *Dependency Injector* framework strictly 
 follows `Semantic versioning`_
 
-4.35.3
-------
+4.36.0
+------
+- Add support of non-string keys for ``FactoryAggregate`` provider.
+- Improve ``FactoryAggregate`` typing stub.
+- Improve resource subclasses typing and make shutdown definition optional
+  `PR #492 <https://github.com/ets-labs/python-dependency-injector/pull/492>`_.
+  Thanks to `@EdwardBlair <https://github.com/EdwardBlair>`_  for suggesting the improvement.
+- Fix type annotations for ``.provides``.
+  Thanks to `Thiago Hiromi @thiromi <https://github.com/thiromi>`_ for the fix
+  `PR #491 <https://github.com/ets-labs/python-dependency-injector/pull/491>`_.
+- Fix environment variables interpolation examples in configuration provider docs ``{$ENV} -> ${ENV}``.
+  Thanks to `Felipe Rubio @krouw <https://github.com/krouw>`_ for reporting the issue and
+  fixing yaml example `PR #494 <https://github.com/ets-labs/python-dependency-injector/pull/494>`_.
 - Fix ``@containers.copy()`` decorator to respect dependencies on parent providers.
   See issue `#477 <https://github.com/ets-labs/python-dependency-injector/issues/477>`_.
   Thanks to `Andrey Torsunov @gtors <https://github.com/gtors>`_  for reporting the issue.
 - Fix typing stub for ``container.override_providers()`` to accept other types besides ``Provider``.
+- Fix runtime issue with generic typing in resource initializer classes ``resources.Resource``
+  and ``resources.AsyncResource``.
+  See issue `#488 <https://github.com/ets-labs/python-dependency-injector/issues/488>`_.
+  Thanks to `@EdwardBlair <https://github.com/EdwardBlair>`_  for reporting the issue.
+
+4.35.3
+------
+- *This release was removed from PyPI. It was inconsistently published because project has
+  reached a PyPI size limit. Changes from this release are published on PyPI in next version.*
 
 4.35.2
 ------

docs/providers/configuration.rst

@@ -50,9 +50,9 @@ where ``examples/providers/configuration/config.ini`` is:
 .. code-block:: ini
 
    [section]
-   option1 = {$ENV_VAR}
-   option2 = {$ENV_VAR}/path
-   option3 = {$ENV_VAR:default}
+   option1 = ${ENV_VAR}
+   option2 = ${ENV_VAR}/path
+   option3 = ${ENV_VAR:default}
 
 See also: :ref:`configuration-envs-interpolation`.
 
@@ -77,9 +77,9 @@ where ``examples/providers/configuration/config.yml`` is:
 .. code-block:: ini
 
    section:
-     option1: {$ENV_VAR}
-     option2: {$ENV_VAR}/path
-     option3: {$ENV_VAR:default}
+     option1: ${ENV_VAR}
+     option2: ${ENV_VAR}/path
+     option3: ${ENV_VAR:default}
 
 See also: :ref:`configuration-envs-interpolation`.
 
@@ -208,7 +208,7 @@ variable ``ENV_NAME`` is undefined, configuration provider will substitute value
 .. code-block:: ini
 
    [section]
-   option = {$ENV_NAME:default}
+   option = ${ENV_NAME:default}
 
 If you'd like to specify a default value for environment variable inside of the application you can use
 ``os.environ.setdefault()``.
@@ -380,7 +380,7 @@ an undefined environment variable without a default value.
 .. code-block:: ini
 
    section:
-     option: {$UNDEFINED}
+     option: ${UNDEFINED}
 
 .. code-block:: python
 

docs/providers/factory.rst

@@ -148,13 +148,11 @@ provider with two peculiarities:
 Factory aggregate
 -----------------
 
-:py:class:`FactoryAggregate` provider aggregates multiple factories. When you call the
-``FactoryAggregate`` it delegates the call to one of the factories.
+:py:class:`FactoryAggregate` provider aggregates multiple factories.
 
-The aggregated factories are associated with the string names. When you call the
-``FactoryAggregate`` you have to provide one of the these names as a first argument.
-``FactoryAggregate`` looks for the factory with a matching name and delegates it the work. The
-rest of the arguments are passed to the delegated ``Factory``.
+The aggregated factories are associated with the string keys. When you call the
+``FactoryAggregate`` you have to provide one of the these keys as a first argument.
+``FactoryAggregate`` looks for the factory with a matching key and calls it with the rest of the arguments.
 
 .. image:: images/factory_aggregate.png
     :width: 100%
@@ -165,17 +163,35 @@ rest of the arguments are passed to the delegated ``Factory``.
    :lines: 3-
    :emphasize-lines: 33-37,47
 
-You can get a dictionary of the aggregated factories using the ``.factories`` attribute of the
-``FactoryAggregate``. To get a game factories dictionary from the previous example you can use
+You can get a dictionary of the aggregated factories using the ``.factories`` attribute.
+To get a game factories dictionary from the previous example you can use
 ``game_factory.factories`` attribute.
 
 You can also access an aggregated factory as an attribute. To create the ``Chess`` object from the
-previous example you can do ``chess = game_factory.chess('John', 'Jane')``.
+previous example you can do ``chess = game_factory.chess("John", "Jane")``.
 
 .. note::
    You can not override the ``FactoryAggregate`` provider.
 
 .. note::
    When you inject the ``FactoryAggregate`` provider it is passed "as is".
 
+To use non-string keys or keys with ``.`` and ``-`` you can provide a dictionary as a positional argument:
+
+.. code-block:: python
+
+   providers.FactoryAggregate({
+       SomeClass: providers.Factory(...),
+       "key.with.periods": providers.Factory(...),
+       "key-with-dashes": providers.Factory(...),
+   })
+
+Example:
+
+.. literalinclude:: ../../examples/providers/factory_aggregate_non_string_keys.py
+   :language: python
+   :lines: 3-
+   :emphasize-lines: 30-33,39-40
+
+
 .. disqus::

examples/providers/factory_aggregate_non_string_keys.py

@@ -0,0 +1,45 @@
+"""`FactoryAggregate` provider with non-string keys example."""
+
+from dependency_injector import containers, providers
+
+
+class Command:
+    ...
+
+
+class CommandA(Command):
+    ...
+
+
+class CommandB(Command):
+    ...
+
+
+class Handler:
+    ...
+
+
+class HandlerA(Handler):
+    ...
+
+
+class HandlerB(Handler):
+    ...
+
+
+class Container(containers.DeclarativeContainer):
+
+    handler_factory = providers.FactoryAggregate({
+        CommandA: providers.Factory(HandlerA),
+        CommandB: providers.Factory(HandlerB),
+    })
+
+
+if __name__ == "__main__":
+    container = Container()
+
+    handler_a = container.handler_factory(CommandA)
+    handler_b = container.handler_factory(CommandB)
+
+    assert isinstance(handler_a, HandlerA)
+    assert isinstance(handler_b, HandlerB)

src/dependency_injector/__init__.py

@@ -1,6 +1,6 @@
 """Top-level package."""
 
-__version__ = '4.35.3'
+__version__ = '4.36.0'
 """Version number.
 
 :type: str