Rooba
/
python-dependency-injector
mirror of https://github.com/ets-labs/python-dependency-injector.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
python-dependency-injector/docs/providers/configuration.rst

164 lines
5.3 KiB
ReStructuredText
Raw Normal View History

Update key features page and remove structure page
2020-09-03 20:19:40 +00:00
.. _configuration-provider:
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 01:39:23 +00:00
Configuration provider
Update provider doc page headers
2020-09-02 21:33:02 +00: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 01:39:23 +00:00
.. meta::
:keywords: Python,DI,Dependency injection,IoC,Inversion of Control,Configuration,Injection,
Option,Ini,Json,Yaml,Dict,Environment Variable,Load,Read,Get
:description: Configuration provides configuration options to the other providers. This page
demonstrates how to use Configuration provider to inject the dependencies, load
a configuration from an ini or yaml file, dictionary or an environment variable.
Add configuration provider docs
2020-06-25 21:12:16 +00:00
.. currentmodule:: dependency_injector.providers
:py:class:`Configuration` provider provides configuration options to the other providers.
.. literalinclude:: ../../examples/providers/configuration/configuration.py
:language: python
Add usage of the container to the configuration examples
2020-09-03 21:37:03 +00:00
:emphasize-lines: 7,12-13
:lines: 3-
Add configuration provider docs
2020-06-25 21:12:16 +00: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 01:39:23 +00:00
It implements the principle "use first, define later".
Add configuration provider docs
2020-06-25 21:12:16 +00: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 01:39:23 +00:00
Loading from an INI file
Update provider doc page headers
2020-09-02 21:33:02 +00:00
------------------------
Add configuration provider docs
2020-06-25 21:12:16 +00: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 01:39:23 +00:00
``Configuration`` provider can load configuration from an ``ini`` file using the
:py:meth:`Configuration.from_ini` method:
Add configuration provider docs
2020-06-25 21:12:16 +00:00
.. literalinclude:: ../../examples/providers/configuration/configuration_ini.py
:language: python
Add usage of the container to the configuration examples
2020-09-03 21:37:03 +00:00
:lines: 3-
:emphasize-lines: 12
Add configuration provider docs
2020-06-25 21:12:16 +00:00
where ``examples/providers/configuration/config.ini`` is:
.. literalinclude:: ../../examples/providers/configuration/config.ini
:language: ini
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 01:39:23 +00:00
:py:meth:`Configuration.from_ini` method supports environment variables interpolation. Use
``${ENV_NAME}`` format in the configuration file to substitute value of the environment
Add docs for environment varibles interpolation in the Configuration provider
2020-06-26 03:48:55 +00:00
variable ``ENV_NAME``.
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 01:39:23 +00:00
Loading from a YAML file
Update provider doc page headers
2020-09-02 21:33:02 +00:00
------------------------
Add configuration provider docs
2020-06-25 21:12:16 +00: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 01:39:23 +00:00
``Configuration`` provider can load configuration from a ``yaml`` file using the
:py:meth:`Configuration.from_yaml` method:
Add configuration provider docs
2020-06-25 21:12:16 +00:00
.. literalinclude:: ../../examples/providers/configuration/configuration_yaml.py
:language: python
Add usage of the container to the configuration examples
2020-09-03 21:37:03 +00:00
:lines: 3-
:emphasize-lines: 12
Add configuration provider docs
2020-06-25 21:12:16 +00:00
where ``examples/providers/configuration/config.yml`` is:
.. literalinclude:: ../../examples/providers/configuration/config.yml
:language: ini
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 01:39:23 +00:00
:py:meth:`Configuration.from_yaml` method supports environment variables interpolation. Use
``${ENV_NAME}`` format in the configuration file to substitute value of the environment
Add docs for environment varibles interpolation in the Configuration provider
2020-06-26 03:48:55 +00:00
variable ``ENV_NAME``.
Add configuration provider docs
2020-06-25 21:12:16 +00: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 01:39:23 +00:00
Loading of a yaml configuration requires ``PyYAML`` package.
You can install the ``Dependency Injector`` with an extra dependency::
Add configuration provider docs
2020-06-25 21:12:16 +00: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 01:39:23 +00:00
pip install dependency-injector[yaml]
Improve List and Configuration provider docs
2020-06-29 20:32:48 +00: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 01:39:23 +00:00
or install ``PyYAML`` directly::
pip install pyyaml
*Don't forget to mirror the changes in the requirements file.*
Loading from a dictionary
Update provider doc page headers
2020-09-02 21:33:02 +00: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 01:39:23 +00:00
``Configuration`` provider can load configuration from a Python ``dict`` using the
:py:meth:`Configuration.from_dict` method:
Improve List and Configuration provider docs
2020-06-29 20:32:48 +00:00
.. literalinclude:: ../../examples/providers/configuration/configuration_dict.py
:language: python
Add usage of the container to the configuration examples
2020-09-03 21:37:03 +00:00
:lines: 3-
:emphasize-lines: 12-19
Improve List and Configuration provider docs
2020-06-29 20:32:48 +00: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 01:39:23 +00:00
Loading from an environment variable
Update provider doc page headers
2020-09-02 21:33:02 +00:00
------------------------------------
Add configuration provider docs
2020-06-25 21:12:16 +00: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 01:39:23 +00:00
``Configuration`` provider can load configuration from an environment variable using the
:py:meth:`Configuration.from_env` method:
Add configuration provider docs
2020-06-25 21:12:16 +00:00
.. literalinclude:: ../../examples/providers/configuration/configuration_env.py
:language: python
Add usage of the container to the configuration examples
2020-09-03 21:37:03 +00:00
:lines: 3-
:emphasize-lines: 18-20
Add configuration provider docs
2020-06-25 21:12:16 +00: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 01:39:23 +00:00
Loading from the multiple sources
Update provider doc page headers
2020-09-02 21:33:02 +00:00
---------------------------------
Add configuration provider docs
2020-06-25 21:12:16 +00: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 01:39:23 +00:00
``Configuration`` provider can load configuration from the multiple sources. Loaded
configuration is merged recursively over the existing configuration.
Add configuration provider docs
2020-06-25 21:12:16 +00:00
.. literalinclude:: ../../examples/providers/configuration/configuration_multiple.py
:language: python
Add usage of the container to the configuration examples
2020-09-03 21:37:03 +00:00
:lines: 3-
:emphasize-lines: 12-13
Add configuration provider docs
2020-06-25 21:12:16 +00:00
where ``examples/providers/configuration/config.local.yml`` is:
.. literalinclude:: ../../examples/providers/configuration/config.local.yml
:language: ini
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 01:39:23 +00:00
Specifying the value type
Update provider doc page headers
2020-09-02 21:33:02 +00:00
-------------------------
Configuration option typed injections (#284) * Add implementation and tests * Add docs page and examples * Revert the api_client miniapp accidental changes
2020-08-24 17:34:47 +00:00
You can specify the type of the injected configuration value explicitly.
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 01:39:23 +00:00
This helps when you read the value from an ini file or an environment variable and need to
Configuration option typed injections (#284) * Add implementation and tests * Add docs page and examples * Revert the api_client miniapp accidental changes
2020-08-24 17:34:47 +00:00
convert it into an ``int`` or a ``float``.
.. literalinclude:: ../../examples/providers/configuration/configuration_type.py
:language: python
:lines: 3-
Add usage of the container to the configuration examples
2020-09-03 21:37:03 +00:00
:emphasize-lines: 19
Configuration option typed injections (#284) * Add implementation and tests * Add docs page and examples * Revert the api_client miniapp accidental changes
2020-08-24 17:34:47 +00: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 01:39:23 +00:00
``Configuration`` provider has next helper methods:
Configuration option typed injections (#284) * Add implementation and tests * Add docs page and examples * Revert the api_client miniapp accidental changes
2020-08-24 17:34:47 +00:00
- ``.as_int()``
- ``.as_float()``
- ``.as_(callback, *args, **kwargs)``
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 01:39:23 +00:00
The last method ``.as_(callback, *args, **kwargs)`` helps to implement other conversions.
Configuration option typed injections (#284) * Add implementation and tests * Add docs page and examples * Revert the api_client miniapp accidental changes
2020-08-24 17:34:47 +00:00
.. literalinclude:: ../../examples/providers/configuration/configuration_type_custom.py
:language: python
:lines: 3-
Add usage of the container to the configuration examples
2020-09-03 21:37:03 +00:00
:emphasize-lines: 18
Configuration option typed injections (#284) * Add implementation and tests * Add docs page and examples * Revert the api_client miniapp accidental changes
2020-08-24 17:34:47 +00: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 01:39:23 +00:00
With the ``.as_(callback, *args, **kwargs)`` you can specify a function that will be called
Configuration option typed injections (#284) * Add implementation and tests * Add docs page and examples * Revert the api_client miniapp accidental changes
2020-08-24 17:34:47 +00:00
before the injection. The value from the config will be passed as a first argument. The returned
value will be injected. Parameters ``*args`` and ``**kwargs`` are handled as any other injections.
Add usage of the container to the configuration examples
2020-09-03 21:37:03 +00:00
Injecting invariants
--------------------
You can inject invariant configuration options based on the value of the other configuration
option.
To use that you should provide the switch-value as an item of the configuration option that
contains sections ``config.options[config.switch]``:
- When the value of the ``config.switch`` is ``A``, the ``config.options.A`` is injected
- When the value of the ``config.switch`` is ``B``, the ``config.options.B`` is injected
.. literalinclude:: ../../examples/providers/configuration/configuration_itemselector.py
:language: python
:lines: 3-
:emphasize-lines: 15,30-31,38
Add configuration provider docs
2020-06-25 21:12:16 +00:00
.. disqus::