syncwave 0.1.3__tar.gz → 0.1.4__tar.gz

{syncwave-0.1.3 → syncwave-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: syncwave
-Version: 0.1.3
+Version: 0.1.4
 Summary: Make your code reactive; Turn plain JSONs into a live data store, two-way synced with Python objects.
 Keywords: 
 Author: Lucas Iannitello

{syncwave-0.1.3 → syncwave-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "syncwave"
-version = "0.1.3"
+version = "0.1.4"
 description = "Make your code reactive; Turn plain JSONs into a live data store, two-way synced with Python objects."
 readme = "README.md"
 authors = [{ name = "Lucas Iannitello", email = "lucas.iannitello@protonmail.com" }]
@@ -28,8 +28,24 @@ dev = [
 ]
 
 [tool.ruff.lint]
-select = ["E", "F"]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "SIM",  # flake8-simplify
+    "ANN",  # flake8-annotations
+    "RUF",  # ruff
+    "UP",  # pyupgrade
+]
 
 unfixable = [
     "F401"  # disable fix for unused imports
 ]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["I002"]
+
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]

{syncwave-0.1.3 → syncwave-0.1.4}/src/syncwave/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.3"
+__version__ = "0.1.4"
 
 
 from .syncwave import SyncStore, Syncwave

{syncwave-0.1.3 → syncwave-0.1.4}/src/syncwave/io.py

@@ -1,9 +1,12 @@
+from __future__ import annotations
+
+import contextlib
 import json
 import os
 from pathlib import Path
 from tempfile import mkstemp
 from threading import Lock, Timer
-from typing import Any, Callable
+from typing import Any, Callable, Final
 
 from .watcher import watcher
 
@@ -12,10 +15,10 @@ DataProvider = Callable[[], JSONData]
 
 
 class _IO:
-    ENCODING = "utf-8"
-    DEFAULT_JSON_CONTENT = {}
-    DUMPS_CONFIG = {"indent": 2, "ensure_ascii": False}
-    DEBOUNCE_WINDOW = 0.05
+    ENCODING: Final[str] = "utf-8"
+    DEFAULT_JSON_CONTENT: Final[JSONData] = {}
+    DUMPS_CONFIG: Final[dict[str, Any]] = {"indent": 2, "ensure_ascii": False}
+    DEBOUNCE_WINDOW: Final[float] = 0.05
 
     def __init__(self) -> None:
         self._lock = Lock()
@@ -37,7 +40,7 @@ class _IO:
             with path.open(encoding=self.ENCODING) as f:
                 json.load(f)
         except json.JSONDecodeError as e:
-            raise IOError(f"File '{path}' exists but is not a valid JSON file.") from e
+            raise OSError(f"File '{path}' exists but is not a valid JSON file.") from e
 
     def read_json(self, path: Path) -> JSONData:
         with self._lock:
@@ -83,12 +86,10 @@ class _IO:
 
         except Exception as e:
             # Attempt to remove temporary file on error
-            try:
+            with contextlib.suppress(OSError):
                 os.remove(tmp_path)
-            except OSError:
-                pass
             # Raise a clear error message including context
-            raise IOError(
+            raise OSError(
                 f"Failed to write JSON to '{path}'. "
                 f"Temporary file '{tmp_path}' removed. Original error: {e}"
             ) from e

{syncwave-0.1.3 → syncwave-0.1.4}/src/syncwave/syncwave.py

@@ -1,9 +1,11 @@
-from collections.abc import Mapping
+from __future__ import annotations
+
+from collections.abc import Iterator, Mapping
 from inspect import isclass
 from json import JSONDecodeError
 from pathlib import Path
 from threading import RLock
-from typing import Any, Callable, Iterator, Optional, Type, Union, get_args, overload
+from typing import Any, Callable, Union, get_args, overload
 
 from pydantic import BaseModel, ValidationError, create_model, model_validator
 
@@ -14,7 +16,7 @@ from .watcher import watcher
 JSONKey = Union[str, int, float, bool, None]
 
 
-def _validate_key_type(cls: Type[BaseModel], key: str) -> None:
+def _validate_key_type(cls: type[BaseModel], key: str) -> None:
     # This will work if the key field is a basic type (str, int, float, bool, or None),
     # but will fail for more complex types (Union[str, int], Optional[str], etc.).
     # In that case skip the validation.
@@ -31,17 +33,17 @@ def _validate_key_type(cls: Type[BaseModel], key: str) -> None:
 class SyncStore(Mapping[JSONKey, BaseModel]):
     def __init__(
         self,
-        syncwave: "Syncwave",
-        cls: Type[BaseModel],
+        syncwave: Syncwave,
+        cls: type[BaseModel],
         /,
-        name: Optional[str] = None,
-        key: Optional[str] = None,
+        name: str | None = None,
+        key: str | None = None,
         *,
         skip_key_validation: bool = False,
-        file_name: Optional[str] = None,
-        sub_dir: Optional[Union[Path, str]] = None,
-        file_path: Optional[Union[Path, str]] = None,
-        new_cls_name: Optional[str] = None,
+        file_name: str | None = None,
+        sub_dir: Path | str | None = None,
+        file_path: Path | str | None = None,
+        new_cls_name: str | None = None,
         # in_memory: bool = True,  # TODO: implement in_memory
     ) -> None:
         if not isinstance(syncwave, Syncwave):
@@ -123,8 +125,8 @@ class SyncStore(Mapping[JSONKey, BaseModel]):
     def _get_path(
         self,
         file_name: str,
-        sub_dir: Union[Path, str, None],
-        file_path: Union[Path, str, None],
+        sub_dir: Path | str | None,
+        file_path: Path | str | None,
     ) -> Path:
         if file_path:
             return Path(file_path).resolve()
@@ -133,7 +135,7 @@ class SyncStore(Mapping[JSONKey, BaseModel]):
             return (self.syncwave.data_dir / sub_dir / file_name).resolve()
         return (self.syncwave.data_dir / file_name).resolve()
 
-    def _patch_cls(self, cls: Type[BaseModel], new_cls_name: str) -> Type[BaseModel]:
+    def _patch_cls(self, cls: type[BaseModel], new_cls_name: str) -> type[BaseModel]:
         # This is a validator that acts as a post-initialization hook.
         # Using a validator instead of `__init__` ensures every instance is tracked.
         # Libraries such as FastAPI may create instances indirectly with methods like
@@ -157,7 +159,7 @@ class SyncStore(Mapping[JSONKey, BaseModel]):
         original_setattr = cls.__setattr__
         original_delattr = cls.__delattr__
 
-        def __setattr__(self_model: BaseModel, attr: str, value: Any) -> None:
+        def __setattr__(self_model: BaseModel, attr: str, value: Any) -> None:  # noqa: ANN401
             # TODO check for edge cases
             old_value = getattr(self_model, attr)
             original_setattr(self_model, attr, value)
@@ -183,7 +185,7 @@ class SyncStore(Mapping[JSONKey, BaseModel]):
 
 
 class Syncwave(Mapping[str, SyncStore]):
-    def __init__(self, data_dir: Union[str, Path]) -> None:
+    def __init__(self, data_dir: str | Path) -> None:
         self.data_dir = Path(data_dir).resolve()
         self._swd: dict[str, SyncStore] = {}  # actual mapping, swd = SyncWaveDict
 
@@ -216,28 +218,28 @@ class Syncwave(Mapping[str, SyncStore]):
     def register(
         self,
         *,
-        name: Optional[str] = None,
-        key: Optional[str] = None,
+        name: str | None = None,
+        key: str | None = None,
         skip_key_validation: bool = False,
-        file_name: Optional[str] = None,
-        sub_dir: Optional[Union[Path, str]] = None,
-        file_path: Optional[Union[Path, str]] = None,
-    ) -> Callable[[Type[BaseModel]], Type[BaseModel]]: ...
+        file_name: str | None = None,
+        sub_dir: Path | str | None = None,
+        file_path: Path | str | None = None,
+    ) -> Callable[[type[BaseModel]], type[BaseModel]]: ...
 
     def register(
         self,
-        _cls: Optional[Type[BaseModel]] = None,
+        _cls: type[BaseModel] | None = None,
         /,
         *,
-        name: Optional[str] = None,
-        key: Optional[str] = None,
+        name: str | None = None,
+        key: str | None = None,
         skip_key_validation: bool = False,
-        file_name: Optional[str] = None,
-        sub_dir: Optional[Union[Path, str]] = None,
-        file_path: Optional[Union[Path, str]] = None,
+        file_name: str | None = None,
+        sub_dir: Path | str | None = None,
+        file_path: Path | str | None = None,
         # in_memory: bool = True,  # TODO: implement in_memory
-    ) -> Union[Type[BaseModel], Callable[[Type[BaseModel]], Type[BaseModel]]]:
-        def decorator(cls: Type[BaseModel]) -> Type[BaseModel]:
+    ) -> type[BaseModel] | Callable[[type[BaseModel]], type[BaseModel]]:
+        def decorator(cls: type[BaseModel]) -> type[BaseModel]:
             store = SyncStore(
                 self,
                 cls,

{syncwave-0.1.3 → syncwave-0.1.4}/src/syncwave/watcher.py

@@ -1,7 +1,9 @@
+from __future__ import annotations
+
 from pathlib import Path
 from threading import Lock, Timer
 from time import monotonic, sleep
-from typing import Callable
+from typing import Callable, Final
 
 from watchdog.events import (
     DirDeletedEvent,
@@ -18,7 +20,7 @@ Callback = Callable[[], None]
 
 
 class _Watcher:
-    TMP_FILE_PREFIX = ".tmp_"
+    TMP_FILE_PREFIX: Final[str] = ".tmp_"
 
     def __init__(self) -> None:
         self._lock = Lock()
@@ -96,8 +98,8 @@ class _Watcher:
 
 
 class _EventHandler(FileSystemEventHandler):
-    DEBOUNCE_WINDOW = 0.05
-    SELF_WRITE_WINDOW = 0.5
+    DEBOUNCE_WINDOW: Final[float] = 0.05
+    SELF_WRITE_WINDOW: Final[float] = 0.5
 
     def __init__(self, watcher: _Watcher) -> None:
         self._watcher = watcher
@@ -121,9 +123,7 @@ class _EventHandler(FileSystemEventHandler):
     def _is_self_write(self, file_path: FilePath) -> bool:
         # not protected by the lock because it's only called internally
         ts = self._self_writes_ts.get(file_path)
-        if ts is not None and monotonic() - ts < self.SELF_WRITE_WINDOW:
-            return True
-        return False
+        return ts is not None and monotonic() - ts < self.SELF_WRITE_WINDOW
 
     def dispatch(self, event: FileSystemEvent) -> None:
         if event.is_directory: