74 lines
2.4 KiB
ReStructuredText
74 lines
2.4 KiB
ReStructuredText
Singleton providers
|
|
-------------------
|
|
|
|
``di.Singleton`` provider creates new instance of specified class on first call
|
|
and returns same instance on every next call.
|
|
|
|
Example:
|
|
|
|
.. image:: /images/providers/singleton.png
|
|
:width: 80%
|
|
:align: center
|
|
|
|
.. literalinclude:: ../../examples/providers/singleton.py
|
|
:language: python
|
|
|
|
Singleton providers and injections
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
``di.Singleton`` providers use ``di.Factory`` providers for first creation of
|
|
specified class instance, so, all of the rules about injections are the same,
|
|
as for ``di.Factory`` providers.
|
|
|
|
.. image:: /images/providers/singleton_internals.png
|
|
:width: 80%
|
|
:align: center
|
|
|
|
.. note::
|
|
|
|
Due that ``di.Singleton`` provider creates specified class instance only on
|
|
the first call, all injections are done once, during the first call, also.
|
|
Every next call, while instance has been already created and memorized, no
|
|
injections are done, ``di.Singleton`` provider just returns memorized
|
|
earlier instance.
|
|
|
|
This may cause some problems, for example, in case of trying to bind
|
|
``di.Factory`` provider with ``di.Singleton`` provider (provided by
|
|
dependent ``di.Factory`` instance will be injected only once, during the
|
|
first call). Be aware that such behaviour was made with opened eyes and is
|
|
not a bug.
|
|
|
|
By the way, in such case, ``di.Delegate`` provider can be useful. It makes
|
|
possible to inject providers *as is*. Please check out full example in
|
|
*Providers delegation* section.
|
|
|
|
Singleton providers resetting
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Created and memorized by ``di.Singleton`` instance can be reset. Reset of
|
|
``di.Singleton``'s memorized instance is done by clearing reference to it.
|
|
Further lifecycle of memorized instance is out of ``di.Singleton`` provider's
|
|
control.
|
|
|
|
Example:
|
|
|
|
.. literalinclude:: ../../examples/providers/singleton_reseting.py
|
|
:language: python
|
|
|
|
Singleton providers delegation
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
``di.Singleton`` provider could be delegated to any other provider via any
|
|
kind of injection. Delegation of ``di.Singleton`` providers is the same as
|
|
``di.Factory`` providers delegation, please follow
|
|
*Factory providers delegation* section for example.
|
|
|
|
``di.Singleton`` delegate could be created obviously using
|
|
``di.Delegate(di.Singleton())`` or by calling ``di.Singleton.delegate()``
|
|
method.
|
|
|
|
Example:
|
|
|
|
.. literalinclude:: ../../examples/providers/singleton_delegation.py
|
|
:language: python
|