Compare commits
5 Commits
v1.6.0
...
fix-defini
Author | SHA1 | Date | |
---|---|---|---|
|
6ba671532b | ||
|
efbaaa5e6f | ||
|
6211c71875 | ||
|
5567d73952 | ||
|
67a95ec9c9 |
@@ -68,7 +68,6 @@ Example:
|
||||
$ curl -X GET http://127.0.0.1:8080/article?with_comments=a
|
||||
[
|
||||
{
|
||||
"in": "query string",
|
||||
"loc": [
|
||||
"with_comments"
|
||||
],
|
||||
@@ -83,7 +82,6 @@ Example:
|
||||
$ curl -H "Content-Type: application/json" -X post http://127.0.0.1:8080/article --data '{}'
|
||||
[
|
||||
{
|
||||
"in": "body",
|
||||
"loc": [
|
||||
"name"
|
||||
],
|
||||
@@ -118,7 +116,7 @@ Example:
|
||||
Inject Query String Parameters
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To declare a query parameters, you must declare your argument as a simple argument:
|
||||
To declare a query parameters, you must declare your argument as simple argument:
|
||||
|
||||
|
||||
.. code-block:: python3
|
||||
@@ -133,7 +131,7 @@ To declare a query parameters, you must declare your argument as a simple argume
|
||||
Inject Request Body
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To declare a body parameter, you must declare your argument as a simple argument annotated with `pydantic Model`_.
|
||||
To declare a body parameters, you must declare your argument as a simple argument annotated with `pydantic Model`_.
|
||||
|
||||
|
||||
.. code-block:: python3
|
||||
|
@@ -1,5 +1,5 @@
|
||||
from .view import PydanticView
|
||||
|
||||
__version__ = "1.6.0"
|
||||
__version__ = "1.5.1"
|
||||
|
||||
__all__ = ("PydanticView", "__version__")
|
||||
|
@@ -15,16 +15,8 @@ class AbstractInjector(metaclass=abc.ABCMeta):
|
||||
An injector parse HTTP request and inject params to the view.
|
||||
"""
|
||||
|
||||
@property
|
||||
@abc.abstractmethod
|
||||
def context(self) -> str:
|
||||
"""
|
||||
The name of part of parsed request
|
||||
i.e "HTTP header", "URL path", ...
|
||||
"""
|
||||
|
||||
@abc.abstractmethod
|
||||
def __init__(self, args_spec: dict, default_values: dict):
|
||||
def __init__(self, args_spec: dict):
|
||||
"""
|
||||
args_spec - ordered mapping: arg_name -> type
|
||||
"""
|
||||
@@ -41,12 +33,8 @@ class MatchInfoGetter(AbstractInjector):
|
||||
Validates and injects the part of URL path inside the view positional args.
|
||||
"""
|
||||
|
||||
context = "path"
|
||||
|
||||
def __init__(self, args_spec: dict, default_values: dict):
|
||||
attrs = {"__annotations__": args_spec}
|
||||
attrs.update(default_values)
|
||||
self.model = type("PathModel", (BaseModel,), attrs)
|
||||
def __init__(self, args_spec: dict):
|
||||
self.model = type("PathModel", (BaseModel,), {"__annotations__": args_spec})
|
||||
|
||||
def inject(self, request: BaseRequest, args_view: list, kwargs_view: dict):
|
||||
args_view.extend(self.model(**request.match_info).dict().values())
|
||||
@@ -57,9 +45,7 @@ class BodyGetter(AbstractInjector):
|
||||
Validates and injects the content of request body inside the view kwargs.
|
||||
"""
|
||||
|
||||
context = "body"
|
||||
|
||||
def __init__(self, args_spec: dict, default_values: dict):
|
||||
def __init__(self, args_spec: dict):
|
||||
self.arg_name, self.model = next(iter(args_spec.items()))
|
||||
|
||||
async def inject(self, request: BaseRequest, args_view: list, kwargs_view: dict):
|
||||
@@ -78,12 +64,8 @@ class QueryGetter(AbstractInjector):
|
||||
Validates and injects the query string inside the view kwargs.
|
||||
"""
|
||||
|
||||
context = "query string"
|
||||
|
||||
def __init__(self, args_spec: dict, default_values: dict):
|
||||
attrs = {"__annotations__": args_spec}
|
||||
attrs.update(default_values)
|
||||
self.model = type("QueryModel", (BaseModel,), attrs)
|
||||
def __init__(self, args_spec: dict):
|
||||
self.model = type("QueryModel", (BaseModel,), {"__annotations__": args_spec})
|
||||
|
||||
def inject(self, request: BaseRequest, args_view: list, kwargs_view: dict):
|
||||
kwargs_view.update(self.model(**request.query).dict())
|
||||
@@ -94,33 +76,27 @@ class HeadersGetter(AbstractInjector):
|
||||
Validates and injects the HTTP headers inside the view kwargs.
|
||||
"""
|
||||
|
||||
context = "headers"
|
||||
|
||||
def __init__(self, args_spec: dict, default_values: dict):
|
||||
attrs = {"__annotations__": args_spec}
|
||||
attrs.update(default_values)
|
||||
self.model = type("HeaderModel", (BaseModel,), attrs)
|
||||
def __init__(self, args_spec: dict):
|
||||
self.model = type("HeaderModel", (BaseModel,), {"__annotations__": args_spec})
|
||||
|
||||
def inject(self, request: BaseRequest, args_view: list, kwargs_view: dict):
|
||||
header = {k.lower().replace("-", "_"): v for k, v in request.headers.items()}
|
||||
kwargs_view.update(self.model(**header).dict())
|
||||
|
||||
|
||||
def _parse_func_signature(func: Callable) -> Tuple[dict, dict, dict, dict, dict]:
|
||||
def _parse_func_signature(func: Callable) -> Tuple[dict, dict, dict, dict]:
|
||||
"""
|
||||
Analyse function signature and returns 4-tuple:
|
||||
0 - arguments will be set from the url path
|
||||
1 - argument will be set from the request body.
|
||||
2 - argument will be set from the query string.
|
||||
3 - argument will be set from the HTTP headers.
|
||||
4 - Default value for each parameters
|
||||
"""
|
||||
|
||||
path_args = {}
|
||||
body_args = {}
|
||||
qs_args = {}
|
||||
header_args = {}
|
||||
defaults = {}
|
||||
|
||||
for param_name, param_spec in signature(func).parameters.items():
|
||||
if param_name == "self":
|
||||
@@ -129,12 +105,8 @@ def _parse_func_signature(func: Callable) -> Tuple[dict, dict, dict, dict, dict]
|
||||
if param_spec.annotation == param_spec.empty:
|
||||
raise RuntimeError(f"The parameter {param_name} must have an annotation")
|
||||
|
||||
if param_spec.default is not param_spec.empty:
|
||||
defaults[param_name] = param_spec.default
|
||||
|
||||
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 is_pydantic_base_model(param_spec.annotation):
|
||||
body_args[param_name] = param_spec.annotation
|
||||
@@ -145,4 +117,4 @@ def _parse_func_signature(func: Callable) -> Tuple[dict, dict, dict, dict, dict]
|
||||
else:
|
||||
raise RuntimeError(f"You cannot use {param_spec.VAR_POSITIONAL} parameters")
|
||||
|
||||
return path_args, body_args, qs_args, header_args, defaults
|
||||
return path_args, body_args, qs_args, header_args
|
||||
|
@@ -13,10 +13,13 @@ def setup(
|
||||
apps_to_expose: Iterable[web.Application] = (),
|
||||
url_prefix: str = "/oas",
|
||||
enable: bool = True,
|
||||
raise_validation_errors: bool = False,
|
||||
):
|
||||
if enable:
|
||||
oas_app = web.Application()
|
||||
oas_app["apps to expose"] = tuple(apps_to_expose) or (app,)
|
||||
for a in oas_app["apps to expose"]:
|
||||
a['raise_validation_errors'] = raise_validation_errors
|
||||
oas_app["index template"] = jinja2.Template(
|
||||
resources.read_text("aiohttp_pydantic.oas", "index.j2")
|
||||
)
|
||||
|
@@ -312,3 +312,8 @@ class OpenApiSpec3:
|
||||
@property
|
||||
def spec(self):
|
||||
return self._spec
|
||||
|
||||
@property
|
||||
def definitions(self):
|
||||
self._spec.setdefault('definitions', {})
|
||||
return self._spec['definitions']
|
@@ -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)
|
||||
|
||||
|
@@ -7,7 +7,6 @@ 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
|
||||
|
||||
@@ -48,13 +47,21 @@ class _OASResponseBuilder:
|
||||
generate the OAS operation response.
|
||||
"""
|
||||
|
||||
def __init__(self, oas_operation):
|
||||
def __init__(self, oas_operation, definitions):
|
||||
self._oas_operation = oas_operation
|
||||
self._definitions = definitions
|
||||
|
||||
@staticmethod
|
||||
def _handle_pydantic_base_model(obj):
|
||||
def _process_definitions(self, schema):
|
||||
if 'definitions' in schema:
|
||||
for k, v in schema['definitions'].items():
|
||||
self._definitions[k] = v
|
||||
|
||||
return {i:schema[i] for i in schema if i!='definitions'}
|
||||
|
||||
def _handle_pydantic_base_model(self, obj):
|
||||
if is_pydantic_base_model(obj):
|
||||
return obj.schema()
|
||||
return self._process_definitions(obj.schema())
|
||||
|
||||
return {}
|
||||
|
||||
def _handle_list(self, obj):
|
||||
@@ -89,14 +96,12 @@ class _OASResponseBuilder:
|
||||
|
||||
|
||||
def _add_http_method_to_oas(
|
||||
oas_path: PathItem, http_method: str, view: Type[PydanticView]
|
||||
oas_path: PathItem, http_method: str, view: Type[PydanticView], definitions: dict
|
||||
):
|
||||
http_method = http_method.lower()
|
||||
oas_operation: OperationObject = getattr(oas_path, http_method)
|
||||
handler = getattr(view, http_method)
|
||||
path_args, body_args, qs_args, header_args, defaults = _parse_func_signature(
|
||||
handler
|
||||
)
|
||||
path_args, body_args, qs_args, header_args = _parse_func_signature(handler)
|
||||
description = getdoc(handler)
|
||||
if description:
|
||||
oas_operation.description = description
|
||||
@@ -117,19 +122,16 @@ def _add_http_method_to_oas(
|
||||
oas_operation.parameters[i].in_ = args_location
|
||||
oas_operation.parameters[i].name = name
|
||||
optional_type = _handle_optional(type_)
|
||||
|
||||
attrs = {"__annotations__": {"__root__": type_}}
|
||||
if name in defaults:
|
||||
attrs["__root__"] = defaults[name]
|
||||
|
||||
oas_operation.parameters[i].schema = type(
|
||||
name, (BaseModel,), attrs
|
||||
).schema()
|
||||
oas_operation.parameters[i].required = optional_type is None
|
||||
if optional_type is None:
|
||||
oas_operation.parameters[i].schema = JSON_SCHEMA_TYPES[type_]
|
||||
oas_operation.parameters[i].required = True
|
||||
else:
|
||||
oas_operation.parameters[i].schema = JSON_SCHEMA_TYPES[optional_type]
|
||||
oas_operation.parameters[i].required = False
|
||||
|
||||
return_type = handler.__annotations__.get("return")
|
||||
if return_type is not None:
|
||||
_OASResponseBuilder(oas_operation).build(return_type)
|
||||
_OASResponseBuilder(oas_operation, definitions).build(return_type)
|
||||
|
||||
|
||||
def generate_oas(apps: List[Application]) -> dict:
|
||||
@@ -137,20 +139,19 @@ def generate_oas(apps: List[Application]) -> dict:
|
||||
Generate and return Open Api Specification from PydanticView in application.
|
||||
"""
|
||||
oas = OpenApiSpec3()
|
||||
|
||||
for app in apps:
|
||||
for resources in app.router.resources():
|
||||
for resource_route in resources:
|
||||
if not is_pydantic_view(resource_route.handler):
|
||||
continue
|
||||
|
||||
view: Type[PydanticView] = resource_route.handler
|
||||
info = resource_route.get_info()
|
||||
path = oas.paths[info.get("path", info.get("formatter"))]
|
||||
if resource_route.method == "*":
|
||||
for method_name in view.allowed_methods:
|
||||
_add_http_method_to_oas(path, method_name, view)
|
||||
else:
|
||||
_add_http_method_to_oas(path, resource_route.method, view)
|
||||
if is_pydantic_view(resource_route.handler):
|
||||
view: Type[PydanticView] = resource_route.handler
|
||||
info = resource_route.get_info()
|
||||
path = oas.paths[info.get("path", info.get("formatter"))]
|
||||
if resource_route.method == "*":
|
||||
for method_name in view.allowed_methods:
|
||||
_add_http_method_to_oas(path, method_name, view, oas.definitions)
|
||||
else:
|
||||
_add_http_method_to_oas(path, resource_route.method, view, oas.definitions)
|
||||
|
||||
return oas.spec
|
||||
|
||||
@@ -171,6 +172,9 @@ async def oas_ui(request):
|
||||
|
||||
static_url = request.app.router["static"].url_for(filename="")
|
||||
spec_url = request.app.router["spec"].url_for()
|
||||
|
||||
if request.scheme != request.headers.get('x-forwarded-proto', request.scheme):
|
||||
request = request.clone(scheme=request.headers['x-forwarded-proto'])
|
||||
host = request.url.origin()
|
||||
|
||||
return Response(
|
||||
|
@@ -9,8 +9,14 @@ from aiohttp.web_exceptions import HTTPMethodNotAllowed
|
||||
from aiohttp.web_response import StreamResponse
|
||||
from pydantic import ValidationError
|
||||
|
||||
from .injectors import (AbstractInjector, BodyGetter, HeadersGetter,
|
||||
MatchInfoGetter, QueryGetter, _parse_func_signature)
|
||||
from .injectors import (
|
||||
AbstractInjector,
|
||||
BodyGetter,
|
||||
HeadersGetter,
|
||||
MatchInfoGetter,
|
||||
QueryGetter,
|
||||
_parse_func_signature,
|
||||
)
|
||||
|
||||
|
||||
class PydanticView(AbstractView):
|
||||
@@ -44,25 +50,16 @@ class PydanticView(AbstractView):
|
||||
|
||||
@staticmethod
|
||||
def parse_func_signature(func: Callable) -> Iterable[AbstractInjector]:
|
||||
path_args, body_args, qs_args, header_args, defaults = _parse_func_signature(
|
||||
func
|
||||
)
|
||||
path_args, body_args, qs_args, header_args = _parse_func_signature(func)
|
||||
injectors = []
|
||||
|
||||
def default_value(args: dict) -> dict:
|
||||
"""
|
||||
Returns the default values of args.
|
||||
"""
|
||||
return {name: defaults[name] for name in args if name in defaults}
|
||||
|
||||
if path_args:
|
||||
injectors.append(MatchInfoGetter(path_args, default_value(path_args)))
|
||||
injectors.append(MatchInfoGetter(path_args))
|
||||
if body_args:
|
||||
injectors.append(BodyGetter(body_args, default_value(body_args)))
|
||||
injectors.append(BodyGetter(body_args))
|
||||
if qs_args:
|
||||
injectors.append(QueryGetter(qs_args, default_value(qs_args)))
|
||||
injectors.append(QueryGetter(qs_args))
|
||||
if header_args:
|
||||
injectors.append(HeadersGetter(header_args, default_value(header_args)))
|
||||
injectors.append(HeadersGetter(header_args))
|
||||
return injectors
|
||||
|
||||
|
||||
@@ -86,11 +83,10 @@ def inject_params(
|
||||
else:
|
||||
injector.inject(self.request, args, kwargs)
|
||||
except ValidationError as error:
|
||||
errors = error.errors()
|
||||
for error in errors:
|
||||
error["in"] = injector.context
|
||||
|
||||
return json_response(data=errors, status=400)
|
||||
if self.request.app['raise_validation_errors']:
|
||||
raise
|
||||
else:
|
||||
return json_response(text=error.json(), status=400)
|
||||
|
||||
return await handler(self, *args, **kwargs)
|
||||
|
||||
|
@@ -30,7 +30,6 @@ def test_show_oad_of_app(cmd_line, capfd):
|
||||
"name": "a",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"title": "a",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
@@ -45,7 +44,6 @@ def test_show_oad_of_app(cmd_line, capfd):
|
||||
"name": "b",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"title": "b",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
@@ -77,7 +75,6 @@ def test_show_oad_of_sub_app(cmd_line, capfd):
|
||||
"name": "b",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"title": "b",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
@@ -109,7 +106,6 @@ def test_show_oad_of_a_callable(cmd_line, capfd):
|
||||
"name": "a",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"title": "a",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
|
@@ -65,19 +65,19 @@ async def test_pets_route_should_have_get_method(generated_oas):
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"required": True,
|
||||
"schema": {"title": "format", "type": "string"},
|
||||
"schema": {"type": "string"},
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "name",
|
||||
"required": False,
|
||||
"schema": {"title": "name", "type": "string"},
|
||||
"schema": {"type": "string"},
|
||||
},
|
||||
{
|
||||
"in": "header",
|
||||
"name": "promo",
|
||||
"required": False,
|
||||
"schema": {"title": "promo", "format": "uuid", "type": "string"},
|
||||
"schema": {"format": "uuid", "type": "string"},
|
||||
},
|
||||
],
|
||||
"responses": {
|
||||
@@ -152,7 +152,7 @@ async def test_pets_id_route_should_have_delete_method(generated_oas):
|
||||
"required": True,
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"schema": {"title": "id", "type": "integer"},
|
||||
"schema": {"type": "integer"},
|
||||
}
|
||||
],
|
||||
"responses": {"204": {"content": {}}},
|
||||
@@ -166,7 +166,7 @@ async def test_pets_id_route_should_have_get_method(generated_oas):
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"required": True,
|
||||
"schema": {"title": "id", "type": "integer"},
|
||||
"schema": {"type": "integer"},
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@@ -197,7 +197,7 @@ async def test_pets_id_route_should_have_put_method(generated_oas):
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"required": True,
|
||||
"schema": {"title": "id", "type": "integer"},
|
||||
"schema": {"type": "integer"},
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
|
@@ -38,42 +38,32 @@ def test_parse_func_signature():
|
||||
def path_body_qs_and_header(self, id: str, /, user: User, page: int, *, auth: UUID):
|
||||
pass
|
||||
|
||||
assert _parse_func_signature(body_only) == ({}, {"user": User}, {}, {}, {})
|
||||
assert _parse_func_signature(path_only) == ({"id": str}, {}, {}, {}, {})
|
||||
assert _parse_func_signature(qs_only) == ({}, {}, {"page": int}, {}, {})
|
||||
assert _parse_func_signature(header_only) == ({}, {}, {}, {"auth": UUID}, {})
|
||||
assert _parse_func_signature(path_and_qs) == (
|
||||
{"id": str},
|
||||
{},
|
||||
{"page": int},
|
||||
{},
|
||||
{},
|
||||
)
|
||||
assert _parse_func_signature(body_only) == ({}, {"user": User}, {}, {})
|
||||
assert _parse_func_signature(path_only) == ({"id": str}, {}, {}, {})
|
||||
assert _parse_func_signature(qs_only) == ({}, {}, {"page": int}, {})
|
||||
assert _parse_func_signature(header_only) == ({}, {}, {}, {"auth": UUID})
|
||||
assert _parse_func_signature(path_and_qs) == ({"id": str}, {}, {"page": int}, {})
|
||||
assert _parse_func_signature(path_and_header) == (
|
||||
{"id": str},
|
||||
{},
|
||||
{},
|
||||
{"auth": UUID},
|
||||
{},
|
||||
)
|
||||
assert _parse_func_signature(qs_and_header) == (
|
||||
{},
|
||||
{},
|
||||
{"page": int},
|
||||
{"auth": UUID},
|
||||
{},
|
||||
)
|
||||
assert _parse_func_signature(path_qs_and_header) == (
|
||||
{"id": str},
|
||||
{},
|
||||
{"page": int},
|
||||
{"auth": UUID},
|
||||
{},
|
||||
)
|
||||
assert _parse_func_signature(path_body_qs_and_header) == (
|
||||
{"id": str},
|
||||
{"user": User},
|
||||
{"page": int},
|
||||
{"auth": UUID},
|
||||
{},
|
||||
)
|
||||
|
@@ -27,12 +27,7 @@ async def test_post_an_article_without_required_field_should_return_an_error_mes
|
||||
assert resp.status == 400
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == [
|
||||
{
|
||||
"in": "body",
|
||||
"loc": ["name"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
}
|
||||
{"loc": ["name"], "msg": "field required", "type": "value_error.missing"}
|
||||
]
|
||||
|
||||
|
||||
@@ -48,7 +43,6 @@ async def test_post_an_article_with_wrong_type_field_should_return_an_error_mess
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == [
|
||||
{
|
||||
"in": "body",
|
||||
"loc": ["nb_page"],
|
||||
"msg": "value is not a valid integer",
|
||||
"type": "type_error.integer",
|
||||
|
@@ -1,6 +1,5 @@
|
||||
import json
|
||||
from datetime import datetime
|
||||
from enum import Enum
|
||||
|
||||
from aiohttp import web
|
||||
|
||||
@@ -22,16 +21,6 @@ class ArticleView(PydanticView):
|
||||
)
|
||||
|
||||
|
||||
class FormatEnum(str, Enum):
|
||||
UTM = "UMT"
|
||||
MGRS = "MGRS"
|
||||
|
||||
|
||||
class ViewWithEnumType(PydanticView):
|
||||
async def get(self, *, format: FormatEnum):
|
||||
return web.json_response({"format": format}, dumps=JSONEncoder().encode)
|
||||
|
||||
|
||||
async def test_get_article_without_required_header_should_return_an_error_message(
|
||||
aiohttp_client, loop
|
||||
):
|
||||
@@ -44,7 +33,6 @@ async def test_get_article_without_required_header_should_return_an_error_messag
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == [
|
||||
{
|
||||
"in": "headers",
|
||||
"loc": ["signature_expired"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
@@ -64,7 +52,6 @@ async def test_get_article_with_wrong_header_type_should_return_an_error_message
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == [
|
||||
{
|
||||
"in": "headers",
|
||||
"loc": ["signature_expired"],
|
||||
"msg": "invalid datetime format",
|
||||
"type": "value_error.datetime",
|
||||
@@ -100,37 +87,3 @@ async def test_get_article_with_valid_header_containing_hyphen_should_be_returne
|
||||
assert resp.status == 200
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == {"signature": "2020-10-04T18:01:00"}
|
||||
|
||||
|
||||
async def test_wrong_value_to_header_defined_with_str_enum(aiohttp_client, loop):
|
||||
app = web.Application()
|
||||
app.router.add_view("/coord", ViewWithEnumType)
|
||||
|
||||
client = await aiohttp_client(app)
|
||||
resp = await client.get("/coord", headers={"format": "WGS84"})
|
||||
assert (
|
||||
await resp.json()
|
||||
== [
|
||||
{
|
||||
"ctx": {"enum_values": ["UMT", "MGRS"]},
|
||||
"in": "headers",
|
||||
"loc": ["format"],
|
||||
"msg": "value is not a valid enumeration member; permitted: 'UMT', 'MGRS'",
|
||||
"type": "type_error.enum",
|
||||
}
|
||||
]
|
||||
!= {"signature": "2020-10-04T18:01:00"}
|
||||
)
|
||||
assert resp.status == 400
|
||||
assert resp.content_type == "application/json"
|
||||
|
||||
|
||||
async def test_correct_value_to_header_defined_with_str_enum(aiohttp_client, loop):
|
||||
app = web.Application()
|
||||
app.router.add_view("/coord", ViewWithEnumType)
|
||||
|
||||
client = await aiohttp_client(app)
|
||||
resp = await client.get("/coord", headers={"format": "UMT"})
|
||||
assert await resp.json() == {"format": "UMT"}
|
||||
assert resp.status == 200
|
||||
assert resp.content_type == "application/json"
|
||||
|
@@ -8,7 +8,7 @@ class ArticleView(PydanticView):
|
||||
return web.json_response({"path": [author_id, tag, date]})
|
||||
|
||||
|
||||
async def test_get_article_with_correct_path_parameters_should_return_parameters_in_path(
|
||||
async def test_get_article_without_required_qs_should_return_an_error_message(
|
||||
aiohttp_client, loop
|
||||
):
|
||||
app = web.Application()
|
||||
@@ -19,23 +19,3 @@ async def test_get_article_with_correct_path_parameters_should_return_parameters
|
||||
assert resp.status == 200
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == {"path": ["1234", "music", 1980]}
|
||||
|
||||
|
||||
async def test_get_article_with_wrong_path_parameters_should_return_error(
|
||||
aiohttp_client, loop
|
||||
):
|
||||
app = web.Application()
|
||||
app.router.add_view("/article/{author_id}/tag/{tag}/before/{date}", ArticleView)
|
||||
|
||||
client = await aiohttp_client(app)
|
||||
resp = await client.get("/article/1234/tag/music/before/now")
|
||||
assert resp.status == 400
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == [
|
||||
{
|
||||
"in": "path",
|
||||
"loc": ["date"],
|
||||
"msg": "value is not a valid integer",
|
||||
"type": "type_error.integer",
|
||||
}
|
||||
]
|
||||
|
@@ -6,12 +6,8 @@ from aiohttp_pydantic import PydanticView
|
||||
|
||||
|
||||
class ArticleView(PydanticView):
|
||||
async def get(
|
||||
self, with_comments: bool, age: Optional[int] = None, nb_items: int = 7
|
||||
):
|
||||
return web.json_response(
|
||||
{"with_comments": with_comments, "age": age, "nb_items": nb_items}
|
||||
)
|
||||
async def get(self, with_comments: bool, age: Optional[int] = None):
|
||||
return web.json_response({"with_comments": with_comments, "age": age})
|
||||
|
||||
|
||||
async def test_get_article_without_required_qs_should_return_an_error_message(
|
||||
@@ -26,7 +22,6 @@ async def test_get_article_without_required_qs_should_return_an_error_message(
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == [
|
||||
{
|
||||
"in": "query string",
|
||||
"loc": ["with_comments"],
|
||||
"msg": "field required",
|
||||
"type": "value_error.missing",
|
||||
@@ -46,7 +41,6 @@ async def test_get_article_with_wrong_qs_type_should_return_an_error_message(
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == [
|
||||
{
|
||||
"in": "query string",
|
||||
"loc": ["with_comments"],
|
||||
"msg": "value could not be parsed to a boolean",
|
||||
"type": "type_error.bool",
|
||||
@@ -65,10 +59,10 @@ async def test_get_article_with_valid_qs_should_return_the_parsed_type(
|
||||
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, "nb_items": 7}
|
||||
assert await resp.json() == {"with_comments": True, "age": 3}
|
||||
|
||||
|
||||
async def test_get_article_with_valid_qs_and_omitted_optional_should_return_default_value(
|
||||
async def test_get_article_with_valid_qs_and_omitted_optional_should_return_none(
|
||||
aiohttp_client, loop
|
||||
):
|
||||
app = web.Application()
|
||||
@@ -77,6 +71,6 @@ async def test_get_article_with_valid_qs_and_omitted_optional_should_return_defa
|
||||
client = await aiohttp_client(app)
|
||||
|
||||
resp = await client.get("/article", params={"with_comments": "yes"})
|
||||
assert await resp.json() == {"with_comments": True, "age": None, "nb_items": 7}
|
||||
assert resp.status == 200
|
||||
assert resp.content_type == "application/json"
|
||||
assert await resp.json() == {"with_comments": True, "age": None}
|
||||
|
Reference in New Issue
Block a user