This project was initially created to show the abillities of taskiq-dependencies project, which is used by taskiq to provide you with the best experience of sending distributed tasks.
This project adds FastAPI-like dependency injection to your AioHTTP application and swagger documentation based on types.
To start using dependency injection, just initialize the injector.
from aiohttp import web
from aiohttp_deps import init as deps_init
app = web.Application()
app.on_startup.append(deps_init)
web.run_app(app)If you use mypy, then we have a custom router with propper types.
from aiohttp import web
from aiohttp_deps import init as deps_init
from aiohttp_deps import Router
router = Router()
@router.get("/")
async def handler():
return web.json_response({})
app = web.Application()
app.router.add_routes(router)
app.on_startup.append(deps_init)
web.run_app(app)Also, you can nest routers with prefixes,
api_router = Router()
memes_router = Router()
main_router = Router()
main_router.add_routes(api_router, prefix="/api")
main_router.add_routes(memes_router, prefix="/memes")If you use dependencies in you handlers, we can easily generate swagger for you. We have some limitations:
- We don't support resolving type aliases if hint is a string.
If you define variable like this:
myvar = int | Noneand then in handler you'd create annotation like this:param: "str | myvar"it will fail. You need to unquote type hint in order to get it work.
We will try to fix these limitations later.
To enable swagger, just add it to your startup.
from aiohttp_deps import init, setup_swagger
app = web.Application()
app.on_startup.extend([init, setup_swagger()])You can define schema for responses using dataclasses or pydantic models. This would not affect handlers in any way, it's only for documentation purposes, if you want to actually validate values your handler returns, please write your own wrapper.
from dataclasses import dataclass
from aiohttp import web
from pydantic import BaseModel
from aiohttp_deps import Router, openapi_response
router = Router()
@dataclass
class Success:
data: str
class Unauthorized(BaseModel):
why: str
@router.get("/")
@openapi_response(200, Success, content_type="application/xml")
@openapi_response(200, Success)
@openapi_response(401, Unauthorized, description="When token is not correct")
async def handler() -> web.Response:
...This example illustrates how much you can do with this decorator. You can have multiple content-types for a single status, or you can have different possble statuses. This function is pretty simple and if you want to make your own decorator for your responses, it won't be hard.
By default this library provides only two injectables. web.Request and web.Application.
async def handler(app: web.Application = Depends()): ...
async def handler2(request: web.Request = Depends()): ...It's super useful, because you can use these dependencies in any other dependency. Here's a more complex example of how you can use this library.
from aiohttp_deps import Router, Depends
from aiohttp import web
router = Router()
async def get_db_session(app: web.Application = Depends()):
async with app[web.AppKey("db")] as sess:
yield sess
class MyDAO:
def __init__(self, session=Depends(get_db_session)):
self.session = session
async def get_objects(self) -> list[object]:
return await self.session.execute("SELECT 1")
@router.get("/")
async def handler(db_session: MyDAO = Depends()):
objs = await db_session.get_objects()
return web.json_response({"objects": objs})If you do something like this, you would never think about initializing your DAO. You can just inject it and that's it.
This library also provides you with some default dependencies that can help you in building the best web-service.
To parse json, create a pydantic model and add a dependency to your handler.
from aiohttp import web
from pydantic import BaseModel
from aiohttp_deps import Router, Json, Depends
router = Router()
class UserInfo(BaseModel):
name: str
@router.post("/users")
async def new_data(user: UserInfo = Depends(Json())):
return web.json_response({"user": user.model_dump()})This dependency automatically validates data and send errors if the data doesn't orrelate with schema or body is not a valid json.
If you want to make this data optional, just mark it as optional.
@router.post("/users")
async def new_data(user: Optional[UserInfo] = Depends(Json())):
if user is None:
return web.json_response({"user": None})
return web.json_response({"user": user.model_dump()})You can get and validate headers using Header dependency.
Let's try to build simple example for authorization.
from aiohttp_deps import Router, Header, Depends
from aiohttp import web
router = Router()
def decode_token(authorization: str = Depends(Header())) -> str:
if authorization == "secret":
# Let's pretend that here we
# decode our token.
return authorization
raise web.HTTPUnauthorized()
@router.get("/secret_data")
async def new_data(token: str = Depends(decode_token)) -> web.Response:
return web.json_response({"secret": "not a secret"})As you can see, header name to parse is equal to the name of a parameter that introduces Header dependency.
If you want to use some name that is not allowed in python, or just want to have different names, you can use alias. Like this:
def decode_token(auth: str = Depends(Header(alias="Authorization"))) -> str:Headers can also be parsed to types. If you want a header to be parsed as int, just add the typehint.
def decode_token(meme_id: int = Depends(Header())) -> str:If you want to get list of values of one header, use parameter multiple=True.
def decode_token(meme_id: list[int] = Depends(Header(multiple=True))) -> str:And, of course, you can provide this dependency with default value if the value from user cannot be parsed for some reason.
def decode_token(meme_id: str = Depends(Header(default="not-a-secret"))) -> str:You can depend on Query to get and parse query parameters.
from aiohttp_deps import Router, Query, Depends
from aiohttp import web
router = Router()
@router.get("/shop")
async def shop(item_id: str = Depends(Query())) -> web.Response:
return web.json_response({"id": item_id})the name of the parameter is the same as the name of function parameter.
The Query dependency is acually the same as the Header dependency, so everything about the Header dependency also applies to Query.
If you use views as handlers, please use View class from aiohttp_deps, otherwise the magic won't work.
from aiohttp_deps import Router, View, Depends
from aiohttp import web
router = Router()
@router.view("/view")
class MyView(View):
async def get(self, app: web.Application = Depends()):
return web.json_response({"app": str(app)})Now you can easiy get and validate form data from your request.
To make the magic happen, please add arbitrary_types_allowed to the config of your model.
import pydantic
from aiohttp_deps import Router, Depends, Form
from aiohttp import web
router = Router()
class MyForm(pydantic.BaseModel):
id: int
file: web.FileField
model_config = pydantic.ConfigDict(arbitrary_types_allowed=True)
@router.post("/")
async def handler(my_form: MyForm = Depends(Form())):
with open("my_file", "wb") as f:
f.write(my_form.file.file.read())
return web.json_response({"id": my_form.id})If you have path variables, you can also inject them in your handler.
from aiohttp_deps import Router, Path, Depends
from aiohttp import web
router = Router()
@router.get("/view/{var}")
async def my_handler(var: str = Depends(Path())):
return web.json_response({"var": var})This dependency is used to add additional swagger fields to the endpoint's swagger that is using this dependency. It might be even indirect dependency.
You can check how this thing can be used in our examples/swagger_auth.py.
Sometimes for tests you don't want to calculate actual functions and you want to pass another functions instead.
To do so, you can add "dependency_overrides" or "values_overrides" to the aplication's state.
These values should be dicts. The keys for these values can be found in aiohttp_deps.keys module.
Here's an example.
def original_dep() -> int:
return 1
class MyView(View):
async def get(self, num: int = Depends(original_dep)):
"""Nothing."""
return web.json_response({"request": num})Imagine you have a handler that depends on some function,
but instead of 1 you want to have 2 in your tests.
To do it, jsut add dependency_overrides somewhere,
where you create your application. And make sure that keys
of that dict are actual function that are being replaced.
from aiohttp_deps import VALUES_OVERRIDES_KEY
my_app[VALUES_OVERRIDES_KEY] = {original_dep: 2}But values_overrides only overrides returned values. If you want to
override functions, you have to use dependency_overrides. Here's an example:
from aiohttp_deps import DEPENDENCY_OVERRIDES_KEY
def replacing_function() -> int:
return 2
my_app[DEPENDENCY_OVERRIDES_KEY] = {original_dep: replacing_function}The cool point about dependency_overrides, is that it recalculates graph and
you can use dependencies in function that replaces the original.