client-query-cache 0.3.0__tar.gz → 0.4.0__tar.gz

{client_query_cache-0.3.0 → client_query_cache-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: client-query-cache
-Version: 0.3.0
+Version: 0.4.0
 Summary: Client-side caching for PyMongo, kept coherent using MongoDB change streams.
 Author: Alessio Locatelli
 Author-email: Alessio Locatelli <<software.development@secure.mailbox.org>>
@@ -45,7 +45,7 @@ with (
     MongoClient("mongodb://localhost:27017") as client,
     CacheManager(client) as cache,
 ):
-    users = cache.cached(client["my_database"]["users"])
+    users = cache.get_cached_collection(client["my_database"]["users"])
     users.find_one({"_id": "alice"})  # Reads from MongoDB.
     users.find_one({"_id": "alice"})  # Repeated reads can use the cache.
 ```

{client_query_cache-0.3.0 → client_query_cache-0.4.0}/README.md

@@ -31,7 +31,7 @@ with (
     MongoClient("mongodb://localhost:27017") as client,
     CacheManager(client) as cache,
 ):
-    users = cache.cached(client["my_database"]["users"])
+    users = cache.get_cached_collection(client["my_database"]["users"])
     users.find_one({"_id": "alice"})  # Reads from MongoDB.
     users.find_one({"_id": "alice"})  # Repeated reads can use the cache.
 ```

{client_query_cache-0.3.0 → client_query_cache-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "client-query-cache"
-version = "0.3.0"
+version = "0.4.0"
 description = "Client-side caching for PyMongo, kept coherent using MongoDB change streams."
 readme = "README.md"
 requires-python = ">=3.14.6"
@@ -46,6 +46,8 @@ dev = [
     "python-snappy>=0.7.3",
     "pytest-xdist[psutil]>=3.8.0",
     "pytest-cov>=7.1.0",
+    "pyyaml>=6.0.3",
+    "types-pyyaml>=6.0.12.20260906",
 ]
 docs = [
     "mike",
@@ -61,16 +63,11 @@ build-backend = "uv_build"
 [tool.uv]
 environments = ["sys_platform == 'linux'"]
 
-[tool.uv.build-backend]
-module-root = "src"
-
 [tool.uv.sources.mike]
 git = "https://github.com/squidfunk/mike.git"
 rev = "2d4ad799442f4592db8ad53b179bfb33db8c69ac"
 
 [tool.slotscheck]
-strict-imports = true
-require-superclass = true
 require-subclass = true
 exclude-modules = """
 (

{client_query_cache-0.3.0 → client_query_cache-0.4.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "client-query-cache"
-version = "0.3.0"
+version = "0.4.0"
 description = "Client-side caching for PyMongo, kept coherent using MongoDB change streams."
 authors = [
   { name = "Alessio Locatelli", email = "<software.development@secure.mailbox.org>" },
@@ -45,6 +45,8 @@ dev = [
   "python-snappy>=0.7.3",
   "pytest-xdist[psutil]>=3.8.0",
   "pytest-cov>=7.1.0",
+  "pyyaml>=6.0.3",
+  "types-pyyaml>=6.0.12.20260906",
 ]
 docs = ["mike", "tomli-w>=1.2.0", "zensical>=0.0.68"]
 memory = ["pytest-memray>=1.11.0"]
@@ -53,18 +55,17 @@ memory = ["pytest-memray>=1.11.0"]
 requires = ["uv_build>=0.12.18,<0.13.0"]
 build-backend = "uv_build"
 
-[tool.uv.build-backend]
-module-root = "src"
-
 [tool.uv]
+# uv 0.12.9 / lock context: https://docs.astral.sh/uv/reference/settings/#environments
+# The default is all environments. We override it because development dependencies and their lock resolution target Linux.
 environments = ["sys_platform == 'linux'"]
 
 [tool.uv.sources]
 mike = { git = "https://github.com/squidfunk/mike.git", rev = "2d4ad799442f4592db8ad53b179bfb33db8c69ac" } # pragma: allowlist secret
 
 [tool.slotscheck]
-strict-imports = true
-require-superclass = true
+# slotscheck 0.21.0: https://github.com/ariebovenberg/slotscheck/blob/v0.21.0/src/slotscheck/config.py
+# require-subclass: The default is false. We override it because subclasses must preserve their slotted parent's memory contract.
 require-subclass = true
 exclude-modules = '''
 (
@@ -77,10 +78,15 @@ exclude-modules = '''
 paths = ["src", "tests", "benchmarks", ".vulture_whitelist"]
 
 [tool.ruff-extra-rules]
+# ruff-extra-rules v0.5.0: https://github.com/alessio-locatelli/ruff-extra-rules/blob/v0.5.0/README.md
+# The default is false. We override it because hook runs should apply available repairs.
 fix = true
 exclude = ["specifications"]
 extend-select = ["unused-pytriage"]
 [tool.ruff-extra-rules.meaningless-vars]
+# ruff-extra-rules v0.5.0: https://github.com/alessio-locatelli/ruff-extra-rules/tree/v0.5.0/src/pre_commit_hooks/ast_checks
+# For meaningless-vars, redundant-assignment, redundant-type-conversion, redundant-dict-get, and defined-far-from-use level:
+# The default is conservative. We override it because repository quality checks must include the broader supported simplifications and naming diagnostics.
 level = "aggressive"
 [tool.ruff-extra-rules.redundant-assignment]
 level = "aggressive"

{client_query_cache-0.3.0 → client_query_cache-0.4.0}/src/client_query_cache/asynchronous/collection.py

@@ -178,7 +178,7 @@ class CachedCollection[DocumentType: Mapping[str, Any]]:
             )
         effective_collation = effective_find_one_collation(
             collation,
-            self._database.manager.default_collation_for(self._namespace()),
+            self._database.manager._default_collation_for(self._namespace()),  # noqa: SLF001
         )
         if collation is None and effective_collation is not None:
             read_shape = canonicalize(
@@ -195,7 +195,7 @@ class CachedCollection[DocumentType: Mapping[str, Any]]:
             )
         namespace = self._namespace()
         cache = self._database.manager.cache_core
-        known_keys = await self._database.manager.unique_keys_for(namespace)
+        known_keys = await self._database.manager._unique_keys_for(namespace)  # noqa: SLF001
         unique_key_match = (
             match_unique_key(filter_query, known_keys, effective_collation)
             if identity is NO_IDENTITY and known_keys is not None
@@ -495,7 +495,7 @@ class CachedCollection[DocumentType: Mapping[str, Any]]:
     async def _match_unique_key(
         self, filter_query: object, effective_collation: Mapping[str, Any] | None
     ) -> tuple[UniqueKeyDefinition, tuple[Any, ...]] | None:
-        keys = await self._database.manager.unique_keys_for(
+        keys = await self._database.manager._unique_keys_for(  # noqa: SLF001
             self._namespace(), self._list_indexes_probe
         )
         if not keys:
@@ -655,7 +655,7 @@ class CachedCollection[DocumentType: Mapping[str, Any]]:
         return self._forced_database
 
     async def _cache_ineligibility_reason(self) -> BypassReason | None:
-        return await self._database.manager.cache_ineligibility_reason(
+        return await self._database.manager._cache_ineligibility_reason(  # noqa: SLF001
             self._namespace(), self._probe_collection
         )
 

{client_query_cache-0.3.0 → client_query_cache-0.4.0}/src/client_query_cache/asynchronous/manager.py

@@ -76,16 +76,7 @@ class CacheManager[DocumentType: Mapping[str, Any]]:
     def active_stream_cost_databases(self) -> list[str]:
         return self._cache.active_stream_cost_databases()
 
-    async def ensure_cache_eligible(
-        self,
-        namespace: NamespaceId,
-        collection_probe: Callable[[], Awaitable[CollectionProbeResult | None]],
-    ) -> bool:
-        return (
-            await self.cache_ineligibility_reason(namespace, collection_probe) is None
-        )
-
-    async def cache_ineligibility_reason(
+    async def _cache_ineligibility_reason(
         self,
         namespace: NamespaceId,
         collection_probe: Callable[[], Awaitable[CollectionProbeResult | None]],
@@ -112,23 +103,25 @@ class CacheManager[DocumentType: Mapping[str, Any]]:
             self._metadata.put(namespace, cached)
         return cached.bypass_reason
 
-    def default_collation_for(self, namespace: NamespaceId) -> Mapping[str, Any] | None:
+    def _default_collation_for(
+        self, namespace: NamespaceId
+    ) -> Mapping[str, Any] | None:
         cached = self._metadata.get(namespace)
         return cached.default_collation if cached is not None else None
 
     @overload
-    async def unique_keys_for(
+    async def _unique_keys_for(
         self,
         namespace: NamespaceId,
         list_indexes: Callable[[], Awaitable[Sequence[Mapping[str, Any]] | None]],
     ) -> tuple[UniqueKeyDefinition, ...]: ...
 
     @overload
-    async def unique_keys_for(
+    async def _unique_keys_for(
         self, namespace: NamespaceId, list_indexes: None = None
     ) -> tuple[UniqueKeyDefinition, ...] | None: ...
 
-    async def unique_keys_for(
+    async def _unique_keys_for(
         self,
         namespace: NamespaceId,
         list_indexes: Callable[[], Awaitable[Sequence[Mapping[str, Any]] | None]]
@@ -154,7 +147,7 @@ class CacheManager[DocumentType: Mapping[str, Any]]:
     def __getitem__(self, name: str) -> CachedDatabase[DocumentType]:
         return CachedDatabase(self, self._client[name])
 
-    def cached(
+    def get_cached_collection(
         self, collection: AsyncCollection[DocumentType]
     ) -> CachedCollection[DocumentType]:
         if collection.database.client is not self._client:

{client_query_cache-0.3.0 → client_query_cache-0.4.0}/src/client_query_cache/synchronous/collection.py

@@ -178,7 +178,7 @@ class CachedCollection[DocumentType: Mapping[str, Any]]:
             )
         effective_collation = effective_find_one_collation(
             collation,
-            self._database.manager.default_collation_for(self._namespace()),
+            self._database.manager._default_collation_for(self._namespace()),  # noqa: SLF001
         )
         if collation is None and effective_collation is not None:
             read_shape = canonicalize(
@@ -195,7 +195,7 @@ class CachedCollection[DocumentType: Mapping[str, Any]]:
             )
         namespace = self._namespace()
         cache = self._database.manager.cache_core
-        known_keys = self._database.manager.unique_keys_for(namespace)
+        known_keys = self._database.manager._unique_keys_for(namespace)  # noqa: SLF001
         unique_key_match = (
             match_unique_key(filter_query, known_keys, effective_collation)
             if identity is NO_IDENTITY and known_keys is not None
@@ -491,7 +491,7 @@ class CachedCollection[DocumentType: Mapping[str, Any]]:
     def _match_unique_key(
         self, filter_query: object, effective_collation: Mapping[str, Any] | None
     ) -> tuple[UniqueKeyDefinition, tuple[Any, ...]] | None:
-        keys = self._database.manager.unique_keys_for(
+        keys = self._database.manager._unique_keys_for(  # noqa: SLF001
             self._namespace(), self._list_indexes_probe
         )
         if not keys:
@@ -651,7 +651,7 @@ class CachedCollection[DocumentType: Mapping[str, Any]]:
         return self._forced_database
 
     def _cache_ineligibility_reason(self) -> BypassReason | None:
-        return self._database.manager.cache_ineligibility_reason(
+        return self._database.manager._cache_ineligibility_reason(  # noqa: SLF001
             self._namespace(), self._probe_collection
         )
 

{client_query_cache-0.3.0 → client_query_cache-0.4.0}/src/client_query_cache/synchronous/manager.py

@@ -76,14 +76,7 @@ class CacheManager[DocumentType: Mapping[str, Any]]:
     def active_stream_cost_databases(self) -> list[str]:
         return self._cache.active_stream_cost_databases()
 
-    def ensure_cache_eligible(
-        self,
-        namespace: NamespaceId,
-        collection_probe: Callable[[], CollectionProbeResult | None],
-    ) -> bool:
-        return self.cache_ineligibility_reason(namespace, collection_probe) is None
-
-    def cache_ineligibility_reason(
+    def _cache_ineligibility_reason(
         self,
         namespace: NamespaceId,
         collection_probe: Callable[[], CollectionProbeResult | None],
@@ -110,23 +103,25 @@ class CacheManager[DocumentType: Mapping[str, Any]]:
             self._metadata.put(namespace, cached)
         return cached.bypass_reason
 
-    def default_collation_for(self, namespace: NamespaceId) -> Mapping[str, Any] | None:
+    def _default_collation_for(
+        self, namespace: NamespaceId
+    ) -> Mapping[str, Any] | None:
         cached = self._metadata.get(namespace)
         return cached.default_collation if cached is not None else None
 
     @overload
-    def unique_keys_for(
+    def _unique_keys_for(
         self,
         namespace: NamespaceId,
         list_indexes: Callable[[], Sequence[Mapping[str, Any]] | None],
     ) -> tuple[UniqueKeyDefinition, ...]: ...
 
     @overload
-    def unique_keys_for(
+    def _unique_keys_for(
         self, namespace: NamespaceId, list_indexes: None = None
     ) -> tuple[UniqueKeyDefinition, ...] | None: ...
 
-    def unique_keys_for(
+    def _unique_keys_for(
         self,
         namespace: NamespaceId,
         list_indexes: Callable[[], Sequence[Mapping[str, Any]] | None] | None = None,
@@ -151,7 +146,7 @@ class CacheManager[DocumentType: Mapping[str, Any]]:
     def __getitem__(self, name: str) -> CachedDatabase[DocumentType]:
         return CachedDatabase(self, self._client[name])
 
-    def cached(
+    def get_cached_collection(
         self, collection: Collection[DocumentType]
     ) -> CachedCollection[DocumentType]:
         if collection.database.client is not self._client: