Skip to content

Commit a85d89e

Browse files
committed
Amend docs and add another example for @containers.copy() decorator
1 parent 6a73b9d commit a85d89e

File tree

3 files changed

+43
-1
lines changed

3 files changed

+43
-1
lines changed

docs/containers/copying.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,21 @@ Container copying
33

44
You can create declarative container copies using ``@containers.copy()`` decorator.
55

6-
.. literalinclude:: ../../examples/containers/declarative_copy_decorator.py
6+
.. literalinclude:: ../../examples/containers/declarative_copy_decorator1.py
77
:language: python
88
:lines: 3-
99
:emphasize-lines: 18-22
1010

1111
Decorator ``@containers.copy()`` copies providers from source container to destination container.
1212
Destination container provider will replace source provider, if names match.
1313

14+
Decorator ``@containers.copy()`` helps you when you create derived declarative containers
15+
from the base one. Base container often keeps default dependencies while derived containers define
16+
overriding providers. Without ``@containers.copy()`` decorator, overridden providers are available
17+
in the derived container, but base class dependencies continue to be bound to the base class providers.
18+
19+
.. literalinclude:: ../../examples/containers/declarative_copy_decorator2.py
20+
:language: python
21+
:lines: 11-
22+
1423
.. disqus::
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
"""Declarative container provider copying with ``@copy()`` decorator."""
2+
3+
from dependency_injector import containers, providers
4+
5+
6+
class Service:
7+
def __init__(self, dependency: str):
8+
self.dependency = dependency
9+
10+
11+
class Base(containers.DeclarativeContainer):
12+
dependency = providers.Dependency(instance_of=str, default='Default value')
13+
service = providers.Factory(Service, dependency=dependency)
14+
15+
16+
@containers.copy(Base)
17+
class Derived1(Base):
18+
dependency = providers.Dependency(instance_of=str, default='Derived 1')
19+
20+
21+
# @containers.copy(Base) # <-- No @copy decorator
22+
class Derived2(Base):
23+
dependency = providers.Dependency(instance_of=str, default='Derived 2')
24+
25+
26+
if __name__ == '__main__':
27+
container1 = Derived1()
28+
service1 = container1.service()
29+
print(service1.dependency) # Derived 1
30+
31+
container2 = Derived2()
32+
service2 = container2.service()
33+
print(service2.dependency) # Default value

0 commit comments

Comments
 (0)