mirror of
https://github.com/ets-labs/python-dependency-injector.git
synced 2025-11-04 09:57:37 +03:00
07d4f7e74f
* Add wiring (#294) * Add wiring module * Fix code style * Fix package test * Add version fix * Try spike for 3.6 * Try another fix with metaclass * Downsample required version to 3.6 * Introduce concept with annotations * Fix bugs * Add debug message * Add extra tests * Add extra debugging * Update config resolving * Remove 3.6 generic meta fix * Fix Flake8 * Add spike for 3.6 * Add Python 3.6 spike * Add unwire functionality * Add support of corouting functions * Bump version to 4.0 * Updaet demo example * Add pydocstyle ignore for demo * Add flake8 ignore for demo * Update aiohttp example * Update flask example * Rename aiohttp example directory * Rename views module to handlers in aiohttp example * Add sanic example * Remove not needed images * Update demo * Implement wiring for Provide[foo.provider] * Implement Provide[foo.provided.bar.baz.call()] * Make flake8 happy * Wiring refactoring (#296) * Refactor wiring * Add todos to wiring * Implement wiring of config invariant * Implement sub containers wiring + add tests * Add test for wiring config invariant * Add container.unwire() typing stub * Deprecate ext package modules and remove types module * Deprecate provider.delegate() method * Add __all__ for wiring module * Add protection for wiring only declarative container instances * Bump version to 4.0.0a2 * Add wiring docs * Add wiring of class methods * Remove unused import * Add a note on individuals import to wiring docs * Add minor improvement to wiring doc * Update DI in Python page * Update key features * Update README concep and FAQ * Add files via upload * Update README.rst * Update README.rst * Update README.rst * Update docs index page * Update README * Remove API docs for flask and aiohttp ext * Add wiring API docs * Update docs index * Update README * Update readme and docs index * Change wording in README * Django example (#297) * Add rough django example * Remove sqlite db * Add gitignore * Fix flake8 and pydocstyle errors * Add tests * Refactor settings * Move web app to to the root of the project * Add bootstrap 4 * Add doc blocks for web app * Add coverage * Fix typo in flask * Remove not needed newlines * Add screenshot * Update django app naming * Add django example to the docs * Update changelog * Update Aiohttp example * Add sanic example to the docs * Make a little fix in django example docs page * Add flask example to the docs * Add aiohttp example to the docs * Update installation docs page * Fix .delegate() deprecation * Refactor movie lister to use wiring * Make micro cosmetic changes to flask, aiohttp & sanic examples * Refactor single container example to use wiring * Refactor multiple container example to use wiring * Add return type to main() in application examples * Refactor decoupled packages example to use wiring * Refactor code layout for DI demo example * Update wiring feature message * Add more links to the examples * Change code layout in miniapps * Update sanic example * Update miniapp READMEs * Update wiring docs * Refactor part of cli tutorial * Refactor CLI app tutorial * Update test coverage results in movie lister example and tutorial * Make some minor updates to aiohttp and cli tutorials * Refactor flask tutorial * Make cosmetic fix in flask example * Refactor Flask tutorial: Connect to the GitHub * Refactor Flask tutorial: Search service * Refactor Flask tutorial: Inject search service into view * Refactor Flask tutorial: Make some refactoring * Finish flask tutorial refactoring * Update tutorials * Refactor asyncio monitoring daemon example application * Fix tutorial links * Rename asyncio miniapp * Rename tutorial image dirs * Rename api docs tol-level page * Refactor initial sections of asyncio daemon tutorial * Refactor asyncio tutorial till Example.com monitor section * Refactor asyncio tutorial example.com monitor section * Refactor asyncio tutorial httpbin.org monitor tutorial * Refactor tests section of asyncio daemon tutorial * Update conclusion of asyncio daemon tutorial * Rename tutorial images * Make cosmetic update to flask tutorial * Refactor aiohttp tutorial: Minimal application section * Refactor aiohttp tutorial: Giphy API client secion * Refactor aiohttp tutorial secion: Make the search work * Refactor aiohttp tutorial tests section * Refactor aiohttp tutorial conclusion * Upgrade Cython to 0.29.21 * Update changelog * Update demo example * Update wording on index pages * Update changelog * Update code layout for main demo
98 lines
2.5 KiB
ReStructuredText
98 lines
2.5 KiB
ReStructuredText
.. _django-example:
|
|
|
|
Django example
|
|
==============
|
|
|
|
.. meta::
|
|
:keywords: Python,Dependency Injection,Django,Example
|
|
:description: This example demonstrates a usage of the Django and Dependency Injector.
|
|
|
|
|
|
This example shows how to use ``Dependency Injector`` with `Django <https://www.djangoproject.com/>`_.
|
|
|
|
The example application helps to search for repositories on the Github.
|
|
|
|
.. image:: images/django.png
|
|
:width: 100%
|
|
:align: center
|
|
|
|
The source code is available on the `Github <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/django>`_.
|
|
|
|
Application structure
|
|
---------------------
|
|
|
|
Application has standard Django project structure. It consists of ``githubnavigator`` project package and
|
|
``web`` application package:
|
|
|
|
.. code-block:: bash
|
|
|
|
./
|
|
├── githubnavigator/
|
|
│ ├── __init__.py
|
|
│ ├── asgi.py
|
|
│ ├── containers.py
|
|
│ ├── services.py
|
|
│ ├── settings.py
|
|
│ ├── urls.py
|
|
│ └── wsgi.py
|
|
├── web/
|
|
│ ├── templates/
|
|
│ │ ├── base.html
|
|
│ │ └── index.html
|
|
│ ├── __init__.py
|
|
│ ├── apps.py
|
|
│ ├── tests.py
|
|
│ ├── urls.py
|
|
│ └── views.py
|
|
├── manage.py
|
|
└── requirements.txt
|
|
|
|
Container
|
|
---------
|
|
|
|
Declarative container is defined in ``githubnavigator/containers.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/django/githubnavigator/containers.py
|
|
:language: python
|
|
|
|
Container instance is created in ``githubnavigator/__init__.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/django/githubnavigator/__init__.py
|
|
:language: python
|
|
|
|
Views
|
|
-----
|
|
|
|
View has dependencies on search service and some config options. The dependencies are injected
|
|
using :ref:`wiring` feature.
|
|
|
|
Listing of ``web/views.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/django/web/views.py
|
|
:language: python
|
|
|
|
App config
|
|
----------
|
|
|
|
Container is wired to the ``views`` module in the app config ``web/apps.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/django/web/apps.py
|
|
:language: python
|
|
:emphasize-lines: 13
|
|
|
|
Tests
|
|
-----
|
|
|
|
Tests use :ref:`provider-overriding` feature to replace github client with a mock ``web/tests.py``:
|
|
|
|
.. literalinclude:: ../../examples/miniapps/django/web/tests.py
|
|
:language: python
|
|
:emphasize-lines: 39,60
|
|
|
|
Sources
|
|
-------
|
|
|
|
Explore the sources on the `Github <https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/django>`_.
|
|
|
|
.. disqus::
|