ets-labs/python-dependency-injector
1
1
Fork 0
mirror of https://github.com/ets-labs/python-dependency-injector.git synced 2025-11-04 09:57:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update resources docs

Browse Source
This commit is contained in:
Roman Mogylatov 2020-10-23 14:48:41 -04:00
parent 56740fbc59
commit fd9c78c22d
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/providers/resource.rst
View File

@ -48,8 +48,8 @@ Container has an interface to initialize and shutdown all resources:
container.init_resources() container.init_resources()
container.shutdown_resources() container.shutdown_resources()
You also can initialize and shutdown resources using ``init()`` and ``shutdown()`` You also can initialize and shutdown resources one-by-one using ``init()`` and
methods of the provider: ``shutdown()`` methods of the provider:
.. code-block:: python .. code-block:: python
@ -57,7 +57,7 @@ methods of the provider:
container.thread_pool.init() container.thread_pool.init()
container.thread_pool.shutdown() container.thread_pool.shutdown()
Resource provider supports 3 types of resource initializers: Resource provider supports 3 types of initializers:
- Function - Function
- Generator - Generator
@ -82,7 +82,7 @@ Function is the most common way to specify resource initialization:
argument2=..., argument2=...,
) )
Function initializer should not necessarily return a value. This often happens when Function initializer may not return a value. This often happens when
you configure global resource: you configure global resource:
.. code-block:: python .. code-block:: python
@ -153,7 +153,7 @@ object is not mandatory. You can leave ``yield`` statement empty:
Subclass initializer Subclass initializer
-------------------- --------------------
You can provide resource initializer by implementing a subclass of ``resources.Resource``: You can create resource initializer by implementing a subclass of the ``resources.Resource``:
.. code-block:: python .. code-block:: python
@ -178,14 +178,14 @@ You can provide resource initializer by implementing a subclass of ``resources.R
argument2=..., argument2=...,
) )
Subclass must implement two methods: ``.init()`` and ``.shutdown()``. Subclass must implement two methods: ``init()`` and ``shutdown()``.
Method ``.init()`` receives arguments specified in resource provider. Method ``init()`` receives arguments specified in resource provider.
It performs initialization and returns resource object. Returning of the object It performs initialization and returns resource object. Returning of the object
is not mandatory. is not mandatory.
Method ``.shutdown()`` receives resource object returned from ``.init()``. If ``.init()`` Method ``shutdown()`` receives resource object returned from ``init()``. If ``init()``
didn't return an object ``.shutdown()`` method will be called anyway with ``None`` as a didn't return an object ``shutdown()`` method will be called anyway with ``None`` as a
first argument. first argument.
.. code-block:: python .. code-block:: python