fastapi-cachex 0.1.0__py3-none-any.whl → 0.1.2__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/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.2.dist-info/METADATA

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: fastapi-cachex
+Version: 0.1.2
+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
+Project-URL: Homepage, https://github.com/allen0099/FastAPI-CacheX
+Project-URL: Repository, https://github.com/allen0099/FastAPI-CacheX.git
+Project-URL: Issues, https://github.com/allen0099/FastAPI-CacheX/issues
+Keywords: fastapi,cache,etag,cache-control,redis,memcached,in-memory
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Framework :: FastAPI
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Requires-Python: >=3.10
+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
+
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![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)
+
+[![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)
+
+A high-performance caching extension for FastAPI, providing comprehensive HTTP caching support.
+
+## Features
+
+- Support for HTTP caching headers
+    - `Cache-Control`
+    - `ETag`
+    - `If-None-Match`
+- Multiple backend cache support
+    - Redis
+    - Memcached
+    - In-memory cache
+- Complete Cache-Control directive implementation
+- Easy-to-use `@cache` decorator
+
+## Installation
+
+### Using pip
+
+```bash
+pip install fastapi-cachex
+```
+
+### Using uv (recommended)
+
+```bash
+uv pip install fastapi-cachex
+```
+
+## Quick Start
+
+```python
+from fastapi import FastAPI
+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(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
+
+1. Run unit tests:
+
+```bash
+pytest
+```
+
+2. Run tests with coverage report:
+
+```bash
+pytest --cov=fastapi_cachex
+```
+
+### Using tox
+
+tox ensures the code works across different Python versions (3.10-3.13).
+
+1. Install all Python versions
+2. Run tox:
+
+```bash
+tox
+```
+
+To run for a specific Python version:
+
+```bash
+tox -e py310  # only run for Python 3.10
+```
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

{fastapi_cachex-0.1.0.dist-info → fastapi_cachex-0.1.2.dist-info}/RECORD

@@ -2,13 +2,14 @@ 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/proxy.py,sha256=vFShY7_xp4Sh1XU9dJzsBv2ICN8Rtwx6g1qCcCvmdf8,810
 fastapi_cachex/types.py,sha256=YkXlBARIr5lHQE4PYQrwXjEoLHdz9CIjfX7V-S9N8p0,328
-fastapi_cachex/backends/__init__.py,sha256=khEnP_GmZHJXAjfqZ35uQRYMtJQTmcQxNC2y2r8Pz5w,106
+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=-69k5-HwNzAPumemy-17LBZuBzUcA-qYhz2qCzVTOCc,2419
-fastapi_cachex-0.1.0.dist-info/licenses/LICENSE,sha256=asJkHbd10YDSnjeAOIlKafh7E_exwtKXY5rA-qc_Mno,11339
-fastapi_cachex-0.1.0.dist-info/METADATA,sha256=Ugbv0EXwcJanK6xLavSN6dKGapu1k8IiKZC6wgPRUpY,2705
-fastapi_cachex-0.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-fastapi_cachex-0.1.0.dist-info/top_level.txt,sha256=97FfG5FDycd3hks-_JznEr-5lUOgg8AZd8pqK5imWj0,15
-fastapi_cachex-0.1.0.dist-info/RECORD,,
+fastapi_cachex-0.1.2.dist-info/licenses/LICENSE,sha256=asJkHbd10YDSnjeAOIlKafh7E_exwtKXY5rA-qc_Mno,11339
+fastapi_cachex-0.1.2.dist-info/METADATA,sha256=VIrxJdGN6n_YjWcFCPrCcYS_rsGIOEYtA5QLjRfQ9d0,5224
+fastapi_cachex-0.1.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+fastapi_cachex-0.1.2.dist-info/top_level.txt,sha256=97FfG5FDycd3hks-_JznEr-5lUOgg8AZd8pqK5imWj0,15
+fastapi_cachex-0.1.2.dist-info/RECORD,,

fastapi_cachex-0.1.0.dist-info/METADATA

@@ -1,111 +0,0 @@
-Metadata-Version: 2.4
-Name: fastapi-cachex
-Version: 0.1.0
-Summary: Add your description here
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: fastapi>=0.115.12
-Requires-Dist: httpx>=0.28.1
-Dynamic: license-file
-
-# FastAPI-Cache X
-
-[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![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/)
-
-[English](README.md) | [繁體中文](docs/README.zh-TW.md)
-
-A high-performance caching extension for FastAPI, providing comprehensive HTTP caching support.
-
-## Features
-
-- Support for HTTP caching headers
-    - `Cache-Control`
-    - `ETag`
-    - `If-None-Match`
-- Multiple backend cache support
-    - Redis
-    - Memcached
-    - In-memory cache
-- Complete Cache-Control directive implementation
-- Easy-to-use `@cache` decorator
-
-## Installation
-
-### Using pip
-
-```bash
-pip install fastapi-cachex
-```
-
-### Using uv (recommended)
-
-```bash
-uv pip install fastapi-cachex
-```
-
-## Quick Start
-
-```python
-from fastapi import FastAPI
-from fastapi_cachex import cache
-
-app = FastAPI()
-
-
-@app.get("/")
-@cache()
-async def read_root():
-    return {"Hello": "World"}
-```
-
-## Development Guide
-
-### Running Tests
-
-1. Run unit tests:
-
-```bash
-pytest
-```
-
-2. Run tests with coverage report:
-
-```bash
-pytest --cov=fastapi_cachex
-```
-
-### Using tox
-
-tox ensures the code works across different Python versions (3.10-3.13).
-
-1. Install all Python versions
-2. Run tox:
-
-```bash
-tox
-```
-
-To run for a specific Python version:
-
-```bash
-tox -e py310  # only run for Python 3.10
-```
-
-## Contributing
-
-1. Fork the project
-2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
-
-## License
-
-This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.