ets-labs/python-dependency-injector
1
1
Fork 0
mirror of https://github.com/ets-labs/python-dependency-injector.git synced 2025-07-27 08:19:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Finish flask tutorial refactoring

Browse Source
This commit is contained in:
Roman Mogylatov 2020-10-08 14:24:51 -04:00
parent 28595146cf
commit f77525086f
1 changed files with 20 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs/tutorials/flask.rst
View File

@ -829,7 +829,7 @@ Tests
In this section we will add some tests. In this section we will add some tests.
We will use `pytest <https://docs.pytest.org/en/stable/>`_ and We will use `pytest <https://docs.pytest.org/en/stable/>`_ with its Flask extension and
`coverage <https://coverage.readthedocs.io/>`_. `coverage <https://coverage.readthedocs.io/>`_.
Edit ``requirements.txt``: Edit ``requirements.txt``:
@ -845,7 +845,7 @@ Edit ``requirements.txt``:
pytest-flask pytest-flask
pytest-cov pytest-cov
And let's install it: And install added packages:
.. code-block:: bash .. code-block:: bash
@ -874,7 +874,7 @@ Create empty file ``tests.py`` in the ``githubnavigator`` package:
and put next into it: and put next into it:
.. code-block:: python .. code-block:: python
:emphasize-lines: 42,65 :emphasize-lines: 44,67
"""Tests module.""" """Tests module."""
@ -889,7 +889,9 @@ and put next into it:
@pytest.fixture @pytest.fixture
def app(): def app():
return create_app() app = create_app()
yield app
app.container.unwire()
def test_index(client, app): def test_index(client, app):
@ -966,13 +968,13 @@ You should see:
Name Stmts Miss Cover Name Stmts Miss Cover
---------------------------------------------------- ----------------------------------------------------
githubnavigator/__init__.py 0 0 100% githubnavigator/__init__.py 0 0 100%
githubnavigator/application.py 11 0 100% githubnavigator/application.py 15 0 100%
githubnavigator/containers.py 13 0 100% githubnavigator/containers.py 7 0 100%
githubnavigator/services.py 14 0 100% githubnavigator/services.py 14 0 100%
githubnavigator/tests.py 32 0 100% githubnavigator/tests.py 34 0 100%
githubnavigator/views.py 7 0 100% githubnavigator/views.py 9 0 100%
---------------------------------------------------- ----------------------------------------------------
TOTAL 77 0 100% TOTAL 79 0 100%
.. note:: .. note::
@ -983,53 +985,22 @@ You should see:
Conclusion Conclusion
---------- ----------
We are done.
In this tutorial we've built a ``Flask`` application following the dependency injection principle. In this tutorial we've built a ``Flask`` application following the dependency injection principle.
We've used the ``Dependency Injector`` as a dependency injection framework. We've used the ``Dependency Injector`` as a dependency injection framework.
The main part of this application is the container. It keeps all the application components and Container and providers helped to specify how to assemble search service and integrate it with a
their dependencies defined explicitly in one place: 3rd-party library.
.. code-block:: python ``Configuration`` provider helped to deal with reading YAML file and environment variable.
"""Application containers module.""" We used :ref:`wiring` feature to inject the dependencies into the ``index()`` view.
:ref:`provider-overriding` feature helped in testing.
from dependency_injector import containers, providers We kept all the dependencies injected explicitly. This will help when we need to add or
from dependency_injector.ext import flask change something in future.
from flask import Flask
from flask_bootstrap import Bootstrap
from github import Github
from . import services, views You can find complete project on the
`Github <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/ghnav-flask>`_.
class ApplicationContainer(containers.DeclarativeContainer):
"""Application container."""
app = flask.Application(Flask, __name__)
bootstrap = flask.Extension(Bootstrap)
config = providers.Configuration()
github_client = providers.Factory(
Github,
login_or_token=config.github.auth_token,
timeout=config.github.request_timeout,
)
search_service = providers.Factory(
services.SearchService,
github_client=github_client,
)
index_view = flask.View(
views.index,
search_service=search_service,
default_query=config.search.default_query,
default_limit=config.search.default_limit,
)
What's next? What's next?