aiomisc-dependency
==================
Dependency injection plugin for aiomisc_ built with aiodine_ library and
support pytest fixture style dependency injection.
.. _aiodine: https://github.com/bocadilloproject/aiodine
.. _aiomisc: https://github.com/aiokitchen/aiomisc
.. contents:: Table of contents
Installation
------------
Installing from pypi:
.. code-block:: bash
pip3 install aiomisc aiomisc-dependency
How to use
----------
Register dependency
*******************
To register dependency you can use ``aiomisc_dependency.dependency`` decorator.
.. code-block:: python
from aiomisc_dependency import dependency
@dependency
async def pg_engine():
pg_engine = await create_engine(dsn=pg_url)
yield pg_engine
pg_engine.close()
await pg_engine.wait_closed()
As you can see dependency can be async generator function. Code after yield
will be executed on teardown to correctly close the dependency.
Coroutine functions, non async functions and generators are also supported.
Use dependency
**************
To use dependency you need to add it's name to ``__dependencies__`` property
for every service which depends on it. Specified dependencies will be injected
as service's attributes on entrypoint startup. If needed to map the dependency
with a different name, then, use ``__dependencies_map__``
.. code-block:: python
from contextlib import suppress
from types import MappingProxyType
import aiohttp
from aiomisc.service.aiohttp import AIOHTTPService
class HealthcheckService(AIOHTTPService):
__dependencies__ = ('pg_engine',)
async def create_application(self):
app = aiohttp.web.Application()
app.add_routes([aiohttp.web.get('/ping', self.healthcheck_handler)])
return app
async def healthcheck_handler(self, request):
pg_status = False
with suppress(Exception):
async with self.pg_engine.acquire() as conn:
await conn.execute('SELECT 1')
pg_status = True
return aiohttp.web.json_response(
{'db': pg_status},
status=(200 if pg_status else 500),
)
class RESTService(AIOHTTPService):
__dependencies__ = ('pg_engine',)
...
class AnotherRESTService(AIOHTTPService):
__dependencies_map__ = MappingProxyType({'pg_engine': 'engine'})
...
If any required dependency won't be found on entrypoint startup,
``RuntimeError`` will be raised.
You can set a dependency manually by adding it to kw arguments on service
creation. This could be convenient in tests.
.. code-block:: python
from unittest import Mock
def test_rest_service():
pg_engine_mock = Mock()
service = RESTService(pg_engine=pg_engine_mock)
...
Dependencies for dependencies
*****************************
You can use dependencies as arguments for other dependencies. Arguments will
injected automatically.
.. code-block:: python
@dependency
async def pg_connection(pg_engine):
async with pg_engine.acquire() as conn:
yield conn
``loop`` built-in dependency
****************************
Built-in ``loop`` dependency can be used if your dependency requires
event loop instance.
.. code-block:: python
import aioredis
@dependency
async def redis_pool(loop):
pool = aioredis.create_pool(redis_url, loop=loop)
yield pool
pool.close()
await pool.wait_closed()
LICENSE
-------
MIT
Raw data
{
"_id": null,
"home_page": "https://github.com/aiokitchen/aiomisc-dependency",
"name": "aiomisc-dependency",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Yuri Shikanov",
"author_email": "dizballanze@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a3/aa/267661dcde9a98a5eec668f7343fb0e60c4aaf6bb53df91206bb6badcc71/aiomisc_dependency-0.1.20.tar.gz",
"platform": "all",
"description": "aiomisc-dependency\n==================\n\nDependency injection plugin for aiomisc_ built with aiodine_ library and\nsupport pytest fixture style dependency injection.\n\n.. _aiodine: https://github.com/bocadilloproject/aiodine\n.. _aiomisc: https://github.com/aiokitchen/aiomisc\n\n.. contents:: Table of contents\n\n\nInstallation\n------------\n\nInstalling from pypi:\n\n.. code-block:: bash\n\n pip3 install aiomisc aiomisc-dependency\n\n\nHow to use\n----------\n\nRegister dependency\n*******************\n\nTo register dependency you can use ``aiomisc_dependency.dependency`` decorator.\n\n.. code-block:: python\n\n from aiomisc_dependency import dependency\n\n @dependency\n async def pg_engine():\n pg_engine = await create_engine(dsn=pg_url)\n yield pg_engine\n pg_engine.close()\n await pg_engine.wait_closed()\n\n\nAs you can see dependency can be async generator function. Code after yield\nwill be executed on teardown to correctly close the dependency.\n\nCoroutine functions, non async functions and generators are also supported.\n\n\nUse dependency\n**************\n\nTo use dependency you need to add it's name to ``__dependencies__`` property\nfor every service which depends on it. Specified dependencies will be injected\nas service's attributes on entrypoint startup. If needed to map the dependency\nwith a different name, then, use ``__dependencies_map__``\n\n.. code-block:: python\n\n from contextlib import suppress\n from types import MappingProxyType\n\n import aiohttp\n from aiomisc.service.aiohttp import AIOHTTPService\n\n class HealthcheckService(AIOHTTPService):\n\n __dependencies__ = ('pg_engine',)\n\n async def create_application(self):\n app = aiohttp.web.Application()\n app.add_routes([aiohttp.web.get('/ping', self.healthcheck_handler)])\n return app\n\n async def healthcheck_handler(self, request):\n pg_status = False\n with suppress(Exception):\n async with self.pg_engine.acquire() as conn:\n await conn.execute('SELECT 1')\n pg_status = True\n\n return aiohttp.web.json_response(\n {'db': pg_status},\n status=(200 if pg_status else 500),\n )\n\n\n class RESTService(AIOHTTPService):\n\n __dependencies__ = ('pg_engine',)\n\n ...\n\n class AnotherRESTService(AIOHTTPService):\n\n __dependencies_map__ = MappingProxyType({'pg_engine': 'engine'})\n\n ...\n\nIf any required dependency won't be found on entrypoint startup,\n``RuntimeError`` will be raised.\n\nYou can set a dependency manually by adding it to kw arguments on service\ncreation. This could be convenient in tests.\n\n.. code-block:: python\n\n from unittest import Mock\n\n def test_rest_service():\n pg_engine_mock = Mock()\n service = RESTService(pg_engine=pg_engine_mock)\n ...\n\nDependencies for dependencies\n*****************************\n\nYou can use dependencies as arguments for other dependencies. Arguments will\ninjected automatically.\n\n.. code-block:: python\n\n @dependency\n async def pg_connection(pg_engine):\n async with pg_engine.acquire() as conn:\n yield conn\n\n\n``loop`` built-in dependency\n****************************\n\nBuilt-in ``loop`` dependency can be used if your dependency requires\nevent loop instance.\n\n.. code-block:: python\n\n import aioredis\n\n @dependency\n async def redis_pool(loop):\n pool = aioredis.create_pool(redis_url, loop=loop)\n yield pool\n pool.close()\n await pool.wait_closed()\n\nLICENSE\n-------\n\nMIT\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "aiomisc-dependency - dependency injection in aiomisc",
"version": "0.1.20",
"project_urls": {
"Homepage": "https://github.com/aiokitchen/aiomisc-dependency"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85d5fd684456780a84be343106fd45f329ca56114e09d9df1a8e080c50e18bd0",
"md5": "826bceb00f0fb3cf675ef184f70e210c",
"sha256": "353609b871c7b69641300d9069b2033a76b1bd8806e6049696729b64b9e5b87a"
},
"downloads": -1,
"filename": "aiomisc_dependency-0.1.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "826bceb00f0fb3cf675ef184f70e210c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5814,
"upload_time": "2023-05-10T18:13:30",
"upload_time_iso_8601": "2023-05-10T18:13:30.594272Z",
"url": "https://files.pythonhosted.org/packages/85/d5/fd684456780a84be343106fd45f329ca56114e09d9df1a8e080c50e18bd0/aiomisc_dependency-0.1.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3aa267661dcde9a98a5eec668f7343fb0e60c4aaf6bb53df91206bb6badcc71",
"md5": "d2ed9cb6ab9a9864c09f14e1b28df44f",
"sha256": "ce40db771f8a02855307797af0058bbf4d978c6a66cddde8a033735509bb9262"
},
"downloads": -1,
"filename": "aiomisc_dependency-0.1.20.tar.gz",
"has_sig": false,
"md5_digest": "d2ed9cb6ab9a9864c09f14e1b28df44f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7470,
"upload_time": "2023-05-10T18:13:31",
"upload_time_iso_8601": "2023-05-10T18:13:31.900414Z",
"url": "https://files.pythonhosted.org/packages/a3/aa/267661dcde9a98a5eec668f7343fb0e60c4aaf6bb53df91206bb6badcc71/aiomisc_dependency-0.1.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-10 18:13:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aiokitchen",
"github_project": "aiomisc-dependency",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "aiomisc-dependency"
}
JSON
