Update version 1.5.1

Fix bug query string appear as required in generated Open API specifi…

.gitignore

@@ -1,6 +1,9 @@
+.coverage
 .idea/
 .pytest_cache
 __pycache__
 aiohttp_pydantic.egg-info/
 build/
+coverage.xml
 dist/
+

.travis.yml

@@ -2,11 +2,14 @@ language: python
 python:
 - '3.8'
 script:
-- pytest tests/
+- pytest --cov-report=xml --cov=aiohttp_pydantic tests/
 install:
 - pip install -U setuptools wheel pip
-- pip install -r test_requirements.txt
+- pip install -r requirements/test.txt
+- pip install -r requirements/ci.txt
 - pip install .
+after_success:
+  - codecov
 deploy:
   provider: pypi
   username: __token__
@@ -16,4 +19,4 @@ deploy:
   on:
     tags: true
     branch: main
-    python: '3.8'
+    python: '3.8'

README.rst

@@ -1,6 +1,28 @@
 Aiohttp pydantic - Aiohttp View to validate and parse request
 =============================================================
 
+.. image:: https://travis-ci.org/Maillol/aiohttp-pydantic.svg?branch=main
+  :target: https://travis-ci.org/Maillol/aiohttp-pydantic
+
+.. image:: https://img.shields.io/pypi/v/aiohttp-pydantic
+  :target: https://img.shields.io/pypi/v/aiohttp-pydantic
+  :alt: Latest PyPI package version
+
+.. image:: https://codecov.io/gh/Maillol/aiohttp-pydantic/branch/add_code_coverage/graph/badge.svg
+  :target: https://codecov.io/gh/Maillol/aiohttp-pydantic
+  :alt: codecov.io status for master branch
+
+Aiohttp pydantic is an `aiohttp view`_ to easily parse and validate request.
+You define using the function annotations what your methods for handling HTTP verbs expects and Aiohttp pydantic parses the HTTP request
+for you, validates the data, and injects that you want as parameters.
+
+
+Features:
+
+- Query string, request body, URL path and HTTP headers validation.
+- Open API Specification generation.
+
+
 How to install
 --------------
 
@@ -254,3 +276,4 @@ You can generate the OAS in a json file using the command:
 
 
 .. _demo: https://github.com/Maillol/aiohttp-pydantic/tree/main/demo
+.. _aiohttp view: https://docs.aiohttp.org/en/stable/web_quickstart.html#class-based-views

aiohttp_pydantic/__init__.py

@@ -1,5 +1,5 @@
 from .view import PydanticView
 
-__version__ = "1.4.0"
+__version__ = "1.5.1"
 
 __all__ = ("PydanticView", "__version__")

aiohttp_pydantic/injectors.py

@@ -1,10 +1,14 @@
 import abc
 from inspect import signature
+from json.decoder import JSONDecodeError
 from typing import Callable, Tuple
 
+from aiohttp.web_exceptions import HTTPBadRequest
 from aiohttp.web_request import BaseRequest
 from pydantic import BaseModel
 
+from .utils import is_pydantic_base_model
+
 
 class AbstractInjector(metaclass=abc.ABCMeta):
     """
@@ -45,7 +49,13 @@ class BodyGetter(AbstractInjector):
         self.arg_name, self.model = next(iter(args_spec.items()))
 
     async def inject(self, request: BaseRequest, args_view: list, kwargs_view: dict):
-        body = await request.json()
+        try:
+            body = await request.json()
+        except JSONDecodeError:
+            raise HTTPBadRequest(
+                text='{"error": "Malformed JSON"}', content_type="application/json"
+            )
+
         kwargs_view[self.arg_name] = self.model(**body)
 
 
@@ -98,7 +108,7 @@ def _parse_func_signature(func: Callable) -> Tuple[dict, dict, dict, dict]:
         if param_spec.kind is param_spec.POSITIONAL_ONLY:
             path_args[param_name] = param_spec.annotation
         elif param_spec.kind is param_spec.POSITIONAL_OR_KEYWORD:
-            if issubclass(param_spec.annotation, BaseModel):
+            if is_pydantic_base_model(param_spec.annotation):
                 body_args[param_name] = param_spec.annotation
             else:
                 qs_args[param_name] = param_spec.annotation

aiohttp_pydantic/oas/struct.py

@@ -1,3 +1,7 @@
+"""
+Utility to write Open Api Specifications using the Python language.
+"""
+
 from typing import Union
 
 
@@ -7,7 +11,7 @@ class Info:
 
     @property
     def title(self):
-        return self._spec["title"]
+        return self._spec.get("title")
 
     @title.setter
     def title(self, title):
@@ -15,7 +19,7 @@ class Info:
 
     @property
     def description(self):
-        return self._spec["description"]
+        return self._spec.get("description")
 
     @description.setter
     def description(self, description):
@@ -23,12 +27,20 @@ class Info:
 
     @property
     def version(self):
-        return self._spec["version"]
+        return self._spec.get("version")
 
     @version.setter
     def version(self, version):
         self._spec["version"] = version
 
+    @property
+    def terms_of_service(self):
+        return self._spec.get("termsOfService")
+
+    @terms_of_service.setter
+    def terms_of_service(self, terms_of_service):
+        self._spec["termsOfService"] = terms_of_service
+
 
 class RequestBody:
     def __init__(self, spec: dict):
@@ -43,8 +55,8 @@ class RequestBody:
         self._spec["description"] = description
 
     @property
-    def required(self):
+    def required(self) -> bool:
-        return self._spec["required"]
+        return self._spec.get("required", False)
 
     @required.setter
     def required(self, required: bool):
@@ -220,6 +232,22 @@ class PathItem:
     def trace(self) -> OperationObject:
         return OperationObject(self._spec.setdefault("trace", {}))
 
+    @property
+    def description(self) -> str:
+        return self._spec["description"]
+
+    @description.setter
+    def description(self, description: str):
+        self._spec["description"] = description
+
+    @property
+    def summary(self) -> str:
+        return self._spec["summary"]
+
+    @summary.setter
+    def summary(self, summary: str):
+        self._spec["summary"] = summary
+
 
 class Paths:
     def __init__(self, spec: dict):
@@ -244,7 +272,7 @@ class Server:
 
     @property
     def description(self) -> str:
-        return self._spec["url"]
+        return self._spec["description"]
 
     @description.setter
     def description(self, description: str):

aiohttp_pydantic/oas/typing.py

@@ -13,7 +13,7 @@ Example:
 
 from functools import lru_cache
 from types import new_class
-from typing import Protocol, TypeVar
+from typing import Protocol, TypeVar, Optional, Type
 
 RespContents = TypeVar("RespContents", covariant=True)
 
@@ -24,9 +24,10 @@ _status_code = frozenset(f"r{code}" for code in range(100, 600))
 def _make_status_code_type(status_code):
     if status_code in _status_code:
         return new_class(status_code, (Protocol[RespContents],))
+    return None
 
 
-def is_status_code_type(obj):
+def is_status_code_type(obj) -> bool:
     """
     Return True if obj is a status code type such as _200 or _404.
     """

aiohttp_pydantic/oas/view.py

@@ -1,27 +1,44 @@
 import typing
+from datetime import date, datetime
+from inspect import getdoc
+from itertools import count
 from typing import List, Type
+from uuid import UUID
 
 from aiohttp.web import Response, json_response
 from aiohttp.web_app import Application
-from pydantic import BaseModel
 
 from aiohttp_pydantic.oas.struct import OpenApiSpec3, OperationObject, PathItem
 
 from ..injectors import _parse_func_signature
+from ..utils import is_pydantic_base_model
 from ..view import PydanticView, is_pydantic_view
 from .typing import is_status_code_type
 
-JSON_SCHEMA_TYPES = {float: "number", str: "string", int: "integer"}
+JSON_SCHEMA_TYPES = {
+    float: {"type": "number"},
+    str: {"type": "string"},
+    int: {"type": "integer"},
+    UUID: {"type": "string", "format": "uuid"},
+    bool: {"type": "boolean"},
+    datetime: {"type": "string", "format": "date-time"},
+    date: {"type": "string", "format": "date"},
+}
 
 
-def _is_pydantic_base_model(obj):
+def _handle_optional(type_):
     """
-    Return true is obj is a pydantic.BaseModel subclass.
+    Returns the type wrapped in Optional or None.
+
+    >>>  _handle_optional(int)
+    >>>  _handle_optional(Optional[str])
+    <class 'str'>
     """
-    try:
+    if typing.get_origin(type_) is typing.Union:
-        return issubclass(obj, BaseModel)
+        args = typing.get_args(type_)
-    except TypeError:
+        if len(args) == 2 and type(None) in args:
-        return False
+            return next(iter(set(args) - {type(None)}))
+    return None
 
 
 class _OASResponseBuilder:
@@ -35,7 +52,7 @@ class _OASResponseBuilder:
 
     @staticmethod
     def _handle_pydantic_base_model(obj):
-        if _is_pydantic_base_model(obj):
+        if is_pydantic_base_model(obj):
             return obj.schema()
         return {}
 
@@ -77,30 +94,32 @@ def _add_http_method_to_oas(
     oas_operation: OperationObject = getattr(oas_path, http_method)
     handler = getattr(view, http_method)
     path_args, body_args, qs_args, header_args = _parse_func_signature(handler)
+    description = getdoc(handler)
+    if description:
+        oas_operation.description = description
 
     if body_args:
         oas_operation.request_body.content = {
             "application/json": {"schema": next(iter(body_args.values())).schema()}
         }
 
-    i = 0
+    indexes = count()
-    for i, (name, type_) in enumerate(path_args.items()):
+    for args_location, args in (
-        oas_operation.parameters[i].required = True
+        ("path", path_args.items()),
-        oas_operation.parameters[i].in_ = "path"
+        ("query", qs_args.items()),
-        oas_operation.parameters[i].name = name
+        ("header", header_args.items()),
-        oas_operation.parameters[i].schema = {"type": JSON_SCHEMA_TYPES[type_]}
+    ):
-
+        for name, type_ in args:
-    for i, (name, type_) in enumerate(qs_args.items(), i + 1):
+            i = next(indexes)
-        oas_operation.parameters[i].required = False
+            oas_operation.parameters[i].in_ = args_location
-        oas_operation.parameters[i].in_ = "query"
+            oas_operation.parameters[i].name = name
-        oas_operation.parameters[i].name = name
+            optional_type = _handle_optional(type_)
-        oas_operation.parameters[i].schema = {"type": JSON_SCHEMA_TYPES[type_]}
+            if optional_type is None:
-
+                oas_operation.parameters[i].schema = JSON_SCHEMA_TYPES[type_]
-    for i, (name, type_) in enumerate(header_args.items(), i + 1):
+                oas_operation.parameters[i].required = True
-        oas_operation.parameters[i].required = False
+            else:
-        oas_operation.parameters[i].in_ = "header"
+                oas_operation.parameters[i].schema = JSON_SCHEMA_TYPES[optional_type]
-        oas_operation.parameters[i].name = name
+                oas_operation.parameters[i].required = False
-        oas_operation.parameters[i].schema = {"type": JSON_SCHEMA_TYPES[type_]}
 
     return_type = handler.__annotations__.get("return")
     if return_type is not None:

aiohttp_pydantic/utils.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+
+
+def is_pydantic_base_model(obj):
+    """
+    Return true is obj is a pydantic.BaseModel subclass.
+    """
+    try:
+        return issubclass(obj, BaseModel)
+    except TypeError:
+        return False

demo/model.py

@@ -4,6 +4,7 @@ from pydantic import BaseModel
 class Pet(BaseModel):
     id: int
     name: str
+    age: int
 
 
 class Error(BaseModel):

demo/view.py

@@ -1,4 +1,4 @@
-from typing import List, Union
+from typing import List, Optional, Union
 
 from aiohttp import web
 
@@ -9,9 +9,11 @@ from .model import Error, Pet
 
 
 class PetCollectionView(PydanticView):
-    async def get(self) -> r200[List[Pet]]:
+    async def get(self, age: Optional[int] = None) -> r200[List[Pet]]:
         pets = self.request.app["model"].list_pets()
-        return web.json_response([pet.dict() for pet in pets])
+        return web.json_response(
+            [pet.dict() for pet in pets if age is None or age == pet.age]
+        )
 
     async def post(self, pet: Pet) -> r201[Pet]:
         self.request.app["model"].add_pet(pet)

requirements/ci.txt

@@ -0,0 +1,7 @@
+certifi==2020.11.8
+chardet==3.0.4
+codecov==2.1.10
+coverage==5.3
+idna==2.10
+requests==2.25.0
+urllib3==1.26.2

requirements/test.txt

@@ -0,0 +1,13 @@
+attrs==20.3.0
+coverage==5.3
+iniconfig==1.1.1
+packaging==20.4
+pluggy==0.13.1
+py==1.9.0
+pyparsing==2.4.7
+pytest==6.1.2
+pytest-aiohttp==0.3.0
+pytest-cov==2.10.1
+six==1.15.0
+toml==0.10.2
+typing-extensions==3.7.4.3

setup.cfg

@@ -35,8 +35,8 @@ install_requires =
     swagger-ui-bundle
 
 [options.extras_require]
-test = pytest; pytest-aiohttp
+test = pytest==6.1.2; pytest-aiohttp==0.3.0; pytest-cov==2.10.1
-
+ci = pytest==6.1.2; pytest-aiohttp==0.3.0; pytest-cov==2.10.1; codecov==2.1.10
 
 [options.packages.find]
 exclude =

test_requirements.txt

@@ -1,3 +0,0 @@
-pytest==6.1.1
-pytest-aiohttp==0.3.0
-typing_extensions>=3.6.5

tests/test_oas/test_struct/test_info.py

@@ -0,0 +1,54 @@
+import pytest
+
+from aiohttp_pydantic.oas.struct import OpenApiSpec3
+
+
+def test_info_title():
+    oas = OpenApiSpec3()
+    assert oas.info.title is None
+    oas.info.title = "Info Title"
+    assert oas.info.title == "Info Title"
+    assert oas.spec == {"info": {"title": "Info Title"}, "openapi": "3.0.0"}
+
+
+def test_info_description():
+    oas = OpenApiSpec3()
+    assert oas.info.description is None
+    oas.info.description = "info description"
+    assert oas.info.description == "info description"
+    assert oas.spec == {"info": {"description": "info description"}, "openapi": "3.0.0"}
+
+
+def test_info_version():
+    oas = OpenApiSpec3()
+    assert oas.info.version is None
+    oas.info.version = "3.14"
+    assert oas.info.version == "3.14"
+    assert oas.spec == {"info": {"version": "3.14"}, "openapi": "3.0.0"}
+
+
+def test_info_terms_of_service():
+    oas = OpenApiSpec3()
+    assert oas.info.terms_of_service is None
+    oas.info.terms_of_service = "http://example.com/terms/"
+    assert oas.info.terms_of_service == "http://example.com/terms/"
+    assert oas.spec == {
+        "info": {"termsOfService": "http://example.com/terms/"},
+        "openapi": "3.0.0",
+    }
+
+
+@pytest.mark.skip("Not yet implemented")
+def test_info_license():
+    oas = OpenApiSpec3()
+    oas.info.license.name = "Apache 2.0"
+    oas.info.license.url = "https://www.apache.org/licenses/LICENSE-2.0.html"
+    assert oas.spec == {
+        "info": {
+            "license": {
+                "name": "Apache 2.0",
+                "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
+            }
+        },
+        "openapi": "3.0.0",
+    }

tests/test_oas/test_struct/test_paths.py

@@ -0,0 +1,124 @@
+from aiohttp_pydantic.oas.struct import OpenApiSpec3
+
+
+def test_paths_description():
+    oas = OpenApiSpec3()
+    oas.paths["/users/{id}"].description = "This route ..."
+    assert oas.spec == {
+        "openapi": "3.0.0",
+        "paths": {"/users/{id}": {"description": "This route ..."}},
+    }
+
+
+def test_paths_get():
+    oas = OpenApiSpec3()
+    oas.paths["/users/{id}"].get
+    assert oas.spec == {"openapi": "3.0.0", "paths": {"/users/{id}": {"get": {}}}}
+
+
+def test_paths_operation_description():
+    oas = OpenApiSpec3()
+    operation = oas.paths["/users/{id}"].get
+    operation.description = "Long descriptions ..."
+    assert oas.spec == {
+        "openapi": "3.0.0",
+        "paths": {"/users/{id}": {"get": {"description": "Long descriptions ..."}}},
+    }
+
+
+def test_paths_operation_summary():
+    oas = OpenApiSpec3()
+    operation = oas.paths["/users/{id}"].get
+    operation.summary = "Updates a pet in the store with form data"
+    assert oas.spec == {
+        "openapi": "3.0.0",
+        "paths": {
+            "/users/{id}": {
+                "get": {"summary": "Updates a pet in the store with form data"}
+            }
+        },
+    }
+
+
+def test_paths_operation_parameters():
+    oas = OpenApiSpec3()
+    operation = oas.paths["/users/{petId}"].get
+    parameter = operation.parameters[0]
+    parameter.name = "petId"
+    parameter.description = "ID of pet that needs to be updated"
+    parameter.in_ = "path"
+    parameter.required = True
+
+    assert oas.spec == {
+        "openapi": "3.0.0",
+        "paths": {
+            "/users/{petId}": {
+                "get": {
+                    "parameters": [
+                        {
+                            "description": "ID of pet that needs to be updated",
+                            "in": "path",
+                            "name": "petId",
+                            "required": True,
+                        }
+                    ]
+                }
+            }
+        },
+    }
+
+
+def test_paths_operation_requestBody():
+    oas = OpenApiSpec3()
+    request_body = oas.paths["/users/{petId}"].get.request_body
+    request_body.description = "user to add to the system"
+    request_body.content = {
+        "application/json": {
+            "schema": {"$ref": "#/components/schemas/User"},
+            "examples": {
+                "user": {
+                    "summary": "User Example",
+                    "externalValue": "http://foo.bar/examples/user-example.json",
+                }
+            },
+        }
+    }
+    request_body.required = True
+    assert oas.spec == {
+        "openapi": "3.0.0",
+        "paths": {
+            "/users/{petId}": {
+                "get": {
+                    "requestBody": {
+                        "content": {
+                            "application/json": {
+                                "examples": {
+                                    "user": {
+                                        "externalValue": "http://foo.bar/examples/user-example.json",
+                                        "summary": "User Example",
+                                    }
+                                },
+                                "schema": {"$ref": "#/components/schemas/User"},
+                            }
+                        },
+                        "description": "user to add to the system",
+                        "required": True,
+                    }
+                }
+            }
+        },
+    }
+
+
+def test_paths_operation_responses():
+    oas = OpenApiSpec3()
+    response = oas.paths["/users/{petId}"].get.responses[200]
+    response.description = "A complex object array response"
+    response.content = {
+        "application/json": {
+            "schema": {
+                "type": "array",
+                "items": {"$ref": "#/components/schemas/VeryComplexType"},
+            }
+        }
+    }

tests/test_oas/test_struct/test_servers.py

@@ -0,0 +1,36 @@
+import pytest
+
+from aiohttp_pydantic.oas.struct import OpenApiSpec3
+
+
+def test_sever_url():
+    oas = OpenApiSpec3()
+    oas.servers[0].url = "https://development.gigantic-server.com/v1"
+    oas.servers[1].url = "https://development.gigantic-server.com/v2"
+    assert oas.spec == {
+        "openapi": "3.0.0",
+        "servers": [
+            {"url": "https://development.gigantic-server.com/v1"},
+            {"url": "https://development.gigantic-server.com/v2"},
+        ],
+    }
+
+
+def test_sever_description():
+    oas = OpenApiSpec3()
+    oas.servers[0].url = "https://development.gigantic-server.com/v1"
+    oas.servers[0].description = "Development server"
+    assert oas.spec == {
+        "openapi": "3.0.0",
+        "servers": [
+            {
+                "url": "https://development.gigantic-server.com/v1",
+                "description": "Development server",
+            }
+        ],
+    }
+
+
+@pytest.mark.skip("Not yet implemented")
+def test_sever_variables():
+    oas = OpenApiSpec3()

tests/test_oas/test_view.py

@@ -1,4 +1,5 @@
-from typing import List, Union
+from typing import List, Optional, Union
+from uuid import UUID
 
 import pytest
 from aiohttp import web
@@ -14,10 +15,16 @@ class Pet(BaseModel):
 
 
 class PetCollectionView(PydanticView):
-    async def get(self) -> r200[List[Pet]]:
+    async def get(
+        self, format: str, name: Optional[str] = None, *, promo: Optional[UUID] = None
+    ) -> r200[List[Pet]]:
+        """
+        Get a list of pets
+        """
         return web.json_response()
 
     async def post(self, pet: Pet) -> r201[Pet]:
+        """Create a Pet"""
         return web.json_response()
 
 
@@ -52,31 +59,53 @@ async def test_generated_oas_should_have_pets_paths(generated_oas):
 
 async def test_pets_route_should_have_get_method(generated_oas):
     assert generated_oas["paths"]["/pets"]["get"] == {
+        "description": "Get a list of pets",
+        "parameters": [
+            {
+                "in": "query",
+                "name": "format",
+                "required": True,
+                "schema": {"type": "string"},
+            },
+            {
+                "in": "query",
+                "name": "name",
+                "required": False,
+                "schema": {"type": "string"},
+            },
+            {
+                "in": "header",
+                "name": "promo",
+                "required": False,
+                "schema": {"format": "uuid", "type": "string"},
+            },
+        ],
         "responses": {
             "200": {
                 "content": {
                     "application/json": {
                         "schema": {
-                            "type": "array",
                             "items": {
-                                "title": "Pet",
-                                "type": "object",
                                 "properties": {
                                     "id": {"title": "Id", "type": "integer"},
                                     "name": {"title": "Name", "type": "string"},
                                 },
                                 "required": ["id", "name"],
+                                "title": "Pet",
+                                "type": "object",
                             },
+                            "type": "array",
                         }
                     }
                 }
             }
-        }
+        },
     }
 
 
 async def test_pets_route_should_have_post_method(generated_oas):
     assert generated_oas["paths"]["/pets"]["post"] == {
+        "description": "Create a Pet",
         "requestBody": {
             "content": {
                 "application/json": {

tests/test_validation_query_string.py

@@ -1,11 +1,13 @@
+from typing import Optional
+
 from aiohttp import web
 
 from aiohttp_pydantic import PydanticView
 
 
 class ArticleView(PydanticView):
-    async def get(self, with_comments: bool):
+    async def get(self, with_comments: bool, age: Optional[int] = None):
-        return web.json_response({"with_comments": with_comments})
+        return web.json_response({"with_comments": with_comments, "age": age})
 
 
 async def test_get_article_without_required_qs_should_return_an_error_message(
@@ -53,7 +55,22 @@ async def test_get_article_with_valid_qs_should_return_the_parsed_type(
     app.router.add_view("/article", ArticleView)
 
     client = await aiohttp_client(app)
+
+    resp = await client.get("/article", params={"with_comments": "yes", "age": 3})
+    assert resp.status == 200
+    assert resp.content_type == "application/json"
+    assert await resp.json() == {"with_comments": True, "age": 3}
+
+
+async def test_get_article_with_valid_qs_and_omitted_optional_should_return_none(
+    aiohttp_client, loop
+):
+    app = web.Application()
+    app.router.add_view("/article", ArticleView)
+
+    client = await aiohttp_client(app)
+
     resp = await client.get("/article", params={"with_comments": "yes"})
     assert resp.status == 200
     assert resp.content_type == "application/json"
-    assert await resp.json() == {"with_comments": True}
+    assert await resp.json() == {"with_comments": True, "age": None}