Nested Response class can be defined in method

Author: vvcheremushkin

setup.py

@@ -29,7 +29,7 @@ def get_packages(package):
         "starlette<=1",
         "apispec<3",
     ],
-    version="0.0.9",
+    version="0.0.10",
     url="https://github.com/slv0/start_resty",
     license="BSD",
     description="The web framework",

star_resty/method/meta.py

@@ -27,6 +27,9 @@ def __new__(mcs, name, bases, attrs, **kwargs):
     def create_render(mcs, method):
         renders = []
         response_schema = getattr(method, 'response_schema', None)
+        if response_schema is None:
+            response_schema = getattr(method, 'Response', None)
+
         if response_schema is not None:
             if inspect.isclass(response_schema):
                 response_schema = response_schema()

star_resty/method/method.py

@@ -1,6 +1,6 @@
 import abc
 from functools import wraps
-from typing import ClassVar, Type, Union
+from typing import ClassVar, Type, Union, Optional
 
 from marshmallow import Schema
 from starlette.requests import Request
@@ -20,6 +20,7 @@ class Method(abc.ABC, metaclass=MethodMeta):
     meta: ClassVar[Operation] = Operation(tag='default')
     serializer: ClassVar[Serializer] = JsonSerializer
     response_schema: ClassVar[Union[Schema, Type[Schema], None]] = None
+    Response: ClassVar[Optional[Type[Schema]]] = None
     status_code: int = 200
 
     def __init__(self, request: Request):

star_resty/operation/schema.py

@@ -5,5 +5,4 @@ class Operation(NamedTuple):
     tag: str = 'default'
     description: Optional[str] = None
     summary: Optional[str] = None
-    status: int = 200
     errors: Sequence[Any] = ()

tests/test_apidocs.py

@@ -95,15 +95,12 @@ def test_generate_api_docs_for_path():
     assert body is not None
     assert body.get('paths') == {
         '/users/{user_id}': {
-            'post': {
-                'tags': ['users'], 'description': 'get user', 'produces': ['application/json'],
-                'parameters': [
-                    {'in': 'path', 'name': 'id', 'required': True, 'type': 'integer', 'format': 'int32'},
-                    {'in': 'body', 'required': False, 'name': 'body',
-                     'schema': {'$ref': '#/definitions/tests.utils.method.BodySchema'}}],
-                'responses': {
-                    '200': {'schema': {'$ref': '#/definitions/tests.utils.method.CreateUserResponse'}},
-                    '400': {'description': 'Bad request'}}}}}
+            'post': {'tags': ['users'], 'description': 'get user', 'produces': ['application/json'],
+                     'parameters': [
+                         {'in': 'path', 'name': 'id', 'required': True, 'type': 'integer', 'format': 'int32'},
+                         {'in': 'body', 'required': False, 'name': 'body',
+                          'schema': {'$ref': '#/definitions/tests.utils.method.BodySchema'}}],
+                     'responses': {'400': {'description': 'Bad request'}}}}}
 
 
 def test_generate_api_docs_for_nested():

tests/test_method.py

@@ -44,3 +44,25 @@ async def execute(self):
     endpoint = TestMethod.as_endpoint()
     with pytest.raises(DumpError):
         await endpoint(request)
+
+
+@pytest.mark.asyncio
+async def test_response_schema_cls():
+    class TestMethod(Method):
+        class Response(Schema):
+            id = fields.Integer()
+
+        async def execute(self):
+            return {'id': 1}
+
+    request = mock.MagicMock(spec_set=Request)
+    endpoint = TestMethod.as_endpoint()
+    resp = await endpoint(request)
+    assert resp is not None
+    assert isinstance(resp, Response)
+    assert resp.status_code == 200
+    assert resp.media_type == 'application/json'
+    body = resp.body
+    assert body is not None
+    user = json.loads(body)
+    assert user == {'id': 1}

tests/utils/method.py

@@ -58,7 +58,9 @@ async def execute(self, user: path(PathParams),
 
 class GetUser(Method):
     meta = Operation(tag='users', description='get user')
-    response_schema = CreateUserResponse
+
+    class Response(CreateUserResponse):
+        pass
 
     async def execute(self, user: path(PathParams),
                       payload: json_payload(BodySchema)):