Merge branch 'release/0.1.2'

Author: s3rius

README.md

@@ -52,6 +52,20 @@ web.run_app(app)
 
 ```
 
+Also, you can nest routers with prefixes,
+
+```python
+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")
+```
+
+
 ## Default dependencies
 
 By default this library provides only two injectables. `web.Request` and `web.Application`.
@@ -233,3 +247,34 @@ class MyView(View):
         return web.json_response({"app": str(app)})
 
 ```
+
+
+## Forms
+
+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.
+
+
+```python
+from pydantic import BaseModel
+from aiohttp_deps import Router, Depends, Form
+from aiohttp import web
+
+router = Router()
+
+
+class MyForm(BaseModel):
+    id: int
+    file: web.FileField
+
+    class Config:
+        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})
+
+```

aiohttp_deps/__init__.py

@@ -3,7 +3,7 @@
 
 from aiohttp_deps.initializer import init
 from aiohttp_deps.router import Router
-from aiohttp_deps.utils import Header, Json, Query
+from aiohttp_deps.utils import Form, Header, Json, Query
 from aiohttp_deps.view import View
 
 __all__ = [
@@ -14,4 +14,5 @@
     "View",
     "Json",
     "Query",
+    "Form",
 ]

aiohttp_deps/router.py

@@ -1,3 +1,5 @@
+from typing import Iterable
+
 from aiohttp import web
 
 
@@ -13,3 +15,25 @@ class Router(web.RouteTableDef):
 
     New types are introduced in stub file: router.pyi.
     """
+
+    def add_routes(self, router: Iterable[web.RouteDef], prefix: str = "") -> None:
+        """
+        Append another router's routes to this one.
+
+        :param router: router to get routes from.
+        :param prefix: url prefix for routes, defaults to ""
+        :raises ValueError: if prefix is incorrect.
+        """
+        if prefix and not prefix.startswith("/"):
+            raise ValueError("Prefix must start with a `/`")
+        if prefix and prefix.endswith("/"):
+            raise ValueError("Prefix should not end with a `/`")
+        for route in router:
+            self._items.append(
+                web.RouteDef(
+                    method=route.method,
+                    path=prefix + route.path,
+                    handler=route.handler,
+                    kwargs=route.kwargs,
+                ),
+            )

aiohttp_deps/router.pyi

@@ -1,4 +1,4 @@
-from typing import Any, Awaitable, Callable, Type, Union
+from typing import Any, Awaitable, Callable, Iterable, Type, Union
 
 from aiohttp import web
 from aiohttp.abc import AbstractView
@@ -18,3 +18,4 @@ class Router(web.RouteTableDef):
     def delete(self, path: str, **kwargs: Any) -> _Deco: ...
     def options(self, path: str, **kwargs: Any) -> _Deco: ...
     def view(self, path: str, **kwargs: Any) -> _Deco: ...
+    def add_routes(self, router: Iterable[web.RouteDef], prefix: str = "") -> None: ...

aiohttp_deps/utils.py

@@ -70,7 +70,10 @@ def __call__(  # noqa: C901, WPS210
         except pydantic.ValidationError as err:
             errors = err.errors()
             for error in errors:
-                error["loc"] = (f"header:{header_name}",)
+                error["loc"] = (
+                    "header",
+                    header_name,
+                ) + error["loc"]
             raise web.HTTPBadRequest(
                 headers={"Content-Type": "application/json"},
                 text=json.dumps(errors),
@@ -119,7 +122,7 @@ async def __call__(  # noqa: C901
         except pydantic.ValidationError as err:
             errors = err.errors()
             for error in errors:
-                error["loc"] = ("body",)
+                error["loc"] = ("body",) + error["loc"]
             raise web.HTTPBadRequest(
                 headers={"Content-Type": "application/json"},
                 text=json.dumps(errors),
@@ -189,7 +192,57 @@ def __call__(  # noqa: C901, WPS210
         except pydantic.ValidationError as err:
             errors = err.errors()
             for error in errors:
-                error["loc"] = (f"querystring:{param_name}",)
+                error["loc"] = (
+                    "query",
+                    param_name,
+                ) + error["loc"]
+            raise web.HTTPBadRequest(
+                headers={"Content-Type": "application/json"},
+                text=json.dumps(errors),
+            )
+
+
+class Form:
+    """
+    Get and validate form data.
+
+    This dependency grabs form data and validates
+    it against given schema.
+
+    You should provide schema with typehints.
+    """
+
+    async def __call__(
+        self,
+        param_info: ParamInfo = Depends(),
+        request: web.Request = Depends(),
+    ) -> Any:
+        """
+        Performs actual logic, described above.
+
+        :param param_info: information about how the dependency
+            was defined with name and type.
+        :param request: current request.
+        :raises HTTPBadRequest: if incorrect data was found.
+        :return: parsed data.
+        """
+        form_data = await request.post()
+        definition = None
+        if (  # noqa: WPS337
+            param_info.definition
+            and param_info.definition.annotation != inspect.Parameter.empty
+        ):
+            definition = param_info.definition.annotation
+
+        if definition is None:
+            return form_data
+
+        try:
+            return pydantic.parse_obj_as(definition, form_data)
+        except pydantic.ValidationError as err:
+            errors = err.errors()
+            for error in errors:
+                error["loc"] = ("form",) + error["loc"]
             raise web.HTTPBadRequest(
                 headers={"Content-Type": "application/json"},
                 text=json.dumps(errors),

pyproject.toml

@@ -3,7 +3,7 @@ name = "aiohttp-deps"
 description = "Dependency injection for AioHTTP"
 authors = ["Taskiq team <taskiq@no-reply.com>"]
 maintainers = ["Taskiq team <taskiq@no-reply.com>"]
-version = "0.1.1"
+version = "0.1.2"
 readme = "README.md"
 license = "LICENSE"
 classifiers = [

tests/test_form.py

@@ -0,0 +1,83 @@
+import pytest
+from aiohttp import web
+from pydantic import BaseModel
+
+from aiohttp_deps import Depends, Form
+from tests.conftest import ClientGenerator
+
+
+class InputSchema(BaseModel):
+    id: int
+    file: web.FileField
+
+    class Config:
+        arbitrary_types_allowed = True
+
+
+@pytest.mark.anyio
+async def test_form_dependency(
+    my_app: web.Application,
+    aiohttp_client: ClientGenerator,
+):
+    async def handler(my_form: InputSchema = Depends(Form())):
+        return web.Response(body=my_form.file.file.read())
+
+    my_app.router.add_post("/", handler)
+
+    file_data = b"bytes"
+    client = await aiohttp_client(my_app)
+    resp = await client.post(
+        "/",
+        data={"id": "1", "file": b"bytes"},
+    )
+    assert resp.status == 200
+    assert await resp.content.read() == file_data
+
+
+@pytest.mark.anyio
+async def test_form_empty(
+    my_app: web.Application,
+    aiohttp_client: ClientGenerator,
+):
+    async def handler(_: InputSchema = Depends(Form())):
+        """Nothing."""
+
+    my_app.router.add_post("/", handler)
+
+    client = await aiohttp_client(my_app)
+    resp = await client.post(
+        "/",
+    )
+    assert resp.status == 400
+
+
+@pytest.mark.anyio
+async def test_form_incorrect_data(
+    my_app: web.Application,
+    aiohttp_client: ClientGenerator,
+):
+    async def handler(_: InputSchema = Depends(Form())):
+        """Nothing."""
+
+    my_app.router.add_post("/", handler)
+
+    client = await aiohttp_client(my_app)
+    resp = await client.post("/", data={"id": "meme", "file": b""})
+    assert resp.status == 400
+
+
+@pytest.mark.anyio
+async def test_form_untyped(
+    my_app: web.Application,
+    aiohttp_client: ClientGenerator,
+):
+    async def handler(form=Depends(Form())):
+        return web.Response(body=form["file"].file.read())
+
+    my_app.router.add_post("/", handler)
+
+    form_data = b"meme"
+    client = await aiohttp_client(my_app)
+    resp = await client.post("/", data={"id": "meme", "file": form_data})
+    assert resp.status == 200
+    assert await resp.content.read() == form_data