cachebox 6.2.6__tar.gz → 6.2.7__tar.gz

{cachebox-6.2.6 → cachebox-6.2.7}/.github/workflows/CI.yml

@@ -58,21 +58,24 @@ jobs:
     strategy:
       matrix:
         platform:
-          - { target: x86_64, interpreter: *interpreters }
-          - { target: x86, interpreter: *interpreters }
-          - { target: aarch64, interpreter: *interpreters }
-          - { target: armv7, interpreter: *interpreters }
-          - { target: s390x, interpreter: *interpreters }
-          - { target: ppc64le, interpreter: *interpreters }
+          - { target: x86_64-unknown-linux-gnu, arch: x86_64, interpreter: *interpreters }
+          - { target: i686-unknown-linux-gnu, arch: x86, interpreter: *interpreters }
+          - { target: aarch64-unknown-linux-gnu, arch: aarch64, interpreter: *interpreters }
+          - { target: armv7-unknown-linux-gnueabihf, arch: armv7, interpreter: *interpreters }
+          - { target: s390x-unknown-linux-gnu, arch: s390x, interpreter: *interpreters }
+          - { target: powerpc64le-unknown-linux-gnu, arch: ppc64le, interpreter: *interpreters }
+          - { target: riscv64gc-unknown-linux-gnu, arch: riscv64, interpreter: *interpreters }
 
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
 
-      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with:
-          python-version: "3.x"
+          activate-environment: true
+          enable-cache: false
+          python-version: "3"
 
       - uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
         # zizmor: ignore[cache-poisoning]
@@ -88,7 +91,7 @@ jobs:
 
       - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
-          name: wheels-linux-${{ matrix.platform.target }}
+          name: wheels-linux-${{ matrix.platform.arch }}
           path: dist
 
   build-musllinux:
@@ -96,19 +99,22 @@ jobs:
     strategy:
       matrix:
         platform:
-          - { target: x86_64, interpreter: *interpreters }
-          - { target: x86, interpreter: *interpreters }
-          - { target: aarch64, interpreter: *interpreters }
-          - { target: armv7, interpreter: *interpreters }
+          - { target: x86_64-unknown-linux-musl, arch: x86_64, interpreter: *interpreters }
+          - { target: i686-unknown-linux-musl, arch: x86, interpreter: *interpreters }
+          - { target: aarch64-unknown-linux-musl, arch: aarch64, interpreter: *interpreters }
+          - { target: armv7-unknown-linux-musleabihf, arch: armv7, interpreter: *interpreters }
+          - { target: riscv64gc-unknown-linux-musl, arch: riscv64, interpreter: *interpreters }
 
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
 
-      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with:
-          python-version: "3.x"
+          activate-environment: true
+          enable-cache: false
+          python-version: "3"
 
       - uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
         # zizmor: ignore[cache-poisoning]
@@ -124,7 +130,7 @@ jobs:
 
       - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
-          name: wheels-musllinux-${{ matrix.platform.target }}
+          name: wheels-musllinux-${{ matrix.platform.arch }}
           path: dist
 
   build-windows:

{cachebox-6.2.6 → cachebox-6.2.7}/Cargo.lock

@@ -37,7 +37,7 @@ checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649"
 
 [[package]]
 name = "cachebox"
-version = "6.2.6"
+version = "6.2.7"
 dependencies = [
  "allocator-api2",
  "cfg-if",

{cachebox-6.2.6 → cachebox-6.2.7}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cachebox"
-version = "6.2.6"
+version = "6.2.7"
 edition = "2021"
 description = "The fastest memoizing and caching Python library written in Rust"
 readme = "README.md"

{cachebox-6.2.6 → cachebox-6.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cachebox
-Version: 6.2.6
+Version: 6.2.7
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3

{cachebox-6.2.6 → cachebox-6.2.7}/src/policies/fifopolicy.rs

@@ -419,13 +419,13 @@ impl PolicyExt for FIFOPolicy {
         maxsize: usize,
         getsizeof: Option<alias::PyObject>,
         _global_ttl: Option<std::time::Duration>,
-        builded: pyo3::Bound<'_, pyo3::types::PyTuple>,
+        built: pyo3::Bound<'_, pyo3::types::PyTuple>,
     ) -> pyo3::PyResult<(Self::Shared, Self)> {
         use pyo3::types::PyAnyMethods;
         use pyo3::types::PyListMethods;
         use pyo3::types::PyTupleMethods;
 
-        let list = builded.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
+        let list = built.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
         let list_length = list.len();
 
         if list_length > maxsize {

{cachebox-6.2.6 → cachebox-6.2.7}/src/policies/lfupolicy.rs

@@ -501,13 +501,13 @@ impl PolicyExt for LFUPolicy {
         maxsize: usize,
         getsizeof: Option<alias::PyObject>,
         _global_ttl: Option<std::time::Duration>,
-        builded: pyo3::Bound<'_, pyo3::types::PyTuple>,
+        built: pyo3::Bound<'_, pyo3::types::PyTuple>,
     ) -> pyo3::PyResult<(Self::Shared, Self)> {
         use pyo3::types::PyAnyMethods;
         use pyo3::types::PyListMethods;
         use pyo3::types::PyTupleMethods;
 
-        let list = builded.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
+        let list = built.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
         let list_length = list.len();
 
         if list_length > maxsize {

{cachebox-6.2.6 → cachebox-6.2.7}/src/policies/lrupolicy.rs

@@ -347,13 +347,13 @@ impl PolicyExt for LRUPolicy {
         maxsize: usize,
         getsizeof: Option<alias::PyObject>,
         _global_ttl: Option<std::time::Duration>,
-        builded: pyo3::Bound<'_, pyo3::types::PyTuple>,
+        built: pyo3::Bound<'_, pyo3::types::PyTuple>,
     ) -> pyo3::PyResult<(Self::Shared, Self)> {
         use pyo3::types::PyAnyMethods;
         use pyo3::types::PyListMethods;
         use pyo3::types::PyTupleMethods;
 
-        let list = builded.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
+        let list = built.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
         let list_length = list.len();
 
         if list_length > maxsize {

{cachebox-6.2.6 → cachebox-6.2.7}/src/policies/nopolicy.rs

@@ -266,12 +266,12 @@ impl PolicyExt for NoPolicy {
         maxsize: usize,
         getsizeof: Option<alias::PyObject>,
         _global_ttl: Option<std::time::Duration>,
-        builded: pyo3::Bound<'_, pyo3::types::PyTuple>,
+        built: pyo3::Bound<'_, pyo3::types::PyTuple>,
     ) -> pyo3::PyResult<(Self::Shared, Self)> {
         use pyo3::types::PyDictMethods;
         use pyo3::types::PyTupleMethods;
 
-        let dict = builded.get_item(0)?.cast_into::<pyo3::types::PyDict>()?;
+        let dict = built.get_item(0)?.cast_into::<pyo3::types::PyDict>()?;
         let dict_length = dict.len();
 
         if dict_length > maxsize {

{cachebox-6.2.6 → cachebox-6.2.7}/src/policies/rrpolicy.rs

@@ -277,12 +277,12 @@ impl PolicyExt for RRPolicy {
         maxsize: usize,
         getsizeof: Option<alias::PyObject>,
         _global_ttl: Option<std::time::Duration>,
-        builded: pyo3::Bound<'_, pyo3::types::PyTuple>,
+        built: pyo3::Bound<'_, pyo3::types::PyTuple>,
     ) -> pyo3::PyResult<(Self::Shared, Self)> {
         use pyo3::types::PyDictMethods;
         use pyo3::types::PyTupleMethods;
 
-        let dict = builded.get_item(0)?.cast_into::<pyo3::types::PyDict>()?;
+        let dict = built.get_item(0)?.cast_into::<pyo3::types::PyDict>()?;
         let dict_length = dict.len();
 
         if dict_length > maxsize {

{cachebox-6.2.6 → cachebox-6.2.7}/src/policies/traits.rs

@@ -152,6 +152,6 @@ pub trait PolicyExt: Sized {
         maxsize: usize,
         getsizeof: Option<alias::PyObject>,
         global_ttl: Option<std::time::Duration>,
-        builded: pyo3::Bound<'_, pyo3::types::PyTuple>,
+        built: pyo3::Bound<'_, pyo3::types::PyTuple>,
     ) -> pyo3::PyResult<(Self::Shared, Self)>;
 }

{cachebox-6.2.6 → cachebox-6.2.7}/src/policies/ttlpolicy.rs

@@ -556,7 +556,7 @@ impl PolicyExt for TTLPolicy {
         maxsize: usize,
         getsizeof: Option<alias::PyObject>,
         global_ttl: Option<std::time::Duration>,
-        builded: pyo3::Bound<'_, pyo3::types::PyTuple>,
+        built: pyo3::Bound<'_, pyo3::types::PyTuple>,
     ) -> pyo3::PyResult<(Self::Shared, Self)> {
         use pyo3::types::PyAnyMethods;
         use pyo3::types::PyListMethods;
@@ -566,7 +566,7 @@ impl PolicyExt for TTLPolicy {
             return Err(new_py_error!(PyValueError, "global_ttl is zero"));
         }
 
-        let list = builded.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
+        let list = built.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
         let list_length = list.len();
 
         if list_length > maxsize {

{cachebox-6.2.6 → cachebox-6.2.7}/src/policies/vttlpolicy.rs

@@ -505,13 +505,13 @@ impl PolicyExt for VTTLPolicy {
         maxsize: usize,
         getsizeof: Option<alias::PyObject>,
         _global_ttl: Option<std::time::Duration>,
-        builded: pyo3::Bound<'_, pyo3::types::PyTuple>,
+        built: pyo3::Bound<'_, pyo3::types::PyTuple>,
     ) -> pyo3::PyResult<(Self::Shared, Self)> {
         use pyo3::types::PyAnyMethods;
         use pyo3::types::PyListMethods;
         use pyo3::types::PyTupleMethods;
 
-        let list = builded.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
+        let list = built.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
         let list_length = list.len();
 
         if list_length > maxsize {

{cachebox-6.2.6 → cachebox-6.2.7}/src/policies/wrapped.rs

@@ -53,6 +53,16 @@ impl<P: PolicyExt> Wrapped<P> {
     pub fn policy(&self) -> parking_lot::MutexGuard<'_, P> {
         self.inner.lock()
     }
+
+    /// Acquires the mutex only if it is free, returning `None` otherwise.
+    ///
+    /// For callers that must never wait for the lock, such as `__traverse__`:
+    /// the thread holding the lock may be running Python code, and a garbage
+    /// collection pass landing there would deadlock the whole process.
+    #[inline(always)]
+    pub fn try_policy(&self) -> Option<parking_lot::MutexGuard<'_, P>> {
+        self.inner.try_lock()
+    }
 }
 
 #[inline(always)]
@@ -298,13 +308,13 @@ impl<P: PolicyExt> Wrapped<P> {
             return Err(new_py_error!(PyValueError, "global_ttl is negative"));
         }
 
-        let builded = tuple.get_item(3)?.cast_into::<pyo3::types::PyTuple>()?;
+        let built = tuple.get_item(3)?.cast_into::<pyo3::types::PyTuple>()?;
 
         let (shared, inner) = P::from_pickle(
             maxsize,
             getsizeof,
             global_ttl.map(std::time::Duration::from_secs_f64),
-            builded,
+            built,
         )?;
 
         Ok(Self {

{cachebox-6.2.6 → cachebox-6.2.7}/src/pyclasses/cache.rs

@@ -651,7 +651,9 @@ impl PyCache {
         }
 
         let inner = self.0.get();
-        let policy = inner.policy();
+        let Some(policy) = inner.try_policy() else {
+            return Ok(());
+        };
 
         for handle_ref in unsafe { policy.table().iter() } {
             let handle = unsafe { handle_ref.as_ref() };

{cachebox-6.2.6 → cachebox-6.2.7}/src/pyclasses/fifocache.rs

@@ -679,7 +679,9 @@ impl PyFIFOCache {
         }
 
         let inner = self.0.get();
-        let policy = inner.policy();
+        let Some(policy) = inner.try_policy() else {
+            return Ok(());
+        };
 
         for handle in policy.entries().iter() {
             visit.call(handle.key().as_ref())?;

{cachebox-6.2.6 → cachebox-6.2.7}/src/pyclasses/lfucache.rs

@@ -744,7 +744,9 @@ impl PyLFUCache {
         }
 
         let inner = self.0.get();
-        let policy = inner.policy();
+        let Some(policy) = inner.try_policy() else {
+            return Ok(());
+        };
 
         for cursor in unsafe { policy.table().iter() } {
             let handle = unsafe { cursor.as_ref().element() };

{cachebox-6.2.6 → cachebox-6.2.7}/src/pyclasses/lrucache.rs

@@ -725,7 +725,9 @@ impl PyLRUCache {
         }
 
         let inner = self.0.get();
-        let policy = inner.policy();
+        let Some(policy) = inner.try_policy() else {
+            return Ok(());
+        };
 
         for cursor in unsafe { policy.list().iter() } {
             let handle = unsafe { cursor.element() };

{cachebox-6.2.6 → cachebox-6.2.7}/src/pyclasses/rrcache.rs

@@ -671,7 +671,9 @@ impl PyRRCache {
         }
 
         let inner = self.0.get();
-        let policy = inner.policy();
+        let Some(policy) = inner.try_policy() else {
+            return Ok(());
+        };
 
         for handle_ref in unsafe { policy.table().iter() } {
             let handle = unsafe { handle_ref.as_ref() };

{cachebox-6.2.6 → cachebox-6.2.7}/src/pyclasses/ttlcache.rs

@@ -816,7 +816,9 @@ impl PyTTLCache {
         }
 
         let inner = self.0.get();
-        let policy = inner.policy();
+        let Some(policy) = inner.try_policy() else {
+            return Ok(());
+        };
 
         for handle in policy.entries().iter() {
             visit.call(handle.key().as_ref())?;

{cachebox-6.2.6 → cachebox-6.2.7}/src/pyclasses/vttlcache.rs

@@ -776,7 +776,9 @@ impl PyVTTLCache {
         }
 
         let inner = self.0.get();
-        let policy = inner.policy();
+        let Some(policy) = inner.try_policy() else {
+            return Ok(());
+        };
 
         for cursor in unsafe { policy.table().iter() } {
             let handle = unsafe { cursor.as_ref().element() };

{cachebox-6.2.6 → cachebox-6.2.7}/tests/mixins.py

@@ -101,6 +101,23 @@ class InitializeMixin(BaseMixin):
 
 
 class InsertAndGetMixin(BaseMixin):
+    def test_key_eq_may_trigger_the_gc(self):
+        # __eq__ runs in the middle of a probe, with the lock held; a deadlock
+        # here would keep the GIL, so the call runs in a child process
+        name = type(self.create_cache()).__name__
+
+        try:
+            done = subprocess.run(
+                [sys.executable, "-c", EQ_TRIGGERING_GC, name],
+                capture_output=True,
+                text=True,
+                timeout=60,
+            )
+        except subprocess.TimeoutExpired:
+            pytest.fail(f"{name}.get() with a colliding key never returned")
+
+        assert done.stdout.strip() == "ok", done.stderr
+
     def test_insert_returns_none_on_new_key(self):
         cache = self.create_cache()
 
@@ -205,6 +222,55 @@ class SetDefaultMixin(BaseMixin):
         assert cache.get("k") == "existing"
 
 
+DROPPED_VALUE_TRIGGERING_GC = """
+import gc
+import sys
+
+import cachebox
+
+name = sys.argv[1]
+cls = getattr(cachebox, name)
+cache = cls(10, global_ttl=60) if name == "TTLCache" else cls(10)
+
+
+class Boom:
+    def __del__(self):
+        gc.collect()
+
+
+cache.insert("k", Boom())
+cache.clear()
+print("ok")
+"""
+
+EQ_TRIGGERING_GC = """
+import gc
+import sys
+
+import cachebox
+
+name = sys.argv[1]
+cls = getattr(cachebox, name)
+cache = cls(10, global_ttl=60) if name == "TTLCache" else cls(10)
+
+
+class Key:
+    def __init__(self, name):
+        self.name = name
+
+    def __hash__(self):
+        return 42  # same hash for every key, so lookups have to call __eq__
+
+    def __eq__(self, other):
+        gc.collect()
+        return self.name == other.name
+
+
+cache.insert(Key("a"), 1)
+assert cache.get(Key("b")) is None
+print("ok")
+"""
+
 FACTORY_TOUCHING_CACHE = """
 import gc
 import sys
@@ -635,6 +701,22 @@ class IterationMixin(BaseMixin):
 
 
 class DrainClearShrinkMixin(BaseMixin):
+    def test_dropping_a_value_may_trigger_the_gc(self):
+        # a deadlock here would keep the GIL, so the call runs in a child process
+        name = type(self.create_cache()).__name__
+
+        try:
+            done = subprocess.run(
+                [sys.executable, "-c", DROPPED_VALUE_TRIGGERING_GC, name],
+                capture_output=True,
+                text=True,
+                timeout=60,
+            )
+        except subprocess.TimeoutExpired:
+            pytest.fail(f"{name}.clear() never returned")
+
+        assert done.stdout.strip() == "ok", done.stderr
+
     def test_clear_removes_all_items(self):
         cache = self.create_cache()
 

{cachebox-6.2.6 → cachebox-6.2.7}/typos.toml

@@ -1,13 +1,7 @@
 [default.extend-words]
-# error: `builded` should be `built`
-#    --> .\src\policies\ttlpolicy.rs:569:20
-#     |
-# 569 |         let list = builded.get_item(0)?.cast_into::<pyo3::types::PyList>()?;
-#     |                    ^^^^^^^
-builded = "builded"
 # error: `fo` should be `of`, `for`, `do`, `go`, `to`
 #    --> .\src\policies\fifopolicy.rs:212:66
 #     |
 # 212 |             //   - All others:               (vd_idx + fo)     - fo  =  vd_idx
 #     |                                                                  ^^
-fo = "fo"
+fo = "fo"