fastapi-cachex 0.5.1__tar.gz → 0.5.2__tar.gz

{fastapi_cachex-0.5.1 → fastapi_cachex-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-cachex
-Version: 0.5.1
+Version: 0.5.2
 Summary: A caching library for FastAPI with support for Cache-Control, ETag, and multiple backends.
 Keywords: fastapi,cache,etag,cache-control,redis,memcached,in-memory
 Author: allen0099
@@ -50,11 +50,11 @@ Description-Content-Type: text/markdown
 [![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](https://fastapi-cachex.readthedocs.io/en/latest/) | [繁體中文](https://fastapi-cachex.readthedocs.io/zh-tw/latest/)
+[English](https://fastapi-cachex.readthedocs.io/en/stable/) | [繁體中文](https://fastapi-cachex.readthedocs.io/zh-tw/stable/)
 
 A high-performance caching extension for FastAPI: a server-side response cache with `Cache-Control` and `ETag` support, and application-level caching.
 
-**Documentation:** <https://fastapi-cachex.readthedocs.io/en/latest/> — guides and the full API reference.
+**Documentation:** <https://fastapi-cachex.readthedocs.io/en/stable/> — guides and the full API reference.
 
 ## Features
 
@@ -115,7 +115,7 @@ async def report(cache: AppCache):
 > Put `@cache` **below** the route decorator. FastAPI registers whatever function
 > reaches `@app.get(...)`; with `@cache` on top, FastAPI registers the
 > undecorated handler, so the route works but nothing is cached and nothing warns
-> (see [Decorator order](https://fastapi-cachex.readthedocs.io/en/latest/HTTP_CACHING/#decorator-order)).
+> (see [Decorator order](https://fastapi-cachex.readthedocs.io/en/stable/HTTP_CACHING/#decorator-order)).
 >
 > ```python
 > @app.get("/items")  # ✅ route decorator first,
@@ -132,7 +132,7 @@ async def report(cache: AppCache):
 > with `private=True` or a per-user key builder plus `cache_authorized=True`
 > (requests with `Authorization` or non-empty `request.session` data otherwise
 > bypass the backend) — see
-> [Authenticated endpoints](https://fastapi-cachex.readthedocs.io/en/latest/HTTP_CACHING/#authenticated-endpoints).
+> [Authenticated endpoints](https://fastapi-cachex.readthedocs.io/en/stable/HTTP_CACHING/#authenticated-endpoints).
 
 ## Documentation
 
@@ -141,18 +141,19 @@ a code block that includes one of the runnable examples renders on the site,
 while GitHub shows only its `--8<--` include line (the sentence before each
 block links the example file).
 
-- [Migrating to 0.5.0](https://fastapi-cachex.readthedocs.io/en/latest/MIGRATING_0_5/) — what 0.5.0 removes and how to upgrade from 0.4.x
-- [Migrating to 0.4.0](https://fastapi-cachex.readthedocs.io/en/latest/MIGRATING_0_4/) — what 0.4.0 changes and how to upgrade from 0.3.x
-- [Migrating from fastapi-cache2](https://fastapi-cachex.readthedocs.io/en/latest/MIGRATING_FROM_FASTAPI_CACHE2/) — its API mapped onto this one, and the behaviour that differs
-- [When to use it](https://fastapi-cachex.readthedocs.io/en/latest/COMPARISON/) — how it compares with fastapi-cache2, cashews, aiocache and a CDN, and when another one fits better
-- [HTTP caching](https://fastapi-cachex.readthedocs.io/en/latest/HTTP_CACHING/) — the `@cache` decorator, Cache-Control directives, cache keys, invalidation and monitoring routes
-- [Application cache](https://fastapi-cachex.readthedocs.io/en/latest/APP_CACHE/) — `CacheManager`
-- [Backends](https://fastapi-cachex.readthedocs.io/en/latest/BACKENDS/) — choosing and configuring a backend, atomic primitives
-- [Distributed lock](https://fastapi-cachex.readthedocs.io/en/latest/LOCK/) — `CacheLock` for multi-process mutual exclusion
-- [Cache flow](https://fastapi-cachex.readthedocs.io/en/latest/CACHE_FLOW/) — what happens inside a cached request
+- [Migrating to 0.6.0](https://fastapi-cachex.readthedocs.io/en/stable/MIGRATING_0_6/) — what 0.6.0 will change, starting with the end of Python 3.10 support
+- [Migrating to 0.5.0](https://fastapi-cachex.readthedocs.io/en/stable/MIGRATING_0_5/) — what 0.5.0 removes and how to upgrade from 0.4.x
+- [Migrating to 0.4.0](https://fastapi-cachex.readthedocs.io/en/stable/MIGRATING_0_4/) — what 0.4.0 changes and how to upgrade from 0.3.x
+- [Migrating from fastapi-cache2](https://fastapi-cachex.readthedocs.io/en/stable/MIGRATING_FROM_FASTAPI_CACHE2/) — its API mapped onto this one, and the behaviour that differs
+- [When to use it](https://fastapi-cachex.readthedocs.io/en/stable/COMPARISON/) — how it compares with fastapi-cache2, cashews, aiocache and a CDN, and when another one fits better
+- [HTTP caching](https://fastapi-cachex.readthedocs.io/en/stable/HTTP_CACHING/) — the `@cache` decorator, Cache-Control directives, cache keys, invalidation and monitoring routes
+- [Application cache](https://fastapi-cachex.readthedocs.io/en/stable/APP_CACHE/) — `CacheManager`
+- [Backends](https://fastapi-cachex.readthedocs.io/en/stable/BACKENDS/) — choosing and configuring a backend, atomic primitives
+- [Distributed lock](https://fastapi-cachex.readthedocs.io/en/stable/LOCK/) — `CacheLock` for multi-process mutual exclusion
+- [Cache flow](https://fastapi-cachex.readthedocs.io/en/stable/CACHE_FLOW/) — what happens inside a cached request
 - [Runnable examples](https://github.com/allen0099/FastAPI-CacheX/tree/master/examples) — one complete app per feature, each covered by the test suite
-- [API reference](https://fastapi-cachex.readthedocs.io/en/latest/api/http-caching/)
-- [Development guide](https://fastapi-cachex.readthedocs.io/en/latest/DEVELOPMENT/) and [contributing](https://fastapi-cachex.readthedocs.io/en/latest/CONTRIBUTING/) · [Security policy](https://github.com/allen0099/FastAPI-CacheX/blob/master/SECURITY.md) — report vulnerabilities privately, not in public issues
+- [API reference](https://fastapi-cachex.readthedocs.io/en/stable/api/http-caching/)
+- [Development guide](https://fastapi-cachex.readthedocs.io/en/stable/DEVELOPMENT/) and [contributing](https://fastapi-cachex.readthedocs.io/en/stable/CONTRIBUTING/) · [Security policy](https://github.com/allen0099/FastAPI-CacheX/blob/master/SECURITY.md) — report vulnerabilities privately, not in public issues
 - [Changelog](https://github.com/allen0099/FastAPI-CacheX/blob/master/CHANGELOG.md) · [Known limitations and planned work](https://github.com/allen0099/FastAPI-CacheX/issues)
 
 ## License

{fastapi_cachex-0.5.1 → fastapi_cachex-0.5.2}/README.md

@@ -12,11 +12,11 @@
 [![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](https://fastapi-cachex.readthedocs.io/en/latest/) | [繁體中文](https://fastapi-cachex.readthedocs.io/zh-tw/latest/)
+[English](https://fastapi-cachex.readthedocs.io/en/stable/) | [繁體中文](https://fastapi-cachex.readthedocs.io/zh-tw/stable/)
 
 A high-performance caching extension for FastAPI: a server-side response cache with `Cache-Control` and `ETag` support, and application-level caching.
 
-**Documentation:** <https://fastapi-cachex.readthedocs.io/en/latest/> — guides and the full API reference.
+**Documentation:** <https://fastapi-cachex.readthedocs.io/en/stable/> — guides and the full API reference.
 
 ## Features
 
@@ -77,7 +77,7 @@ async def report(cache: AppCache):
 > Put `@cache` **below** the route decorator. FastAPI registers whatever function
 > reaches `@app.get(...)`; with `@cache` on top, FastAPI registers the
 > undecorated handler, so the route works but nothing is cached and nothing warns
-> (see [Decorator order](https://fastapi-cachex.readthedocs.io/en/latest/HTTP_CACHING/#decorator-order)).
+> (see [Decorator order](https://fastapi-cachex.readthedocs.io/en/stable/HTTP_CACHING/#decorator-order)).
 >
 > ```python
 > @app.get("/items")  # ✅ route decorator first,
@@ -94,7 +94,7 @@ async def report(cache: AppCache):
 > with `private=True` or a per-user key builder plus `cache_authorized=True`
 > (requests with `Authorization` or non-empty `request.session` data otherwise
 > bypass the backend) — see
-> [Authenticated endpoints](https://fastapi-cachex.readthedocs.io/en/latest/HTTP_CACHING/#authenticated-endpoints).
+> [Authenticated endpoints](https://fastapi-cachex.readthedocs.io/en/stable/HTTP_CACHING/#authenticated-endpoints).
 
 ## Documentation
 
@@ -103,18 +103,19 @@ a code block that includes one of the runnable examples renders on the site,
 while GitHub shows only its `--8<--` include line (the sentence before each
 block links the example file).
 
-- [Migrating to 0.5.0](https://fastapi-cachex.readthedocs.io/en/latest/MIGRATING_0_5/) — what 0.5.0 removes and how to upgrade from 0.4.x
-- [Migrating to 0.4.0](https://fastapi-cachex.readthedocs.io/en/latest/MIGRATING_0_4/) — what 0.4.0 changes and how to upgrade from 0.3.x
-- [Migrating from fastapi-cache2](https://fastapi-cachex.readthedocs.io/en/latest/MIGRATING_FROM_FASTAPI_CACHE2/) — its API mapped onto this one, and the behaviour that differs
-- [When to use it](https://fastapi-cachex.readthedocs.io/en/latest/COMPARISON/) — how it compares with fastapi-cache2, cashews, aiocache and a CDN, and when another one fits better
-- [HTTP caching](https://fastapi-cachex.readthedocs.io/en/latest/HTTP_CACHING/) — the `@cache` decorator, Cache-Control directives, cache keys, invalidation and monitoring routes
-- [Application cache](https://fastapi-cachex.readthedocs.io/en/latest/APP_CACHE/) — `CacheManager`
-- [Backends](https://fastapi-cachex.readthedocs.io/en/latest/BACKENDS/) — choosing and configuring a backend, atomic primitives
-- [Distributed lock](https://fastapi-cachex.readthedocs.io/en/latest/LOCK/) — `CacheLock` for multi-process mutual exclusion
-- [Cache flow](https://fastapi-cachex.readthedocs.io/en/latest/CACHE_FLOW/) — what happens inside a cached request
+- [Migrating to 0.6.0](https://fastapi-cachex.readthedocs.io/en/stable/MIGRATING_0_6/) — what 0.6.0 will change, starting with the end of Python 3.10 support
+- [Migrating to 0.5.0](https://fastapi-cachex.readthedocs.io/en/stable/MIGRATING_0_5/) — what 0.5.0 removes and how to upgrade from 0.4.x
+- [Migrating to 0.4.0](https://fastapi-cachex.readthedocs.io/en/stable/MIGRATING_0_4/) — what 0.4.0 changes and how to upgrade from 0.3.x
+- [Migrating from fastapi-cache2](https://fastapi-cachex.readthedocs.io/en/stable/MIGRATING_FROM_FASTAPI_CACHE2/) — its API mapped onto this one, and the behaviour that differs
+- [When to use it](https://fastapi-cachex.readthedocs.io/en/stable/COMPARISON/) — how it compares with fastapi-cache2, cashews, aiocache and a CDN, and when another one fits better
+- [HTTP caching](https://fastapi-cachex.readthedocs.io/en/stable/HTTP_CACHING/) — the `@cache` decorator, Cache-Control directives, cache keys, invalidation and monitoring routes
+- [Application cache](https://fastapi-cachex.readthedocs.io/en/stable/APP_CACHE/) — `CacheManager`
+- [Backends](https://fastapi-cachex.readthedocs.io/en/stable/BACKENDS/) — choosing and configuring a backend, atomic primitives
+- [Distributed lock](https://fastapi-cachex.readthedocs.io/en/stable/LOCK/) — `CacheLock` for multi-process mutual exclusion
+- [Cache flow](https://fastapi-cachex.readthedocs.io/en/stable/CACHE_FLOW/) — what happens inside a cached request
 - [Runnable examples](https://github.com/allen0099/FastAPI-CacheX/tree/master/examples) — one complete app per feature, each covered by the test suite
-- [API reference](https://fastapi-cachex.readthedocs.io/en/latest/api/http-caching/)
-- [Development guide](https://fastapi-cachex.readthedocs.io/en/latest/DEVELOPMENT/) and [contributing](https://fastapi-cachex.readthedocs.io/en/latest/CONTRIBUTING/) · [Security policy](https://github.com/allen0099/FastAPI-CacheX/blob/master/SECURITY.md) — report vulnerabilities privately, not in public issues
+- [API reference](https://fastapi-cachex.readthedocs.io/en/stable/api/http-caching/)
+- [Development guide](https://fastapi-cachex.readthedocs.io/en/stable/DEVELOPMENT/) and [contributing](https://fastapi-cachex.readthedocs.io/en/stable/CONTRIBUTING/) · [Security policy](https://github.com/allen0099/FastAPI-CacheX/blob/master/SECURITY.md) — report vulnerabilities privately, not in public issues
 - [Changelog](https://github.com/allen0099/FastAPI-CacheX/blob/master/CHANGELOG.md) · [Known limitations and planned work](https://github.com/allen0099/FastAPI-CacheX/issues)
 
 ## License

{fastapi_cachex-0.5.1 → fastapi_cachex-0.5.2}/fastapi_cachex/__init__.py

@@ -1,6 +1,8 @@
 """FastAPI-CacheX: A powerful and flexible caching extension for FastAPI."""
 
 import logging
+import sys
+import warnings
 from importlib.metadata import PackageNotFoundError
 from importlib.metadata import version
 
@@ -47,6 +49,28 @@ def _read_version() -> str:
 
 __version__ = _read_version()
 
+_PYTHON_310_NOTICE = (
+    "fastapi-cachex 0.6.0 will require Python 3.11 or later; Python 3.10 "
+    "reached its end of life in October 2026. Upgrade Python; see "
+    "https://fastapi-cachex.readthedocs.io/en/stable/MIGRATING_0_6/#python-311"
+)
+
+
+def _warn_python_310(python: tuple[int, int] = sys.version_info[:2]) -> None:
+    """Warn on import under Python 3.10, which 0.6.0 drops (#491).
+
+    ``FutureWarning``, not ``DeprecationWarning``: it is shown by default.
+    ``stacklevel=3`` skips this function and the package module; ``warnings``
+    skips the import machinery's frames itself, so the warning names the line
+    that imported ``fastapi_cachex`` (for ``importlib.import_module()`` it
+    names ``importlib/__init__.py``; 3.10 has no ``skip_file_prefixes``).
+    """
+    if python < (3, 11):
+        warnings.warn(_PYTHON_310_NOTICE, FutureWarning, stacklevel=3)
+
+
+_warn_python_310()
+
 _package_logger = logging.getLogger("fastapi_cachex")
 _package_logger.addHandler(
     logging.NullHandler()

{fastapi_cachex-0.5.1 → fastapi_cachex-0.5.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-cachex"
-version = "0.5.1"
+version = "0.5.2"
 description = "A caching library for FastAPI with support for Cache-Control, ETag, and multiple backends."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -59,7 +59,7 @@ dev = [
     "coverage>=7.8.0",
     "httpx2>=2.13.1",
     "itsdangerous>=1.1.0",
-    "mypy>=2.4.0",
+    "mypy>=2.4.1",
     "orjson>=3.10.16",
     "pre-commit>=4.2.0",
     "pymemcache>=4.0.0",
@@ -67,7 +67,7 @@ dev = [
     "pytest-asyncio>=0.26.0",
     "pytest-cov>=6.1.0",
     "redis[hiredis]>=5.3.0",
-    "ruff>=0.17.0",
+    "ruff>=0.17.4",
     "tox>=4.25.0",
     "tox-uv>=1.29.0",
     "ty>=0.0.1a34",
@@ -75,7 +75,7 @@ dev = [
     "types-redis>=4.6.0.20241004",
 ]
 docs = [
-    "zensical>=0.0.65,<0.1",
+    "zensical>=0.1,<0.2; python_version >= '3.11'",
     "mkdocstrings-python>=2.0",
     "markdown-callouts>=0.4",
 ]
@@ -98,6 +98,7 @@ asyncio_default_fixture_loop_scope = "function"
 filterwarnings = [
     "error",
     "ignore:The anyio.abc.BlockingPortal alias is deprecated:DeprecationWarning",
+    "ignore:fastapi-cachex 0.6.0 will require Python 3.11:FutureWarning",
 ]
 
 [tool.ruff.lint]

{fastapi_cachex-0.5.1 → fastapi_cachex-0.5.2}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-cachex"
-version = "0.5.1"
+version = "0.5.2"
 description = "A caching library for FastAPI with support for Cache-Control, ETag, and multiple backends."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -51,7 +51,7 @@ dev = [
     "httpx2>=2.13.1",
     # Starlette's SessionMiddleware, which tests of the session bypass use.
     "itsdangerous>=1.1.0",
-    "mypy>=2.4.0",
+    "mypy>=2.4.1",
     "orjson>=3.10.16",
     "pre-commit>=4.2.0",
     "pymemcache>=4.0.0",
@@ -59,7 +59,7 @@ dev = [
     "pytest-asyncio>=0.26.0",
     "pytest-cov>=6.1.0",
     "redis[hiredis]>=5.3.0",
-    "ruff>=0.17.0",
+    "ruff>=0.17.4",
     "tox>=4.25.0",
     "tox-uv>=1.29.0",
     "ty>=0.0.1a34",
@@ -68,7 +68,7 @@ dev = [
 ]
 docs = [
     # Pre-1.0: upgrades are deliberate, not automatic.
-    "zensical>=0.0.65,<0.1",
+    "zensical>=0.1,<0.2; python_version >= '3.11'",
     "mkdocstrings-python>=2.0",
     "markdown-callouts>=0.4",
 ]
@@ -104,6 +104,9 @@ filterwarnings = [
     # deprecates. Later starlette releases no longer use it; nothing in this
     # package or its tests does.
     "ignore:The anyio.abc.BlockingPortal alias is deprecated:DeprecationWarning",
+    # Importing the package warns on Python 3.10 until 0.6.0 drops it (#491);
+    # tests/test_python_support.py checks that warning.
+    "ignore:fastapi-cachex 0.6.0 will require Python 3.11:FutureWarning",
 ]
 
 [tool.ruff.lint]