Update README.rst

This commit is contained in:
Roman Mogylatov 2020-08-10 22:04:04 -04:00 committed by GitHub
parent 8878645c7b
commit 80aad7748d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -71,10 +71,8 @@ How does it different from the other frameworks?
``Dependency Injector`` is a simple tool for the powerful concept. ``Dependency Injector`` is a simple tool for the powerful concept.
Why do I need it? Example
================= =======
``Dependency Injector`` helps you understand and change the structure of the application.
With the ``Dependency Injector`` you keep **application structure in one place**. With the ``Dependency Injector`` you keep **application structure in one place**.
This place is called **the container**. You use the container to manage all the components of the This place is called **the container**. You use the container to manage all the components of the
@ -86,98 +84,80 @@ the application structure. It is **easy to understand and change** it.
*The container is like a map of your application. You always know what depends on what.* *The container is like a map of your application. You always know what depends on what.*
``Flask`` + ``Dependency Injector`` example application container: Example application container:
.. code-block:: python .. code-block:: python
from dependency_injector import containers, providers import logging
from dependency_injector.ext import flask import sys
from flask import Flask
from flask_bootstrap import Bootstrap
from github import Github
from . import views, services from dependency_injector import containers, providers
from . import http, monitors, dispatcher
class ApplicationContainer(containers.DeclarativeContainer): class ApplicationContainer(containers.DeclarativeContainer):
"""Application container."""
app = flask.Application(Flask, __name__) config = providers.Configuration()
bootstrap = flask.Extension(Bootstrap) configure_logging = providers.Callable(
logging.basicConfig,
stream=sys.stdout,
level=config.log.level,
format=config.log.format,
)
config = providers.Configuration() http_client = providers.Factory(http.HttpClient)
github_client = providers.Factory( example_monitor = providers.Factory(
Github, monitors.HttpMonitor,
login_or_token=config.github.auth_token, http_client=http_client,
timeout=config.github.request_timeout, options=config.monitors.example,
) )
search_service = providers.Factory( httpbin_monitor = providers.Factory(
services.SearchService, monitors.HttpMonitor,
github_client=github_client, http_client=http_client,
) options=config.monitors.httpbin,
)
index_view = flask.View( dispatcher = providers.Factory(
views.index, dispatcher.Dispatcher,
search_service=search_service, monitors=providers.List(
default_query=config.search.default_query, example_monitor,
default_limit=config.search.default_limit, httpbin_monitor,
) ),
)
Running such container looks like this: Running of such container looks like this:
.. code-block:: python .. code-block:: python
from .containers import ApplicationContainer from .containers import ApplicationContainer
def create_app(): def main() -> None:
"""Create and return Flask application.""" container = ApplicationContainer()
container = ApplicationContainer()
container.config.from_yaml('config.yml')
container.config.github.auth_token.from_env('GITHUB_TOKEN')
app = container.app() container.config.from_yaml('config.yml')
app.container = container container.configure_logging()
bootstrap = container.bootstrap() dispatcher = container.dispatcher()
bootstrap.init_app(app) dispatcher.run()
app.add_url_rule('/', view_func=container.index_view.as_view())
return app
And testing looks like:
.. code-block:: python
from unittest import mock
import pytest
from github import Github
from flask import url_for
from .application import create_app
@pytest.fixture if __name__ == '__main__':
def app(): main()
return create_app()
Tutorials
=========
Tutorial will be a good point to start.
def test_index(client, app): You can pass one of the dependency injection tutorials:
github_client_mock = mock.Mock(spec=Github)
# Configure mock
with app.container.github_client.override(github_client_mock): - `Flask web application tutorial <http://python-dependency-injector.ets-labs.org/tutorials/flask.html>`_
response = client.get(url_for('index')) - `Aiohttp REST API tutorial <http://python-dependency-injector.ets-labs.org/tutorials/aiohttp.html>`_
- `Asyncio monitoring daemon tutorial <http://python-dependency-injector.ets-labs.org/tutorials/asyncio-daemon.html>`_
assert response.status_code == 200
# Do more asserts
See complete example here - `Flask + Dependency Injector Example <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/ghnav-flask>`_
How to install? How to install?
--------------- ---------------