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

Dependency provider
===================

.. currentmodule:: dependency_injector.providers

:py:class:`Dependency` provider is a placeholder for the dependency of the specified type.

The first argument of the ``Dependency`` provider specifies a type of the dependency. It is
called ``instance_of``. ``Dependency`` provider controls the type of the returned object to be an
instance of the ``instance_of`` type.

The ``Dependency`` provider must be overridden before usage. It can be overridden by any type of
the provider. The only rule is that overriding provider must return an instance of ``instance_of``
dependency type.

.. literalinclude:: ../../examples/providers/dependency.py
   :language: python
   :lines: 3-
   :emphasize-lines: 26

.. 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			`Dependency provider`
Update provider doc page headers 2020-09-03 00:33:02 +03:00			`===================`
Minor ExternalDependency provider updates, Adding ExternalDependency provider docs 2015-06-18 16:34:26 +03:00
Fix module API references in docs 2015-11-30 00:30:48 +03:00			`.. currentmodule:: dependency_injector.providers`
Update external dependency provider docs, including API, and examples 2015-11-23 17:48:21 +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:`Dependency` provider is a placeholder for the dependency of the specified type.
Minor ExternalDependency provider updates, Adding ExternalDependency provider docs 2015-06-18 16:34:26 +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			The first argument of the ``Dependency`` provider specifies a type of the dependency. It is
			called ``instance_of``. ``Dependency`` provider controls the type of the returned object to be an
			instance of the ``instance_of`` type.
Minor ExternalDependency provider updates, Adding ExternalDependency provider docs 2015-06-18 16:34:26 +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			The ``Dependency`` provider must be overridden before usage. It can be overridden by any type of
			the provider. The only rule is that overriding provider must return an instance of ``instance_of``
			`dependency type.`
Minor ExternalDependency provider updates, Adding ExternalDependency provider docs 2015-06-18 16:34:26 +03:00
Update docs & examples 2017-12-21 23:54:44 +03:00			`.. literalinclude:: ../../examples/providers/dependency.py`
Replacing ExternalDependeny provider examples in documentation with literalinclude 2015-08-03 15:45:58 +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-`
			`:emphasize-lines: 26`
Add disqus comments for provider documents 2017-02-28 23:07:12 +03:00
			`.. disqus::`