Skip to content

Update examples to use config __init__ args #527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Nov 1, 2021
Merged

Update examples to use config __init__ args #527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
273cd7c
Update application-single-container example
rmk135 Oct 27, 2021
7c1d8d5
Update application-multiple-containers example
rmk135 Oct 27, 2021
da63617
Update decoupled-packages example
rmk135 Oct 27, 2021
ff91f0b
Update movie lister example
rmk135 Oct 27, 2021
b8c23a2
Update CLI tutorial
rmk135 Oct 28, 2021
dc6311d
Update sanic example
rmk135 Oct 28, 2021
04faec5
Update sanic example with wiring_config
rmk135 Oct 28, 2021
14744e4
Update fastapi example
rmk135 Oct 28, 2021
485d6e7
Update fastapi-simple example
rmk135 Oct 28, 2021
17be5f9
Update fastapi-sqlalchemy example
rmk135 Oct 28, 2021
2ce4a1c
Update flask-blueprints example
rmk135 Oct 28, 2021
f531de3
Update flask example and tutorial
rmk135 Oct 29, 2021
29d0900
Update aiohttp example and tutorial
rmk135 Oct 31, 2021
0bd4dc5
Update asyncio-daemon example and tutorial
rmk135 Nov 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 58 additions & 61 deletions docs/tutorials/aiohttp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,6 @@ Now it's time to install the project requirements. We will use next packages:

- ``dependency-injector`` - the dependency injection framework
- ``aiohttp`` - the web framework
- ``aiohttp-devtools`` - the helper library that will provide a development server with live
reloading
- ``pyyaml`` - the YAML files parsing library, used for the reading of the configuration files
- ``pytest-aiohttp`` - the helper library for the testing of the ``aiohttp`` application
- ``pytest-cov`` - the helper library for measuring the test coverage
Expand All @@ -139,7 +137,6 @@ Put next lines into the ``requirements.txt`` file:

dependency-injector
aiohttp
aiohttp-devtools
pyyaml
pytest-aiohttp
pytest-cov
Expand Down Expand Up @@ -232,26 +229,31 @@ Put next into the ``application.py``:
])
return app


if __name__ == "__main__":
app = create_app()
web.run_app(app)

Now we're ready to run our application

Do next in the terminal:

.. code-block:: bash

adev runserver giphynavigator/application.py --livereload
python -m giphynavigator.application

The output should be something like:

.. code-block:: bash

[18:52:59] Starting aux server at http://localhost:8001 ◆
[18:52:59] Starting dev server at http://localhost:8000 ●
======== Running on http://0.0.0.0:8080 ========
(Press CTRL+C to quit)

Let's check that it works. Open another terminal session and use ``httpie``:

.. code-block:: bash

http http://127.0.0.1:8000/
http http://0.0.0.0:8080/

You should see:

Expand All @@ -261,7 +263,7 @@ You should see:
Content-Length: 844
Content-Type: application/json; charset=utf-8
Date: Wed, 29 Jul 2020 21:01:50 GMT
Server: Python/3.9 aiohttp/3.6.2
Server: Python/3.10 aiohttp/3.6.2

{
"gifs": [],
Expand Down Expand Up @@ -328,8 +330,10 @@ Now we need to add ``GiphyClient`` into the container. The ``GiphyClient`` has t
that have to be injected: the API key and the request timeout. We will need to use two more
providers from the ``dependency_injector.providers`` module:

- ``Factory`` provider that will create the ``GiphyClient`` client.
- ``Configuration`` provider that will provide the API key and the request timeout.
- ``Factory`` provider. It will create a ``GiphyClient`` client.
- ``Configuration`` provider. It will provide an API key and a request timeout for the ``GiphyClient``
client. We will specify the location of the configuration file. The configuration provider will parse
the configuration file when we create a container instance.

Edit ``containers.py``:

Expand All @@ -345,26 +349,16 @@ Edit ``containers.py``:

class Container(containers.DeclarativeContainer):

config = providers.Configuration()
config = providers.Configuration(yaml_files=["config.yml"])

giphy_client = providers.Factory(
giphy.GiphyClient,
api_key=config.giphy.api_key,
timeout=config.giphy.request_timeout,
)

.. note::

We have used the configuration value before it was defined. That's the principle how the
``Configuration`` provider works.

Use first, define later.

Now let's add the configuration file.

We will use YAML.

Create an empty file ``config.yml`` in the root root of the project:
Now let's add the configuration file. We will use YAML. Create an empty file ``config.yml`` in
the root root of the project:

.. code-block:: bash
:emphasize-lines: 9
Expand All @@ -387,17 +381,14 @@ and put next into it:
giphy:
request_timeout: 10

We will use an environment variable ``GIPHY_API_KEY`` to provide the API key.

Now we need to edit ``create_app()`` to make two things when application starts:

- Load the configuration file the ``config.yml``.
- Load the API key from the ``GIPHY_API_KEY`` environment variable.
We will use the ``GIPHY_API_KEY`` environment variable to provide the API key. Let’s edit
``create_app()`` to fetch the key value from it.

Edit ``application.py``:

.. code-block:: python
:emphasize-lines: 11-12
:emphasize-lines: 11

"""Application module."""

Expand All @@ -409,7 +400,6 @@ Edit ``application.py``:

def create_app() -> web.Application:
container = Container()
container.config.from_yaml("config.yml")
container.config.giphy.api_key.from_env("GIPHY_API_KEY")

app = web.Application()
Expand All @@ -420,6 +410,10 @@ Edit ``application.py``:
return app


if __name__ == "__main__":
app = create_app()
web.run_app(app)

Now we need to create an API key and set it to the environment variable.

As for now, don’t worry, just take this one:
Expand Down Expand Up @@ -502,7 +496,7 @@ Edit ``containers.py``:

class Container(containers.DeclarativeContainer):

config = providers.Configuration()
config = providers.Configuration(yaml_files=["config.yml"])

giphy_client = providers.Factory(
giphy.GiphyClient,
Expand Down Expand Up @@ -555,47 +549,50 @@ Edit ``handlers.py``:
},
)

To make the injection work we need to wire the container instance with the ``handlers`` module.
This needs to be done once. After it's done we can use ``Provide`` markers to specify as many
injections as needed for any handler.
To make the injection work we need to wire the container with the ``handlers`` module.
Let's configure the container to automatically make wiring with the ``handlers`` module when we
create a container instance.

Edit ``application.py``:
Edit ``containers.py``:

.. code-block:: python
:emphasize-lines: 13
:emphasize-lines: 10

"""Application module."""
"""Containers module."""

from aiohttp import web
from dependency_injector import containers, providers

from .containers import Container
from . import handlers
from . import giphy, services


def create_app() -> web.Application:
container = Container()
container.config.from_yaml("config.yml")
container.config.giphy.api_key.from_env("GIPHY_API_KEY")
container.wire(modules=[handlers])
class Container(containers.DeclarativeContainer):

app = web.Application()
app.container = container
app.add_routes([
web.get("/", handlers.index),
])
return app
wiring_config = containers.WiringConfiguration(modules=[".handlers"])

config = providers.Configuration(yaml_files=["config.yml"])

giphy_client = providers.Factory(
giphy.GiphyClient,
api_key=config.giphy.api_key,
timeout=config.giphy.request_timeout,
)

search_service = providers.Factory(
services.SearchService,
giphy_client=giphy_client,
)

Make sure the app is running or use:
Make sure the app is running:

.. code-block:: bash

adev runserver giphynavigator/application.py --livereload
python -m giphynavigator.application

and make a request to the API in the terminal:

.. code-block:: bash

http http://localhost:8000/ query=="wow,it works" limit==5
http http://0.0.0.0:8080/ query=="wow,it works" limit==5

You should see:

Expand All @@ -605,7 +602,7 @@ You should see:
Content-Length: 492
Content-Type: application/json; charset=utf-8
Date: Fri, 09 Oct 2020 01:35:48 GMT
Server: Python/3.9 aiohttp/3.6.2
Server: Python/3.10 aiohttp/3.6.2

{
"gifs": [
Expand Down Expand Up @@ -810,24 +807,24 @@ You should see:

.. code-block::

platform darwin -- Python 3.9, pytest-5.4.3, py-1.9.0, pluggy-0.13.1
plugins: cov-2.10.0, aiohttp-0.3.0, asyncio-0.14.0
platform darwin -- Python 3.10.0, pytest-6.2.5, py-1.10.0, pluggy-1.0.0
plugins: asyncio-0.16.0, anyio-3.3.4, aiohttp-0.3.0, cov-3.0.0
collected 3 items

giphynavigator/tests.py ... [100%]

---------- coverage: platform darwin, python 3.9 -----------
---------- coverage: platform darwin, python 3.10.0-final-0 ----------
Name Stmts Miss Cover
---------------------------------------------------
giphynavigator/__init__.py 0 0 100%
giphynavigator/application.py 12 0 100%
giphynavigator/containers.py 6 0 100%
giphynavigator/application.py 13 2 85%
giphynavigator/containers.py 7 0 100%
giphynavigator/giphy.py 14 9 36%
giphynavigator/handlers.py 10 0 100%
giphynavigator/services.py 9 1 89%
giphynavigator/tests.py 37 0 100%
---------------------------------------------------
TOTAL 88 10 89%
TOTAL 90 12 87%

.. note::

Expand Down
Loading