python-dependency-injector/docs/providers/coroutine.rst

Coroutine provider
==================

.. meta::
   :keywords: Python,DI,Dependency injection,IoC,Inversion of Control,Coroutine,Asynchronous,
              Asyncio,Example
   :description: Coroutine provider creates a coroutine. This page demonstrates how to use a
                 Coroutine provider.

.. currentmodule:: dependency_injector.providers

:py:class:`Coroutine` provider creates a coroutine.

.. literalinclude:: ../../examples/providers/coroutine.py
   :language: python
   :lines: 3-

.. note::
   The example works on Python 3.7+. For earlier versions use ``loop.run_until_complete()``.

``Coroutine`` provider handles an injection of the dependencies the same way like a
:ref:`factory-provider`.

.. note::
   ``Coroutine`` provider returns ``True`` for ``asyncio.iscoroutinefunction()`` check.

.. disqus::
Providers docs update (#289) * Update callable provider docs * Update coroutine provider docs * Edit object docs * Edit list provider docs * Edit configuration provider docs * Edit selector provider docs * Fix mypy stub of the ``DeclarativeContainer`` to specify the ``__init__`` interface * Edit Dependency provider docs 2020-09-02 04:39:23 +03:00			`Coroutine provider`
Update provider doc page headers 2020-09-03 00:33:02 +03:00			`==================`
Coroutine provider (#206) * Add coroutine provider examples * Add coroutine provier * Update changelog * Update static analysis travis jobs to python 3.7 * Update coroutine provider implementation for python 3.4 * Update static analysis travis jobs to python 3.6 * Make pycode style happy * Add tests for coroutine providers * Make coroutine tests python 2 syntax friendly * Split tests to python2 and python3 * Refactor coroutine provider tests * Modify pypy tests running command * Update coroutine provider docs 2018-10-18 19:39:19 +03:00
Providers docs update (#289) * Update callable provider docs * Update coroutine provider docs * Edit object docs * Edit list provider docs * Edit configuration provider docs * Edit selector provider docs * Fix mypy stub of the ``DeclarativeContainer`` to specify the ``__init__`` interface * Edit Dependency provider docs 2020-09-02 04:39:23 +03:00			`.. meta::`
			`:keywords: Python,DI,Dependency injection,IoC,Inversion of Control,Coroutine,Asynchronous,`
			`Asyncio,Example`
			`:description: Coroutine provider creates a coroutine. This page demonstrates how to use a`
			`Coroutine provider.`
Coroutine provider (#206) * Add coroutine provider examples * Add coroutine provier * Update changelog * Update static analysis travis jobs to python 3.7 * Update coroutine provider implementation for python 3.4 * Update static analysis travis jobs to python 3.6 * Make pycode style happy * Add tests for coroutine providers * Make coroutine tests python 2 syntax friendly * Split tests to python2 and python3 * Refactor coroutine provider tests * Modify pypy tests running command * Update coroutine provider docs 2018-10-18 19:39:19 +03:00
Providers docs update (#289) * Update callable provider docs * Update coroutine provider docs * Edit object docs * Edit list provider docs * Edit configuration provider docs * Edit selector provider docs * Fix mypy stub of the ``DeclarativeContainer`` to specify the ``__init__`` interface * Edit Dependency provider docs 2020-09-02 04:39:23 +03:00			`.. currentmodule:: dependency_injector.providers`
Coroutine provider (#206) * Add coroutine provider examples * Add coroutine provier * Update changelog * Update static analysis travis jobs to python 3.7 * Update coroutine provider implementation for python 3.4 * Update static analysis travis jobs to python 3.6 * Make pycode style happy * Add tests for coroutine providers * Make coroutine tests python 2 syntax friendly * Split tests to python2 and python3 * Refactor coroutine provider tests * Modify pypy tests running command * Update coroutine provider docs 2018-10-18 19:39:19 +03:00
Providers docs update (#289) * Update callable provider docs * Update coroutine provider docs * Edit object docs * Edit list provider docs * Edit configuration provider docs * Edit selector provider docs * Fix mypy stub of the ``DeclarativeContainer`` to specify the ``__init__`` interface * Edit Dependency provider docs 2020-09-02 04:39:23 +03:00			:py:class:`Coroutine` provider creates a coroutine.
Coroutine provider (#206) * Add coroutine provider examples * Add coroutine provier * Update changelog * Update static analysis travis jobs to python 3.7 * Update coroutine provider implementation for python 3.4 * Update static analysis travis jobs to python 3.6 * Make pycode style happy * Add tests for coroutine providers * Make coroutine tests python 2 syntax friendly * Split tests to python2 and python3 * Refactor coroutine provider tests * Modify pypy tests running command * Update coroutine provider docs 2018-10-18 19:39:19 +03:00
Providers docs update (#289) * Update callable provider docs * Update coroutine provider docs * Edit object docs * Edit list provider docs * Edit configuration provider docs * Edit selector provider docs * Fix mypy stub of the ``DeclarativeContainer`` to specify the ``__init__`` interface * Edit Dependency provider docs 2020-09-02 04:39:23 +03:00			`.. literalinclude:: ../../examples/providers/coroutine.py`
Coroutine provider (#206) * Add coroutine provider examples * Add coroutine provier * Update changelog * Update static analysis travis jobs to python 3.7 * Update coroutine provider implementation for python 3.4 * Update static analysis travis jobs to python 3.6 * Make pycode style happy * Add tests for coroutine providers * Make coroutine tests python 2 syntax friendly * Split tests to python2 and python3 * Refactor coroutine provider tests * Modify pypy tests running command * Update coroutine provider docs 2018-10-18 19:39:19 +03:00			`:language: python`
Providers docs update (#289) * Update callable provider docs * Update coroutine provider docs * Edit object docs * Edit list provider docs * Edit configuration provider docs * Edit selector provider docs * Fix mypy stub of the ``DeclarativeContainer`` to specify the ``__init__`` interface * Edit Dependency provider docs 2020-09-02 04:39:23 +03:00			`:lines: 3-`
Coroutine provider (#206) * Add coroutine provider examples * Add coroutine provier * Update changelog * Update static analysis travis jobs to python 3.7 * Update coroutine provider implementation for python 3.4 * Update static analysis travis jobs to python 3.6 * Make pycode style happy * Add tests for coroutine providers * Make coroutine tests python 2 syntax friendly * Split tests to python2 and python3 * Refactor coroutine provider tests * Modify pypy tests running command * Update coroutine provider docs 2018-10-18 19:39:19 +03:00
			`.. note::`
Providers docs update (#289) * Update callable provider docs * Update coroutine provider docs * Edit object docs * Edit list provider docs * Edit configuration provider docs * Edit selector provider docs * Fix mypy stub of the ``DeclarativeContainer`` to specify the ``__init__`` interface * Edit Dependency provider docs 2020-09-02 04:39:23 +03:00			The example works on Python 3.7+. For earlier versions use ``loop.run_until_complete()``.
Coroutine provider (#206) * Add coroutine provider examples * Add coroutine provier * Update changelog * Update static analysis travis jobs to python 3.7 * Update coroutine provider implementation for python 3.4 * Update static analysis travis jobs to python 3.6 * Make pycode style happy * Add tests for coroutine providers * Make coroutine tests python 2 syntax friendly * Split tests to python2 and python3 * Refactor coroutine provider tests * Modify pypy tests running command * Update coroutine provider docs 2018-10-18 19:39:19 +03:00
Providers docs update (#289) * Update callable provider docs * Update coroutine provider docs * Edit object docs * Edit list provider docs * Edit configuration provider docs * Edit selector provider docs * Fix mypy stub of the ``DeclarativeContainer`` to specify the ``__init__`` interface * Edit Dependency provider docs 2020-09-02 04:39:23 +03:00			``Coroutine`` provider handles an injection of the dependencies the same way like a
			:ref:`factory-provider`.
Coroutine provider (#206) * Add coroutine provider examples * Add coroutine provier * Update changelog * Update static analysis travis jobs to python 3.7 * Update coroutine provider implementation for python 3.4 * Update static analysis travis jobs to python 3.6 * Make pycode style happy * Add tests for coroutine providers * Make coroutine tests python 2 syntax friendly * Split tests to python2 and python3 * Refactor coroutine provider tests * Modify pypy tests running command * Update coroutine provider docs 2018-10-18 19:39:19 +03:00
Providers docs update (#289) * Update callable provider docs * Update coroutine provider docs * Edit object docs * Edit list provider docs * Edit configuration provider docs * Edit selector provider docs * Fix mypy stub of the ``DeclarativeContainer`` to specify the ``__init__`` interface * Edit Dependency provider docs 2020-09-02 04:39:23 +03:00			`.. note::`
			``Coroutine`` provider returns ``True`` for ``asyncio.iscoroutinefunction()`` check.
Coroutine provider (#206) * Add coroutine provider examples * Add coroutine provier * Update changelog * Update static analysis travis jobs to python 3.7 * Update coroutine provider implementation for python 3.4 * Update static analysis travis jobs to python 3.6 * Make pycode style happy * Add tests for coroutine providers * Make coroutine tests python 2 syntax friendly * Split tests to python2 and python3 * Refactor coroutine provider tests * Modify pypy tests running command * Update coroutine provider docs 2018-10-18 19:39:19 +03:00
			`.. disqus::`