Added openapi module testing and some code refactoring

Author: eadwinCode

ellar/common/__init__.py

@@ -8,7 +8,7 @@
 from .decorators.html import render, template_filter, template_global
 from .decorators.middleware import middleware
 from .decorators.modules import Module
-from .decorators.openapi import openapi
+from .decorators.openapi import openapi_info
 from .decorators.request import on_shutdown, on_startup
 from .decorators.serializer import serializer_filter
 from .decorators.versioning import version
@@ -48,7 +48,7 @@
     "ParamTypes",
     "set_meta",
     "Controller",
-    "openapi",
+    "openapi_info",
     "version",
     "delete",
     "get",

ellar/common/decorators/__init__.py

@@ -5,7 +5,7 @@
 from .html import render, template_filter, template_global  # noqa
 from .middleware import middleware  # noqa
 from .modules import Module  # noqa
-from .openapi import openapi  # noqa
+from .openapi import openapi_info  # noqa
 from .request import on_shutdown, on_startup  # noqa
 from .serializer import serializer_filter  # noqa
 from .versioning import version  # noqa

ellar/common/decorators/openapi.py

@@ -6,7 +6,7 @@
 from .base import set_meta
 
 
-def openapi(
+def openapi_info(
     operation_id: t.Optional[str] = None,
     summary: t.Optional[str] = None,
     description: t.Optional[str] = None,

ellar/core/modules/helper.py

@@ -1,8 +1,7 @@
+import inspect
 import typing as t
 from functools import wraps
 
-from starlette.routing import iscoroutinefunction_or_partial
-
 
 def _executor_wrapper_async(
     cls: t.Type, func: t.Callable
@@ -25,7 +24,7 @@ def _decorator(*args: t.Any, **kwargs: t.Any) -> t.Any:
 def class_parameter_executor_wrapper(
     cls: t.Type, func: t.Callable
 ) -> t.Union[t.Callable, t.Callable[..., t.Coroutine]]:
-    if iscoroutinefunction_or_partial(func):
+    if inspect.iscoroutinefunction(func):
         return _executor_wrapper_async(cls, func)
 
     return _executor_wrapper(cls, func)

ellar/core/routing/route.py

@@ -1,11 +1,8 @@
+import inspect
 import typing as t
 
 from starlette.concurrency import run_in_threadpool
-from starlette.routing import (
-    Route as StarletteRoute,
-    compile_path,
-    iscoroutinefunction_or_partial,
-)
+from starlette.routing import Route as StarletteRoute, compile_path
 
 from ellar.constants import (
     CONTROLLER_OPERATION_HANDLER_KEY,
@@ -50,7 +47,7 @@ def __init__(
         name: t.Optional[str] = None,
         include_in_schema: bool = True,
     ) -> None:
-        self._is_coroutine = iscoroutinefunction_or_partial(endpoint)
+        self._is_coroutine = inspect.iscoroutinefunction(endpoint)
         self._defined_responses: t.Dict[int, t.Type] = dict(response)
 
         assert path.startswith("/"), "Routed paths must start with '/'"

ellar/core/routing/router/module.py

@@ -118,7 +118,7 @@ def _build_ws_route_operation(self, route: WebsocketRouteOperation) -> None:
     def get_flatten_routes(self) -> t.List[BaseRoute]:
         if not self._build:
             for route in self.routes:
-                _route: RouteOperation = t.cast("RouteOperation", route)
+                _route: RouteOperation = t.cast(RouteOperation, route)
 
                 route_versioning = reflect.get_metadata(VERSIONING_KEY, _route.endpoint)
                 route_guards = reflect.get_metadata(GUARDS_KEY, _route.endpoint)
@@ -161,7 +161,7 @@ class ModuleRouter(ModuleMount):
 
     def __init__(
         self,
-        path: str,
+        path: str = "",
         name: str = None,
         tag: str = NOT_SET,
         description: str = None,

ellar/core/schema.py

@@ -3,7 +3,11 @@
 from pydantic import BaseModel, Field, root_validator, validator
 
 from ellar.constants import ROUTE_METHODS
-from ellar.core.response.model import EmptyAPIResponseModel, IResponseModel
+from ellar.core.response.model import (
+    EmptyAPIResponseModel,
+    IResponseModel,
+    create_response_model,
+)
 from ellar.serializer import BaseSerializer, Serializer
 
 if t.TYPE_CHECKING:  # pragma: no cover
@@ -70,7 +74,7 @@ def validate_root(cls, values: t.Any):
 
         response = values["response"]
         if not response:
-            values["response"] = {200: EmptyAPIResponseModel.create_model()}
+            values["response"] = {200: create_response_model(EmptyAPIResponseModel)}
         elif not isinstance(response, dict):
             values["response"] = {200: response}
         return values

ellar/openapi/builder.py

@@ -41,6 +41,12 @@ def __init__(self) -> None:
         self._build.setdefault("openapi", default_openapi_version)
 
     def set_openapi_version(self, openapi_version: str) -> "OpenAPIDocumentBuilder":
+        """
+        Sets OpenAPI version
+        This is not fully supported yet
+        :param openapi_version:
+        :return: "OpenAPIDocumentBuilder"
+        """
         self._build["openapi"] = openapi_version
         return self
 

tests/schema.py

@@ -1,7 +1,10 @@
 from dataclasses import dataclass
+from datetime import datetime
 from typing import Optional, Union
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
+
+from ellar.core.schema import Schema
 
 
 class BlogObjectDTO:
@@ -26,3 +29,15 @@ class Item(BaseModel):
 class User(BaseModel):
     username: str
     full_name: Optional[str] = None
+
+
+class Filter(Schema):
+    to_datetime: datetime = Field(alias="to")
+    from_datetime: datetime = Field(alias="from")
+
+
+class CreateCarSchema(Schema):
+    name: str
+    model: str
+    brand: str
+    author: User

tests/test_common/test_decorators/test_openapi.py

@@ -1,10 +1,10 @@
-from ellar.common import openapi
+from ellar.common import openapi_info
 from ellar.compatible import AttributeDict
 from ellar.constants import OPENAPI_KEY
 from ellar.reflect import reflect
 
 
-@openapi(
+@openapi_info(
     summary="Endpoint Summary",
     description="Endpoint Description",
     deprecated=False,