fastapi-cachekit 0.1.0__tar.gz → 0.1.2__tar.gz

fastapi_cachekit-0.1.2/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Bijay Nayak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{fastapi_cachekit-0.1.0 → fastapi_cachekit-0.1.2}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: fastapi-cachekit
-Version: 0.1.0
+Version: 0.1.2
 Summary: High-performance caching solution for FastAPI applications
 Author-email: Bijay Nayak <bijay6779@gmail.com>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/devbijay/fast-cache
-Project-URL: Documentation, https://github.com/devbijay/fast-cache#readme
+Project-URL: Documentation, https://devbijay.github.io/Fast-Cache/
 Project-URL: Repository, https://github.com/devbijay/fast-cache.git
 Project-URL: Issues, https://github.com/devbijay/fast-cache/issues
 Keywords: fastapi,cache,redis,async,python,starlette,asyncio
@@ -26,8 +26,8 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
+License-File: LICENSE.md
 Requires-Dist: fastapi>=0.75.0
-Requires-Dist: uvicorn[standard]>=0.20.0
 Provides-Extra: redis
 Requires-Dist: redis>=4.2.0; extra == "redis"
 Provides-Extra: postgres
@@ -35,11 +35,15 @@ Requires-Dist: psycopg[pool]>=3.2.9; extra == "postgres"
 Provides-Extra: memcached
 Requires-Dist: aiomcache>=0.8.1; extra == "memcached"
 Requires-Dist: pymemcache>=4.0.0; extra == "memcached"
+Provides-Extra: mongodb
+Requires-Dist: pymongo[gssapi,snappy,srv]>=4.6.0; extra == "mongodb"
 Provides-Extra: all
 Requires-Dist: redis>=4.2.0; extra == "all"
 Requires-Dist: psycopg[pool]>=3.2.9; extra == "all"
 Requires-Dist: aiomcache>=0.8.1; extra == "all"
 Requires-Dist: pymemcache>=4.0.0; extra == "all"
+Requires-Dist: pymongo[gssapi,snappy,srv]>=4.6.0; extra == "all"
+Dynamic: license-file
 
 # fastapi-cachekit
 
@@ -47,7 +51,7 @@ A high-performance, flexible caching solution for FastAPI applications. fastapi-
 
 [![PyPI version](https://badge.fury.io/py/fastapi-cachekit.svg)](https://badge.fury.io/py/fastapi-cachekit)
 [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/release/python-380/)
-[![Downloads](https://pepy.tech/badge/fastapi-cache)](https://pepy.tech/project/fastapi-cachekit)
+[![PyPI Downloads](https://static.pepy.tech/badge/fastapi-cachekit)](https://pepy.tech/projects/fastapi-cachekit)
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 

{fastapi_cachekit-0.1.0 → fastapi_cachekit-0.1.2}/README.md

@@ -4,7 +4,7 @@ A high-performance, flexible caching solution for FastAPI applications. fastapi-
 
 [![PyPI version](https://badge.fury.io/py/fastapi-cachekit.svg)](https://badge.fury.io/py/fastapi-cachekit)
 [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/release/python-380/)
-[![Downloads](https://pepy.tech/badge/fastapi-cache)](https://pepy.tech/project/fastapi-cachekit)
+[![PyPI Downloads](https://static.pepy.tech/badge/fastapi-cachekit)](https://pepy.tech/projects/fastapi-cachekit)
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 

{fastapi_cachekit-0.1.0 → fastapi_cachekit-0.1.2}/fast_cache/__init__.py

@@ -5,8 +5,9 @@ from .backends.redis import RedisBackend
 from .backends.memory import InMemoryBackend
 from .backends.postgres import PostgresBackend
 from .backends.memcached import MemcachedBackend
+from .backends.mongodb import MongoDBBackend
 
-__all__ = ["FastAPICache", "RedisBackend", "CacheBackend", "InMemoryBackend","PostgresBackend", "cache","MemcachedBackend" ]
+__all__ = ["FastAPICache", "RedisBackend", "CacheBackend", "InMemoryBackend","PostgresBackend", "cache","MemcachedBackend", "MongoDBBackend" ]
 
 
 # Create global cache instance

fastapi_cachekit-0.1.2/fast_cache/backends/mongodb.py

@@ -0,0 +1,220 @@
+import pickle
+import time
+from typing import Any, Optional, Union
+from datetime import timedelta
+from .backend import CacheBackend
+
+class MongoDBBackend(CacheBackend):
+    """
+    MongoDB cache backend with both sync and async support.
+    Uses a TTL index for automatic expiration of cache entries.
+
+    Each cache entry is stored as a document with:
+      - _id: the cache key (optionally namespaced)
+      - value: the pickled cached value
+      - expires_at: epoch time when the entry should expire
+
+    Expired documents are deleted automatically by MongoDB's TTL monitor,
+    but expiration is also checked in code to avoid returning stale data.
+    """
+
+    def __init__(
+        self,
+        uri: str,
+        namespace: Optional[str] = "fastapi_cache"
+    ) -> None:
+        """
+        Initialize the MongoDB backend.
+
+        Args:
+            uri (str): MongoDB connection URI (should include the database name).
+            namespace (Optional[str]): Optional prefix for all cache keys and the collection name.
+                                       Defaults to "fastapi_cache".
+        Raises:
+            ImportError: If pymongo is not installed.
+        """
+        try:
+            import pymongo
+        except ImportError:
+            raise ImportError(
+                "MongoDBBackend requires 'pymongo>=4.6.0'. "
+                "Install with: pip install fastapi-cachekit[mongodb]"
+            )
+        self._namespace = namespace or "cache"
+
+        self._sync_client = pymongo.MongoClient(uri)
+        self._sync_db = self._sync_client.get_default_database()
+        self._sync_collection = self._sync_db[self._namespace]
+        self._sync_collection.create_index("expires_at", expireAfterSeconds=0)
+
+        # Async client
+        self._async_client = pymongo.AsyncMongoClient(uri)
+        self._async_db = self._async_client.get_default_database()
+        self._async_collection = self._async_db[self._namespace]
+
+    def _make_key(self, key: str) -> str:
+        """
+        Create a namespaced cache key.
+
+        Args:
+            key (str): The original cache key.
+
+        Returns:
+            str: The namespaced cache key.
+        """
+        return f"{self._namespace}:{key}"
+
+    def get(self, key: str) -> Optional[Any]:
+        """
+        Synchronously retrieve a value from the cache.
+
+        Args:
+            key (str): The cache key.
+
+        Returns:
+            Optional[Any]: The cached value, or None if not found or expired.
+        """
+        doc = self._sync_collection.find_one({"_id": self._make_key(key)})
+        if doc and (doc.get("expires_at", float("inf")) > time.time()):
+            return pickle.loads(doc["value"])
+        return None
+
+    def set(
+        self,
+        key: str,
+        value: Any,
+        expire: Optional[Union[int, timedelta]] = None
+    ) -> None:
+        """
+        Synchronously set a value in the cache.
+
+        Args:
+            key (str): The cache key.
+            value (Any): The value to cache.
+            expire (Optional[Union[int, timedelta]]): Expiration time in seconds or as timedelta.
+                                                     If None, the entry never expires.
+        """
+        update = {"value": pickle.dumps(value)}
+        if expire is not None:
+            if isinstance(expire, timedelta):
+                exptime = int(time.time() + expire.total_seconds())
+            else:
+                exptime = int(time.time() + expire)
+            update["expires_at"] = exptime
+
+        self._sync_collection.update_one(
+            {"_id": self._make_key(key)}, {"$set": update}, upsert=True
+        )
+
+    def delete(self, key: str) -> None:
+        """
+        Synchronously delete a value from the cache.
+
+        Args:
+            key (str): The cache key.
+        """
+        self._sync_collection.delete_one({"_id": self._make_key(key)})
+
+    def clear(self) -> None:
+        """
+        Synchronously clear all values from the namespace.
+        """
+        self._sync_collection.delete_many({"_id": {"$regex": f"^{self._namespace}:"}})
+
+    def has(self, key: str) -> bool:
+        """
+        Synchronously check if a key exists in the cache.
+
+        Args:
+            key (str): The cache key.
+
+        Returns:
+            bool: True if the key exists and is not expired, False otherwise.
+        """
+        doc = self._sync_collection.find_one({"_id": self._make_key(key)})
+        return bool(doc and (doc.get("expires_at", float("inf")) > time.time()))
+
+    async def aget(self, key: str) -> Optional[Any]:
+        """
+        Asynchronously retrieve a value from the cache.
+
+        Args:
+            key (str): The cache key.
+
+        Returns:
+            Optional[Any]: The cached value, or None if not found or expired.
+        """
+        doc = await self._async_collection.find_one({"_id": self._make_key(key)})
+        if doc and (doc.get("expires_at", float("inf")) > time.time()):
+            return pickle.loads(doc["value"])
+        return None
+
+    async def aset(
+        self,
+        key: str,
+        value: Any,
+        expire: Optional[Union[int, timedelta]] = None
+    ) -> None:
+        """
+        Asynchronously set a value in the cache.
+
+        Args:
+            key (str): The cache key.
+            value (Any): The value to cache.
+            expire (Optional[Union[int, timedelta]]): Expiration time in seconds or as timedelta.
+                                                     If None, the entry never expires.
+        """
+        update = {"value": pickle.dumps(value)}
+        if expire is not None:
+            if isinstance(expire, timedelta):
+                exptime = int(time.time() + expire.total_seconds())
+            else:
+                exptime = int(time.time() + expire)
+            update["expires_at"] = exptime
+
+        await self._async_collection.update_one(
+            {"_id": self._make_key(key)},
+            {"$set": update},
+            upsert=True
+        )
+
+    async def adelete(self, key: str) -> None:
+        """
+        Asynchronously delete a value from the cache.
+
+        Args:
+            key (str): The cache key.
+        """
+        await self._async_collection.delete_one({"_id": self._make_key(key)})
+
+    async def aclear(self) -> None:
+        """
+        Asynchronously clear all values from the namespace.
+        """
+        await self._async_collection.delete_many({"_id": {"$regex": f"^{self._namespace}:"}})
+
+    async def ahas(self, key: str) -> bool:
+        """
+        Asynchronously check if a key exists in the cache.
+
+        Args:
+            key (str): The cache key.
+
+        Returns:
+            bool: True if the key exists and is not expired, False otherwise.
+        """
+        doc = await self._async_collection.find_one({"_id": self._make_key(key)})
+        return bool(doc and (doc.get("expires_at", float("inf")) > time.time()))
+
+    def close(self) -> None:
+        """
+        Close the synchronous MongoDB client.
+        """
+        self._sync_client.close()
+
+    async def aclose(self) -> None:
+        """
+        Close the asynchronous MongoDB client.
+        """
+        self._sync_client.close()
+        await self._async_client.close()

{fastapi_cachekit-0.1.0 → fastapi_cachekit-0.1.2}/fast_cache/backends/postgres.py

@@ -1,9 +1,15 @@
 import pickle
+import re
 from datetime import datetime, timezone, timedelta
 from typing import Any, Optional, Union
 from .backend import CacheBackend
 
 
+def _validate_namespace(namespace: str) -> str:
+    if not re.match(r"^[A-Za-z0-9_]+$", namespace):
+        raise ValueError("Invalid namespace: only alphanumeric and underscore allowed")
+    return namespace
+
 class PostgresBackend(CacheBackend):
     """
     PostgreSQL cache backend implementation.
@@ -26,7 +32,7 @@ class PostgresBackend(CacheBackend):
                 "Install it with: pip install fast-cache[postgres]"
             )
 
-        self._namespace = namespace
+        self._namespace = _validate_namespace(namespace)
         self._table_name = f"{namespace}_cache_store"
 
         # The pools are opened on creation and will auto-reopen if needed
@@ -39,6 +45,13 @@ class PostgresBackend(CacheBackend):
         )
         self._create_unlogged_table_if_not_exists()
 
+    def _validate_namespace(namespace: str) -> str:
+        if not re.match(r"^[A-Za-z0-9_]+$", namespace):
+            raise ValueError(
+                "Invalid namespace: only alphanumeric and underscore allowed"
+            )
+        return namespace
+
     def _create_unlogged_table_if_not_exists(self):
         """Create the cache table if it doesn't exist."""
         # The index on expire_at is for efficient periodic cleanup jobs,

{fastapi_cachekit-0.1.0 → fastapi_cachekit-0.1.2}/fastapi_cachekit.egg-info/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: fastapi-cachekit
-Version: 0.1.0
+Version: 0.1.2
 Summary: High-performance caching solution for FastAPI applications
 Author-email: Bijay Nayak <bijay6779@gmail.com>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/devbijay/fast-cache
-Project-URL: Documentation, https://github.com/devbijay/fast-cache#readme
+Project-URL: Documentation, https://devbijay.github.io/Fast-Cache/
 Project-URL: Repository, https://github.com/devbijay/fast-cache.git
 Project-URL: Issues, https://github.com/devbijay/fast-cache/issues
 Keywords: fastapi,cache,redis,async,python,starlette,asyncio
@@ -26,8 +26,8 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
+License-File: LICENSE.md
 Requires-Dist: fastapi>=0.75.0
-Requires-Dist: uvicorn[standard]>=0.20.0
 Provides-Extra: redis
 Requires-Dist: redis>=4.2.0; extra == "redis"
 Provides-Extra: postgres
@@ -35,11 +35,15 @@ Requires-Dist: psycopg[pool]>=3.2.9; extra == "postgres"
 Provides-Extra: memcached
 Requires-Dist: aiomcache>=0.8.1; extra == "memcached"
 Requires-Dist: pymemcache>=4.0.0; extra == "memcached"
+Provides-Extra: mongodb
+Requires-Dist: pymongo[gssapi,snappy,srv]>=4.6.0; extra == "mongodb"
 Provides-Extra: all
 Requires-Dist: redis>=4.2.0; extra == "all"
 Requires-Dist: psycopg[pool]>=3.2.9; extra == "all"
 Requires-Dist: aiomcache>=0.8.1; extra == "all"
 Requires-Dist: pymemcache>=4.0.0; extra == "all"
+Requires-Dist: pymongo[gssapi,snappy,srv]>=4.6.0; extra == "all"
+Dynamic: license-file
 
 # fastapi-cachekit
 
@@ -47,7 +51,7 @@ A high-performance, flexible caching solution for FastAPI applications. fastapi-
 
 [![PyPI version](https://badge.fury.io/py/fastapi-cachekit.svg)](https://badge.fury.io/py/fastapi-cachekit)
 [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/release/python-380/)
-[![Downloads](https://pepy.tech/badge/fastapi-cache)](https://pepy.tech/project/fastapi-cachekit)
+[![PyPI Downloads](https://static.pepy.tech/badge/fastapi-cachekit)](https://pepy.tech/projects/fastapi-cachekit)
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 

{fastapi_cachekit-0.1.0 → fastapi_cachekit-0.1.2}/fastapi_cachekit.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE.md
 README.md
 pyproject.toml
 fast_cache/__init__.py
@@ -6,6 +7,7 @@ fast_cache/backends/__init__.py
 fast_cache/backends/backend.py
 fast_cache/backends/memcached.py
 fast_cache/backends/memory.py
+fast_cache/backends/mongodb.py
 fast_cache/backends/postgres.py
 fast_cache/backends/redis.py
 fastapi_cachekit.egg-info/PKG-INFO

{fastapi_cachekit-0.1.0 → fastapi_cachekit-0.1.2}/fastapi_cachekit.egg-info/requires.txt

@@ -1,16 +1,19 @@
 fastapi>=0.75.0
-uvicorn[standard]>=0.20.0
 
 [all]
 redis>=4.2.0
 psycopg[pool]>=3.2.9
 aiomcache>=0.8.1
 pymemcache>=4.0.0
+pymongo[gssapi,snappy,srv]>=4.6.0
 
 [memcached]
 aiomcache>=0.8.1
 pymemcache>=4.0.0
 
+[mongodb]
+pymongo[gssapi,snappy,srv]>=4.6.0
+
 [postgres]
 psycopg[pool]>=3.2.9
 

{fastapi_cachekit-0.1.0 → fastapi_cachekit-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-cachekit"
-version = "0.1.0"
+version = "0.1.2"
 description = "High-performance caching solution for FastAPI applications"
 readme = "README.md"
 license = "MIT"
@@ -28,13 +28,12 @@ classifiers = [
 ]
 
 dependencies = [
-    "fastapi>=0.75.0",
-    "uvicorn[standard]>=0.20.0",
+    "fastapi>=0.75.0"
 ]
 
 [project.urls]
 Homepage = "https://github.com/devbijay/fast-cache"
-Documentation = "https://github.com/devbijay/fast-cache#readme"
+Documentation = "https://devbijay.github.io/Fast-Cache/"
 Repository = "https://github.com/devbijay/fast-cache.git"
 Issues = "https://github.com/devbijay/fast-cache/issues"
 
@@ -64,16 +63,22 @@ memcached = [
     "aiomcache>=0.8.1",
     "pymemcache>=4.0.0"
 ]
+mongodb = [
+    "pymongo[snappy,gssapi,srv]>=4.6.0"
+]
 all = [
     "redis>=4.2.0",
     "psycopg[pool]>=3.2.9",
     "aiomcache>=0.8.1",
-    "pymemcache>=4.0.0"
+    "pymemcache>=4.0.0",
+    "pymongo[snappy,gssapi,srv]>=4.6.0"
 ]
 
 [dependency-groups]
 dev = [
     "httpx>=0.28.1",
+    "mkdocs-material>=9.6.14",
+    "mkdocstrings[python]>=0.29.1",
     "psycopg-binary>=3.2.9",
     "pytest>=8.4.0",
     "pytest-asyncio>=1.0.0",