fastapi-cachex 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

fastapi_cachex/backends/__init__.py

@@ -1,2 +1,3 @@
 from .base import BaseCacheBackend as BaseCacheBackend
+from .memcached import MemcachedBackend as MemcachedBackend
 from .memory import MemoryBackend as MemoryBackend

fastapi_cachex/backends/memcached.py

@@ -0,0 +1,74 @@
+import ast
+from typing import Optional
+
+from fastapi_cachex.backends.base import BaseCacheBackend
+from fastapi_cachex.exceptions import CacheXError
+from fastapi_cachex.types import ETagContent
+
+
+class MemcachedBackend(BaseCacheBackend):
+    """Memcached backend implementation."""
+
+    def __init__(self, servers: list[str]) -> None:
+        """Initialize the Memcached backend.
+
+        Args:
+            servers: List of Memcached servers in format ["host:port", ...]
+
+        Raises:
+            CacheXError: If pymemcache is not installed
+        """
+        try:
+            from pymemcache import HashClient
+        except ImportError:
+            raise CacheXError(
+                "pymemcache is not installed. Please install it with 'pip install pymemcache'"
+            )
+
+        self.client = HashClient(servers)
+
+    async def get(self, key: str) -> Optional[ETagContent]:
+        """Get value from cache.
+
+        Args:
+            key: Cache key to retrieve
+
+        Returns:
+            Optional[ETagContent]: Cached value with ETag if exists, None otherwise
+        """
+        value = self.client.get(key)
+        if value is None:
+            return None
+
+        # Memcached stores data as bytes
+        # Convert string back to dictionary
+        value_dict = ast.literal_eval(value.decode("utf-8"))
+        return ETagContent(etag=value_dict["etag"], content=value_dict["content"])
+
+    async def set(
+        self, key: str, value: ETagContent, ttl: Optional[int] = None
+    ) -> None:
+        """Set value in cache.
+
+        Args:
+            key: Cache key
+            value: ETagContent to store
+            ttl: Time to live in seconds
+        """
+        # Store as dictionary in string format
+        data = {"etag": value.etag, "content": value.content}
+        self.client.set(
+            key, str(data).encode("utf-8"), expire=ttl if ttl is not None else 0
+        )
+
+    async def delete(self, key: str) -> None:
+        """Delete value from cache.
+
+        Args:
+            key: Cache key to delete
+        """
+        self.client.delete(key)
+
+    async def clear(self) -> None:
+        """Clear all values from cache."""
+        self.client.flush_all()

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/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/proxy.py

@@ -1,7 +1,9 @@
+from typing import Optional
+
 from fastapi_cachex.backends import BaseCacheBackend
 from fastapi_cachex.exceptions import BackendNotFoundError
 
-_default_backend: BaseCacheBackend | None = None
+_default_backend: Optional[BaseCacheBackend] = None
 
 
 class BackendProxy:
@@ -17,7 +19,11 @@ class BackendProxy:
         return _default_backend
 
     @staticmethod
-    def set_backend(backend: BaseCacheBackend) -> None:
-        """Set the backend for caching."""
+    def set_backend(backend: Optional[BaseCacheBackend]) -> None:
+        """Set the backend for caching.
+
+        Args:
+            backend: The backend to use for caching, or None to clear the current backend
+        """
         global _default_backend
         _default_backend = backend

{fastapi_cachex-0.1.1.dist-info → fastapi_cachex-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-cachex
-Version: 0.1.1
+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
@@ -25,6 +25,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: fastapi
 Requires-Dist: httpx
+Provides-Extra: memcache
+Requires-Dist: pymemcache; extra == "memcache"
 Dynamic: license-file
 
 # FastAPI-Cache X
@@ -34,8 +36,12 @@ Dynamic: license-file
 [![Tests](https://github.com/allen0099/FastAPI-CacheX/actions/workflows/test.yml/badge.svg)](https://github.com/allen0099/FastAPI-CacheX/actions/workflows/test.yml)
 [![Coverage Status](https://raw.githubusercontent.com/allen0099/FastAPI-CacheX/coverage-badge/coverage.svg)](https://github.com/allen0099/FastAPI-CacheX/actions/workflows/test.yml)
 
-[![PyPI version](https://badge.fury.io/py/fastapi-cachex.svg)](https://badge.fury.io/py/fastapi-cachex)
-[![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-cachex.svg)](https://pypi.org/project/fastapi-cachex/)
+[![Downloads](https://static.pepy.tech/badge/fastapi-cachex)](https://pepy.tech/project/fastapi-cachex)
+[![Weekly downloads](https://static.pepy.tech/badge/fastapi-cachex/week)](https://pepy.tech/project/fastapi-cachex)
+[![Monthly downloads](https://static.pepy.tech/badge/fastapi-cachex/month)](https://pepy.tech/project/fastapi-cachex)
+
+[![PyPI version](https://img.shields.io/pypi/v/fastapi-cachex.svg?logo=pypi&logoColor=gold&label=PyPI)](https://pypi.org/project/fastapi-cachex)
+[![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-cachex.svg?logo=python&label=Python&logoColor=gold)](https://pypi.org/project/fastapi-cachex/)
 
 [English](README.md) | [繁體中文](docs/README.zh-TW.md)
 
@@ -72,17 +78,54 @@ uv pip install fastapi-cachex
 
 ```python
 from fastapi import FastAPI
-from fastapi_cachex import cache
+from fastapi_cachex import cache, BackendProxy
+from fastapi_cachex.backends import MemoryBackend, MemcachedBackend
 
 app = FastAPI()
 
+# Configure your cache backend
+memory_backend = MemoryBackend()  # In-memory cache
+# or
+memcached_backend = MemcachedBackend(servers=["localhost:11211"])  # Memcached
+
+# Set the backend you want to use
+BackendProxy.set_backend(memory_backend)  # or memcached_backend
+
 
 @app.get("/")
-@cache()
+@cache(ttl=60)  # Cache for 60 seconds
 async def read_root():
     return {"Hello": "World"}
 ```
 
+## Backend Configuration
+
+FastAPI-CacheX supports multiple caching backends. You can easily switch between them using the `BackendProxy`.
+
+### In-Memory Cache
+
+```python
+from fastapi_cachex.backends import MemoryBackend
+from fastapi_cachex import BackendProxy
+
+backend = MemoryBackend()
+BackendProxy.set_backend(backend)
+```
+
+### Memcached
+
+```python
+from fastapi_cachex.backends import MemcachedBackend
+from fastapi_cachex import BackendProxy
+
+backend = MemcachedBackend(servers=["localhost:11211"])
+BackendProxy.set_backend(backend)
+```
+
+### Redis (Coming Soon)
+
+Redis support is under development and will be available in future releases.
+
 ## Development Guide
 
 ### Running Tests

fastapi_cachex-0.1.3.dist-info/RECORD

@@ -0,0 +1,16 @@
+fastapi_cachex/__init__.py,sha256=K8zRD7pEOo77Ged7SJQ-BFNMe6Pnz8yM5ePFq97nI_s,82
+fastapi_cachex/cache.py,sha256=V6RhNRZuhb4vR9LBk03DJ-HGnOSTpi3uTBms9rFov8E,7587
+fastapi_cachex/directives.py,sha256=kJCmsbyQ89m6tsWo_c1vVJn3rk0pD5JZaY8xtNLcRh0,530
+fastapi_cachex/exceptions.py,sha256=coYct4u6uK_pdjetUWDwM5OUCfhql0OkTECynMRUq4M,379
+fastapi_cachex/proxy.py,sha256=vFShY7_xp4Sh1XU9dJzsBv2ICN8Rtwx6g1qCcCvmdf8,810
+fastapi_cachex/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_cachex/types.py,sha256=YkXlBARIr5lHQE4PYQrwXjEoLHdz9CIjfX7V-S9N8p0,328
+fastapi_cachex/backends/__init__.py,sha256=U65JrCeh1eusklqUfV5yvZGK7Kfy5RctzfVrRfFPuaI,166
+fastapi_cachex/backends/base.py,sha256=eGfn0oZNQ8_drNHz4ZtqBVFSxKxEwW8y4ojw5iShgLQ,707
+fastapi_cachex/backends/memcached.py,sha256=g3184fHpFK7LH1UY9xfzRszBBzqmzeaLG806B5MsZDM,2190
+fastapi_cachex/backends/memory.py,sha256=7KFSn5e1CvDzflZ5zqUPDQsBf6emcV0ob_tCsLQcDLw,2445
+fastapi_cachex-0.1.3.dist-info/licenses/LICENSE,sha256=asJkHbd10YDSnjeAOIlKafh7E_exwtKXY5rA-qc_Mno,11339
+fastapi_cachex-0.1.3.dist-info/METADATA,sha256=-aKGoO1RcxqXe5DZepZOJprK-cm0Xo4He_3ESVZGs6k,5224
+fastapi_cachex-0.1.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+fastapi_cachex-0.1.3.dist-info/top_level.txt,sha256=97FfG5FDycd3hks-_JznEr-5lUOgg8AZd8pqK5imWj0,15
+fastapi_cachex-0.1.3.dist-info/RECORD,,

fastapi_cachex-0.1.1.dist-info/RECORD

@@ -1,14 +0,0 @@
-fastapi_cachex/__init__.py,sha256=K8zRD7pEOo77Ged7SJQ-BFNMe6Pnz8yM5ePFq97nI_s,82
-fastapi_cachex/cache.py,sha256=oMMPPcGISUWUuzVFhnd3KlgnL4ooMZErJVMQxieYy3A,6631
-fastapi_cachex/directives.py,sha256=kJCmsbyQ89m6tsWo_c1vVJn3rk0pD5JZaY8xtNLcRh0,530
-fastapi_cachex/exceptions.py,sha256=coYct4u6uK_pdjetUWDwM5OUCfhql0OkTECynMRUq4M,379
-fastapi_cachex/proxy.py,sha256=4o38sdf1mT3dgFaY06dk9ADojfBUiFhZkxdaEg5dVo4,654
-fastapi_cachex/types.py,sha256=YkXlBARIr5lHQE4PYQrwXjEoLHdz9CIjfX7V-S9N8p0,328
-fastapi_cachex/backends/__init__.py,sha256=khEnP_GmZHJXAjfqZ35uQRYMtJQTmcQxNC2y2r8Pz5w,106
-fastapi_cachex/backends/base.py,sha256=eGfn0oZNQ8_drNHz4ZtqBVFSxKxEwW8y4ojw5iShgLQ,707
-fastapi_cachex/backends/memory.py,sha256=-69k5-HwNzAPumemy-17LBZuBzUcA-qYhz2qCzVTOCc,2419
-fastapi_cachex-0.1.1.dist-info/licenses/LICENSE,sha256=asJkHbd10YDSnjeAOIlKafh7E_exwtKXY5rA-qc_Mno,11339
-fastapi_cachex-0.1.1.dist-info/METADATA,sha256=8d1xhC1CdfqRsDzep4UBK6mfPzzkPGGR14tabTxHm7U,3709
-fastapi_cachex-0.1.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-fastapi_cachex-0.1.1.dist-info/top_level.txt,sha256=97FfG5FDycd3hks-_JznEr-5lUOgg8AZd8pqK5imWj0,15
-fastapi_cachex-0.1.1.dist-info/RECORD,,