LRU cache for decorator signature (#174)

* Address signature on lru_cache
* Add extra tests for openapi

Author: tarsil

lilya/contrib/openapi/decorator.py

@@ -1,6 +1,6 @@
 import inspect
 from collections.abc import Callable, Sequence
-from functools import wraps
+from functools import lru_cache, wraps
 from typing import Annotated, Any
 
 from typing_extensions import Doc
@@ -13,6 +13,11 @@
 SUCCESSFUL_RESPONSE = "Successful response"
 
 
+@lru_cache
+def get_signature(func: Callable[..., Any]) -> inspect.Signature:
+    return inspect.Signature.from_callable(func)
+
+
 def openapi(
     summary: Annotated[
         str | None,
@@ -127,22 +132,11 @@ def openapi(
     """
 
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
-        if inspect.iscoroutinefunction(func):
-
-            @wraps(func)
-            async def async_wrapper(*args: Any, **kwargs: Any) -> Any:
-                handler = BaseHandler()
-                signature = inspect.Signature.from_callable(func)
-                return handler.handle_response(func, other_signature=signature)
-
-            wrapper = async_wrapper
-        else:
-
-            @wraps(func)
-            def sync_wrapper(*args: Any, **kwargs: Any) -> Any:
-                return func(*args, **kwargs)
-
-            wrapper = sync_wrapper
+        @wraps(func)
+        def wrapper(*args: Any, **kwargs: Any) -> Any:
+            handler = BaseHandler()
+            signature = get_signature(func)
+            return handler.handle_response(func, other_signature=signature)
 
         def response_models(responses: dict[int, OpenAPIResponse] | None = None) -> Any:
             responses: dict[int, ResponseParam] = {} if responses is None else responses  # type: ignore

lilya/testclient/helpers.py

@@ -34,6 +34,8 @@ def create_client(
     cookies: httpx._types.CookieTypes | None = None,
     before_request: Sequence[Callable[..., Any]] | None = None,
     after_request: Sequence[Callable[..., Any]] | None = None,
+    enable_openapi: bool = True,
+    openapi_config: Any | None = None,
     **kwargs: Any,
 ) -> TestClient:
     """
@@ -64,6 +66,8 @@ def create_client(
             include_in_schema=include_in_schema,
             before_request=before_request,
             after_request=after_request,
+            enable_openapi=enable_openapi,
+            openapi_config=openapi_config,
             **kwargs,
         ),
         base_url=base_url,

tests/openapi/test_responses.py

@@ -0,0 +1,162 @@
+from pydantic import BaseModel
+
+from lilya import __version__
+from lilya.contrib.openapi.datastructures import OpenAPIResponse
+from lilya.contrib.openapi.decorator import openapi
+from lilya.routing import Path
+from lilya.testclient import create_client
+
+
+class ErrorResponse(BaseModel):
+    detail: str
+    message: str
+
+
+class User(BaseModel):
+    name: str
+    age: int
+
+
+@openapi(
+    summary="A test",
+    description="A test",
+    responses={
+        400: OpenAPIResponse(model=ErrorResponse, description="Bad Request"),
+        201: OpenAPIResponse(model=User, description="Ok"),
+    },
+)
+async def create(user: User):
+    return user
+
+
+def test_responses_decorator(test_client_factory):
+    with create_client(
+        routes=[
+            Path("/create", handler=create, methods=["POST"]),
+        ]
+    ) as client:
+        response = client.get("/openapi.json")
+
+        assert response.status_code == 200
+
+        assert response.json() == {
+            "openapi": "3.1.0",
+            "info": {
+                "title": "Lilya",
+                "version": __version__,
+                "summary": "Lilya application",
+                "description": "Yet another framework/toolkit that delivers.",
+                "contact": {
+                    "name": "Lilya",
+                    "url": "https://lilya.dev",
+                    "email": "admin@myapp.com",
+                },
+            },
+            "paths": {
+                "/create": {
+                    "post": {
+                        "operationId": None,
+                        "summary": "A test",
+                        "description": "A test",
+                        "requestBody": {
+                            "content": {
+                                "application/json": {
+                                    "schema": {
+                                        "properties": {
+                                            "name": {"title": "Name", "type": "string"},
+                                            "age": {"title": "Age", "type": "integer"},
+                                        },
+                                        "required": ["name", "age"],
+                                        "title": "User",
+                                        "type": "object",
+                                    }
+                                }
+                            }
+                        },
+                        "responses": {
+                            "400": {
+                                "description": "Bad Request",
+                                "content": {
+                                    "application/json": {
+                                        "schema": {"$ref": "#/components/schemas/ErrorResponse"}
+                                    }
+                                },
+                            },
+                            "201": {
+                                "description": "Ok",
+                                "content": {
+                                    "application/json": {
+                                        "schema": {"$ref": "#/components/schemas/User"}
+                                    }
+                                },
+                            },
+                        },
+                    }
+                }
+            },
+            "components": {
+                "schemas": {
+                    "ErrorResponse": {
+                        "properties": {
+                            "detail": {"title": "Detail", "type": "string"},
+                            "message": {"title": "Message", "type": "string"},
+                        },
+                        "required": ["detail", "message"],
+                        "title": "ErrorResponse",
+                        "type": "object",
+                    },
+                    "User": {
+                        "properties": {
+                            "name": {"title": "Name", "type": "string"},
+                            "age": {"title": "Age", "type": "integer"},
+                        },
+                        "required": ["name", "age"],
+                        "title": "User",
+                        "type": "object",
+                    },
+                }
+            },
+            "servers": [{"url": "/"}],
+        }
+
+
+@openapi()
+async def create_again(user: User):
+    return user
+
+
+def test_responses_decorator_simple(test_client_factory):
+    with create_client(
+        routes=[
+            Path("/item", handler=create_again, methods=["POST"]),
+        ]
+    ) as client:
+        response = client.get("/openapi.json")
+
+        assert response.status_code == 200
+
+        assert response.json() == {
+            "openapi": "3.1.0",
+            "info": {
+                "title": "Lilya",
+                "version": __version__,
+                "summary": "Lilya application",
+                "description": "Yet another framework/toolkit that delivers.",
+                "contact": {
+                    "name": "Lilya",
+                    "url": "https://lilya.dev",
+                    "email": "admin@myapp.com",
+                },
+            },
+            "paths": {
+                "/item": {
+                    "post": {
+                        "operationId": None,
+                        "requestBody": {"content": {"application/json": {"schema": {}}}},
+                        "responses": {"200": {"description": "Successful response"}},
+                    }
+                }
+            },
+            "components": {"schemas": {}},
+            "servers": [{"url": "/"}],
+        }