fastapi-cachex 0.1.2__tar.gz → 0.1.3__tar.gz

{fastapi_cachex-0.1.2 → fastapi_cachex-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-cachex
-Version: 0.1.2
+Version: 0.1.3
 Summary: A caching library for FastAPI with support for Cache-Control, ETag, and multiple backends.
 Author-email: Allen <s96016641@gmail.com>
 License-Expression: Apache-2.0

{fastapi_cachex-0.1.2 → fastapi_cachex-0.1.3}/fastapi_cachex/backends/memory.py

@@ -15,7 +15,7 @@ class MemoryBackend(BaseCacheBackend):
         self.cache: dict[str, CacheItem] = {}
         self.lock = asyncio.Lock()
         self.cleanup_interval = 60
-        self._cleanup_task: Optional[asyncio.Task] = None
+        self._cleanup_task: Optional[asyncio.Task[None]] = None
 
     def start_cleanup(self) -> None:
         """Start the cleanup task if it's not already running."""
@@ -42,7 +42,7 @@ class MemoryBackend(BaseCacheBackend):
         self, key: str, value: ETagContent, ttl: Optional[int] = None
     ) -> None:
         async with self.lock:
-            expiry = time.time() + ttl if ttl is not None else None
+            expiry: Optional[int] = int(time.time() + ttl) if ttl is not None else None
             self.cache[key] = CacheItem(value=value, expiry=expiry)
 
     async def delete(self, key: str) -> None:

{fastapi_cachex-0.1.2 → fastapi_cachex-0.1.3}/fastapi_cachex/cache.py

@@ -1,16 +1,21 @@
 import hashlib
 import inspect
+from collections.abc import Awaitable
 from collections.abc import Callable
+from functools import update_wrapper
 from functools import wraps
 from inspect import Parameter
 from inspect import Signature
+from typing import TYPE_CHECKING
 from typing import Any
 from typing import Literal
 from typing import Optional
+from typing import TypeVar
+from typing import Union
 
 from fastapi import Request
 from fastapi import Response
-from fastapi.responses import JSONResponse
+from fastapi.datastructures import DefaultPlaceholder
 from starlette.status import HTTP_304_NOT_MODIFIED
 
 from fastapi_cachex.backends import MemoryBackend
@@ -21,10 +26,18 @@ from fastapi_cachex.exceptions import RequestNotFoundError
 from fastapi_cachex.proxy import BackendProxy
 from fastapi_cachex.types import ETagContent
 
+if TYPE_CHECKING:
+    from fastapi.routing import APIRoute
+
+T = TypeVar("T", bound=Response)
+AsyncCallable = Callable[..., Awaitable[T]]
+SyncCallable = Callable[..., T]
+AnyCallable = Union[AsyncCallable[T], SyncCallable[T]]  # noqa: UP007
+
 
 class CacheControl:
     def __init__(self) -> None:
-        self.directives = []
+        self.directives: list[str] = []
 
     def add(self, directive: DirectiveType, value: Optional[int] = None) -> None:
         if value is not None:
@@ -36,12 +49,32 @@ class CacheControl:
         return ", ".join(self.directives)
 
 
-async def get_response(func: Callable, *args: Any, **kwargs: Any) -> Response:
+async def get_response(
+    __func: AnyCallable[Response], __request: Request, *args: Any, **kwargs: Any
+) -> Response:
     """Get the response from the function."""
-    if inspect.iscoroutinefunction(func):
-        return await func(*args, **kwargs)
+    if inspect.iscoroutinefunction(__func):
+        result = await __func(*args, **kwargs)
+    else:
+        result = __func(*args, **kwargs)
+
+    # If already a Response object, return it directly
+    if isinstance(result, Response):
+        return result
+
+    # Get response_class from route if available
+    route: APIRoute | None = __request.scope.get("route")
+    if route is None:  # pragma: no cover
+        raise CacheXError("Route not found in request scope")
+
+    if isinstance(route.response_class, DefaultPlaceholder):
+        response_class: type[Response] = route.response_class.value
+
     else:
-        return func(*args, **kwargs)
+        response_class = route.response_class
+
+    # Convert non-Response result to Response using appropriate response_class
+    return response_class(content=result)
 
 
 def cache(  # noqa: C901
@@ -54,8 +87,8 @@ def cache(  # noqa: C901
     private: bool = False,
     immutable: bool = False,
     must_revalidate: bool = False,
-) -> Callable:
-    def decorator(func: Callable) -> Callable:  # noqa: C901
+) -> Callable[[AnyCallable[Response]], AsyncCallable[Response]]:
+    def decorator(func: AnyCallable[Response]) -> AsyncCallable[Response]:  # noqa: C901
         try:
             cache_backend = BackendProxy.get_backend()
         except BackendNotFoundError:
@@ -87,52 +120,38 @@ def cache(  # noqa: C901
         else:
             request_name = found_request.name
 
-        func.__signature__ = sig
-
         @wraps(func)
         async def wrapper(*args: Any, **kwargs: Any) -> Response:  # noqa: C901
             if found_request:
-                request: Request | None = kwargs.get(request_name)
+                req: Request | None = kwargs.get(request_name)
             else:
-                request: Request | None = kwargs.pop(request_name, None)
+                req = kwargs.pop(request_name, None)
 
-            if not request:  # pragma: no cover
+            if not req:  # pragma: no cover
                 # Skip coverage for this case, as it should not happen
                 raise RequestNotFoundError()
 
             # Only cache GET requests
-            if request.method != "GET":
-                return await get_response(func, *args, **kwargs)
+            if req.method != "GET":
+                return await get_response(func, req, *args, **kwargs)
 
             # Generate cache key
-            cache_key = f"{request.url.path}:{request.query_params}"
+            cache_key = f"{req.url.path}:{req.query_params}"
 
             # Check if the data is already in the cache
             cached_data = await cache_backend.get(cache_key)
 
-            if cached_data and cached_data.etag == (
-                request.headers.get("if-none-match")
-            ):
+            if cached_data and cached_data.etag == req.headers.get("if-none-match"):
                 return Response(
                     status_code=HTTP_304_NOT_MODIFIED,
                     headers={"ETag": cached_data.etag},
                 )
 
             # Get the response
-            response = await get_response(func, *args, **kwargs)
+            response = await get_response(func, req, *args, **kwargs)
 
             # Generate ETag (hash based on response content)
-            if isinstance(response, JSONResponse):
-                content = response.body
-            else:
-                content = (
-                    response.body
-                    if hasattr(response, "body")
-                    else str(response).encode()
-                )
-
-            # Calculate ETag
-            etag = f'W/"{hashlib.md5(content).hexdigest()}"'  # noqa: S324
+            etag = f'W/"{hashlib.md5(response.body).hexdigest()}"'  # noqa: S324
 
             # Add ETag to response headers
             response.headers["ETag"] = etag
@@ -183,11 +202,17 @@ def cache(  # noqa: C901
                 cache_control.add(DirectiveType.IMMUTABLE)
 
             # Store the data in the cache
-            await cache_backend.set(cache_key, ETagContent(etag, content), ttl=ttl)
+            await cache_backend.set(
+                cache_key, ETagContent(etag, response.body), ttl=ttl
+            )
 
             response.headers["Cache-Control"] = str(cache_control)
             return response
 
+        # Update the wrapper with the new signature
+        update_wrapper(wrapper, func)
+        wrapper.__signature__ = sig  # type: ignore
+
         return wrapper
 
     return decorator

{fastapi_cachex-0.1.2 → fastapi_cachex-0.1.3}/fastapi_cachex.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-cachex
-Version: 0.1.2
+Version: 0.1.3
 Summary: A caching library for FastAPI with support for Cache-Control, ETag, and multiple backends.
 Author-email: Allen <s96016641@gmail.com>
 License-Expression: Apache-2.0

{fastapi_cachex-0.1.2 → fastapi_cachex-0.1.3}/fastapi_cachex.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ fastapi_cachex/cache.py
 fastapi_cachex/directives.py
 fastapi_cachex/exceptions.py
 fastapi_cachex/proxy.py
+fastapi_cachex/py.typed
 fastapi_cachex/types.py
 fastapi_cachex.egg-info/PKG-INFO
 fastapi_cachex.egg-info/SOURCES.txt

{fastapi_cachex-0.1.2 → fastapi_cachex-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-cachex"
-version = "0.1.2" # Initial release version
+version = "0.1.3" # Initial release version
 description = "A caching library for FastAPI with support for Cache-Control, ETag, and multiple backends."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -36,6 +36,7 @@ Issues = "https://github.com/allen0099/FastAPI-CacheX/issues"
 [dependency-groups]
 dev = [
     "coverage>=7.8.0",
+    "mypy>=1.15.0",
     "pre-commit>=4.2.0",
     "pymemcache>=4.0.0",
     "pytest>=8.3.5",
@@ -48,6 +49,9 @@ dev = [
 [project.optional-dependencies]
 memcache = ["pymemcache"]
 
+[tool.setuptools]
+package-data = {"fastapi_cachex" = ["py.typed"]}
+
 [tool.pytest.ini_options]
 pythonpath = [
   "."
@@ -125,3 +129,30 @@ exclude_lines = [
 ]
 fail_under = 90
 show_missing = true
+
+[tool.mypy]
+python_version = "3.10"
+plugins = [
+    "pydantic.mypy"
+]
+warn_redundant_casts = true
+warn_unused_ignores = true
+disallow_any_generics = true
+check_untyped_defs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_return_any = true
+warn_unreachable = true
+strict_optional = true
+strict_equality = true
+
+[[tool.mypy.overrides]]
+module = ["tests.*"]
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+
+[[tool.mypy.overrides]]
+module = ["pymemcache.*"]
+ignore_missing_imports = true

{fastapi_cachex-0.1.2 → fastapi_cachex-0.1.3}/tests/test_cache.py

@@ -2,7 +2,9 @@ from fastapi import FastAPI
 from fastapi import Response
 from fastapi.testclient import TestClient
 from starlette.requests import Request
+from starlette.responses import HTMLResponse
 from starlette.responses import JSONResponse
+from starlette.responses import PlainTextResponse
 
 from fastapi_cachex.cache import cache
 
@@ -276,3 +278,69 @@ def test_post_should_not_cache():
     response = client.post("/post")
     assert response.status_code == 200
     assert "cache-control" not in response.headers
+
+
+def test_use_default_response_class():
+    @app.get("/")
+    @cache()
+    async def default_response_class_endpoint():
+        return {"message": "This endpoint uses the default response class"}
+
+    response = client.get("/")
+    assert response.status_code == 200
+    assert response.headers["content-type"] == "application/json"
+
+
+def test_response_class_html():
+    @app.get("/html", response_class=HTMLResponse)
+    @cache(ttl=60)
+    async def html_endpoint():
+        return "<h1>Hello World</h1>"
+
+    response = client.get("/html")
+    assert response.status_code == 200
+    assert response.headers["content-type"] == "text/html; charset=utf-8"
+    assert response.text == "<h1>Hello World</h1>"
+
+
+def test_response_class_plain_text():
+    @app.get("/text", response_class=PlainTextResponse)
+    @cache(ttl=60)
+    async def text_endpoint():
+        return "Hello World"
+
+    response = client.get("/text")
+    assert response.status_code == 200
+    assert response.headers["content-type"] == "text/plain; charset=utf-8"
+    assert response.text == "Hello World"
+
+
+def test_response_class_json_with_raw_dict():
+    @app.get("/json-dict", response_class=JSONResponse)
+    @cache(ttl=60)
+    async def json_dict_endpoint():
+        return {"message": "Hello World"}
+
+    response = client.get("/json-dict")
+    assert response.status_code == 200
+    assert response.headers["content-type"] == "application/json"
+    assert response.json() == {"message": "Hello World"}
+
+
+def test_response_class_with_etag():
+    """Test that different response classes still generate and handle ETags correctly"""
+
+    @app.get("/html-etag", response_class=HTMLResponse)
+    @cache()
+    async def html_etag_endpoint():
+        return "<h1>Hello World</h1>"
+
+    # First request
+    response1 = client.get("/html-etag")
+    assert response1.status_code == 200
+    assert "ETag" in response1.headers
+
+    # Second request with ETag
+    etag = response1.headers["ETag"]
+    response2 = client.get("/html-etag", headers={"If-None-Match": etag})
+    assert response2.status_code == 304  # Not Modified