Ignore cleanup errors on Windows

Author: strawgate

key-value/key-value-aio/src/key_value/aio/stores/rocksdb/store.py

@@ -3,7 +3,6 @@
 from pathlib import Path
 from typing import overload
 
-from key_value.shared.errors.store import KeyValueStoreError
 from key_value.shared.utils.compound import compound_key
 from key_value.shared.utils.managed_entry import ManagedEntry
 from typing_extensions import override
@@ -21,7 +20,6 @@ class RocksDBStore(BaseContextManagerStore, BaseStore):
     """A RocksDB-based key-value store."""
 
     _db: Rdict
-    _is_closed: bool
 
     @overload
     def __init__(self, *, db: Rdict, default_collection: str | None = None) -> None:
@@ -78,8 +76,6 @@ def __init__(
 
             self._db = Rdict(str(path), options=opts)
 
-        self._is_closed = False
-
         super().__init__(
             default_collection=default_collection,
             client_provided_by_user=client_provided,
@@ -93,19 +89,11 @@ async def _setup(self) -> None:
             self._exit_stack.callback(self._close_and_flush)
 
     def _close_and_flush(self) -> None:
-        if not self._is_closed:
-            self._db.flush()
-            self._db.close()
-            self._is_closed = True
-
-    def _fail_on_closed_store(self) -> None:
-        if self._is_closed:
-            raise KeyValueStoreError(message="Operation attempted on closed store")
+        self._db.flush()
+        self._db.close()
 
     @override
     async def _get_managed_entry(self, *, key: str, collection: str) -> ManagedEntry | None:
-        self._fail_on_closed_store()
-
         combo_key: str = compound_key(collection=collection, key=key)
 
         value: bytes | None = self._db.get(combo_key)
@@ -126,8 +114,6 @@ async def _put_managed_entry(
         collection: str,
         managed_entry: ManagedEntry,
     ) -> None:
-        self._fail_on_closed_store()
-
         combo_key: str = compound_key(collection=collection, key=key)
         json_value: str = self._serialization_adapter.dump_json(entry=managed_entry, key=key, collection=collection)
 
@@ -144,8 +130,6 @@ async def _put_managed_entries(
         created_at: datetime,
         expires_at: datetime | None,
     ) -> None:
-        self._fail_on_closed_store()
-
         if not keys:
             return
 
@@ -159,8 +143,6 @@ async def _put_managed_entries(
 
     @override
     async def _delete_managed_entry(self, *, key: str, collection: str) -> bool:
-        self._fail_on_closed_store()
-
         combo_key: str = compound_key(collection=collection, key=key)
 
         # Check if key exists before deleting, this is only used for tracking deleted count
@@ -172,8 +154,6 @@ async def _delete_managed_entry(self, *, key: str, collection: str) -> bool:
 
     @override
     async def _delete_managed_entries(self, *, keys: Sequence[str], collection: str) -> int:
-        self._fail_on_closed_store()
-
         if not keys:
             return 0
 
@@ -194,10 +174,3 @@ async def _delete_managed_entries(self, *, keys: Sequence[str], collection: str)
             self._db.write(batch)
 
         return deleted_count
-
-    def __del__(self) -> None:
-        if not getattr(self, "_client_provided_by_user", False):
-            try:  # noqa: SIM105
-                self._close_and_flush()
-            except (AttributeError, Exception):  # noqa: S110
-                pass  # Best-effort cleanup during finalization

key-value/key-value-aio/tests/stores/base.py

@@ -1,4 +1,5 @@
 import hashlib
+import sys
 import tempfile
 from abc import ABC, abstractmethod
 from collections.abc import AsyncGenerator
@@ -30,7 +31,13 @@ async def eventually_consistent(self) -> None:  # noqa: B027
 
     @pytest.fixture
     async def per_test_temp_dir(self) -> AsyncGenerator[Path, None]:
-        with tempfile.TemporaryDirectory() as temp_dir:
+        # ignore cleanup errors on Windows
+        if sys.platform == "win32":
+            ignore_cleanup_errors = True
+        else:
+            ignore_cleanup_errors = False
+
+        with tempfile.TemporaryDirectory(ignore_cleanup_errors=ignore_cleanup_errors) as temp_dir:
             yield Path(temp_dir)
 
     @pytest.fixture

key-value/key-value-sync/src/key_value/sync/code_gen/stores/rocksdb/store.py

@@ -6,7 +6,6 @@
 from pathlib import Path
 from typing import overload
 
-from key_value.shared.errors.store import KeyValueStoreError
 from key_value.shared.utils.compound import compound_key
 from key_value.shared.utils.managed_entry import ManagedEntry
 from typing_extensions import override
@@ -24,7 +23,6 @@ class RocksDBStore(BaseContextManagerStore, BaseStore):
     """A RocksDB-based key-value store."""
 
     _db: Rdict
-    _is_closed: bool
 
     @overload
     def __init__(self, *, db: Rdict, default_collection: str | None = None) -> None:
@@ -75,8 +73,6 @@ def __init__(self, *, db: Rdict | None = None, path: Path | str | None = None, d
 
             self._db = Rdict(str(path), options=opts)
 
-        self._is_closed = False
-
         super().__init__(default_collection=default_collection, client_provided_by_user=client_provided)
 
     @override
@@ -87,19 +83,11 @@ def _setup(self) -> None:
             self._exit_stack.callback(self._close_and_flush)
 
     def _close_and_flush(self) -> None:
-        if not self._is_closed:
-            self._db.flush()
-            self._db.close()
-            self._is_closed = True
-
-    def _fail_on_closed_store(self) -> None:
-        if self._is_closed:
-            raise KeyValueStoreError(message="Operation attempted on closed store")
+        self._db.flush()
+        self._db.close()
 
     @override
     def _get_managed_entry(self, *, key: str, collection: str) -> ManagedEntry | None:
-        self._fail_on_closed_store()
-
         combo_key: str = compound_key(collection=collection, key=key)
 
         value: bytes | None = self._db.get(combo_key)
@@ -114,8 +102,6 @@ def _get_managed_entry(self, *, key: str, collection: str) -> ManagedEntry | Non
 
     @override
     def _put_managed_entry(self, *, key: str, collection: str, managed_entry: ManagedEntry) -> None:
-        self._fail_on_closed_store()
-
         combo_key: str = compound_key(collection=collection, key=key)
         json_value: str = self._serialization_adapter.dump_json(entry=managed_entry, key=key, collection=collection)
 
@@ -132,8 +118,6 @@ def _put_managed_entries(
         created_at: datetime,
         expires_at: datetime | None,
     ) -> None:
-        self._fail_on_closed_store()
-
         if not keys:
             return
 
@@ -147,8 +131,6 @@ def _put_managed_entries(
 
     @override
     def _delete_managed_entry(self, *, key: str, collection: str) -> bool:
-        self._fail_on_closed_store()
-
         combo_key: str = compound_key(collection=collection, key=key)
 
         # Check if key exists before deleting, this is only used for tracking deleted count
@@ -160,8 +142,6 @@ def _delete_managed_entry(self, *, key: str, collection: str) -> bool:
 
     @override
     def _delete_managed_entries(self, *, keys: Sequence[str], collection: str) -> int:
-        self._fail_on_closed_store()
-
         if not keys:
             return 0
 
@@ -182,10 +162,3 @@ def _delete_managed_entries(self, *, keys: Sequence[str], collection: str) -> in
             self._db.write(batch)
 
         return deleted_count
-
-    def __del__(self) -> None:
-        if not getattr(self, "_client_provided_by_user", False):
-            try:  # noqa: SIM105
-                self._close_and_flush()
-            except (AttributeError, Exception):  # noqa: S110
-                pass  # Best-effort cleanup during finalization

key-value/key-value-sync/tests/code_gen/stores/base.py

@@ -2,6 +2,7 @@
 # from the original file 'base.py'
 # DO NOT CHANGE! Change the original file instead.
 import hashlib
+import sys
 import tempfile
 from abc import ABC, abstractmethod
 from collections.abc import Generator
@@ -27,7 +28,13 @@ def eventually_consistent(self) -> None:  # noqa: B027
 
     @pytest.fixture
     def per_test_temp_dir(self) -> Generator[Path, None, None]:
-        with tempfile.TemporaryDirectory() as temp_dir:
+        # ignore cleanup errors on Windows
+        if sys.platform == "win32":
+            ignore_cleanup_errors = True
+        else:
+            ignore_cleanup_errors = False
+
+        with tempfile.TemporaryDirectory(ignore_cleanup_errors=ignore_cleanup_errors) as temp_dir:
             yield Path(temp_dir)
 
     @pytest.fixture