persidict 0.25.0__tar.gz → 0.26.0__tar.gz

{persidict-0.25.0 → persidict-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: persidict
-Version: 0.25.0
+Version: 0.26.0
 Summary: Simple persistent key-value store for Python. Values are stored as files on a disk or as S3 objects on AWS cloud.
 Keywords: persistence,dicts,distributed,parallel
 Author: Vlad (Volodymyr) Pavlov
@@ -161,8 +161,9 @@ that simultaneously work with the same instance of a dictionary.
 `oldest_keys()`, `newest_values()`, `oldest_values()`, 
 `get_params()`, `get_metaparams()`, and `get_default_metaparams()`,
 which are not available in native Python dicts.
-* You can use NO_CHANGE constant as a fake new value 
-to avoid actually setting/updating a value.
+* You can use KEEP_CURRENT constant as a fake new value 
+to avoid actually setting/updating a value. Or DELETE_CURRENT as 
+a fake new value to delete the previous value from a dictionary.
 
 ## Fine Tuning
 

{persidict-0.25.0 → persidict-0.26.0}/README.md

@@ -128,8 +128,9 @@ that simultaneously work with the same instance of a dictionary.
 `oldest_keys()`, `newest_values()`, `oldest_values()`, 
 `get_params()`, `get_metaparams()`, and `get_default_metaparams()`,
 which are not available in native Python dicts.
-* You can use NO_CHANGE constant as a fake new value 
-to avoid actually setting/updating a value.
+* You can use KEEP_CURRENT constant as a fake new value 
+to avoid actually setting/updating a value. Or DELETE_CURRENT as 
+a fake new value to delete the previous value from a dictionary.
 
 ## Fine Tuning
 

{persidict-0.25.0 → persidict-0.26.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "persidict"
-version = "0.25.0"
+version = "0.26.0"
 description = "Simple persistent key-value store for Python. Values are stored as files on a disk or as S3 objects on AWS cloud."
 readme = "README.md"
 requires-python = ">=3.10"

{persidict-0.25.0 → persidict-0.26.0}/src/persidict/__init__.py

@@ -27,4 +27,5 @@ from .safe_str_tuple import SafeStrTuple
 from .persi_dict import PersiDict
 from .file_dir_dict import FileDirDict
 from .s3_dict import S3Dict
-from .nochange_const import *
+from .jokers import Joker, KeepCurrentFlag, DeleteCurrentFlag
+from .jokers import KEEP_CURRENT, DELETE_CURRENT

{persidict-0.25.0 → persidict-0.26.0}/src/persidict/file_dir_dict.py

@@ -12,7 +12,6 @@ from __future__ import annotations
 import os
 import random
 import time
-from abc import abstractmethod
 from typing import Any, Optional
 
 import joblib
@@ -21,7 +20,7 @@ import jsonpickle.ext.numpy as jsonpickle_numpy
 import jsonpickle.ext.pandas as jsonpickle_pandas
 import parameterizable
 
-from .nochange_const import NO_CHANGE
+from .jokers import KEEP_CURRENT, DELETE_CURRENT, Joker
 from .safe_chars import replace_unsafe_chars
 from .safe_str_tuple import SafeStrTuple
 from .safe_str_tuple_signing import sign_safe_str_tuple, unsign_safe_str_tuple
@@ -317,7 +316,11 @@ class FileDirDict(PersiDict):
     def __setitem__(self, key:PersiDictKey, value:Any):
         """Set self[key] to value."""
 
-        if value is NO_CHANGE:
+        if value is KEEP_CURRENT:
+            return
+
+        if value is DELETE_CURRENT:
+            self.delete_if_exists(key)
             return
 
         if isinstance(value, PersiDict):

persidict-0.26.0/src/persidict/jokers.py

@@ -0,0 +1,51 @@
+"""A singleton constant to indicate no change in a value.
+
+When updating a value in a persistent dictionary,
+use KEEP_CURRENT as the new value to indicate that
+the existing value should remain unchanged.
+"""
+from typing import Any
+
+from parameterizable import (
+    ParameterizableClass
+    , register_parameterizable_class)
+
+
+class Joker(ParameterizableClass):
+    _instances = {}
+
+    def get_params(self) -> dict[str, Any]:
+        return {}
+
+    def __new__(cls):
+        if cls not in Joker._instances:
+            Joker._instances[cls] = super().__new__(cls)
+        return Joker._instances[cls]
+
+
+class KeepCurrentFlag(Joker):
+    """A singleton constant to indicate no change in a value.
+
+    When updating a value in a persistent dictionary,
+    use KeepCurrent as the new value to indicate that
+    the existing value (if any) should remain unchanged.
+    """
+    pass
+
+class DeleteCurrentFlag(Joker):
+    """A singleton constant to indicate that the current value should be deleted.
+
+    When updating a value in a persistent dictionary,
+    use DeleteCurrentFlag as the new value to indicate that
+    the existing value (if any) should be removed from the dictionary.
+    """
+    pass
+
+register_parameterizable_class(KeepCurrentFlag)
+register_parameterizable_class(DeleteCurrentFlag)
+
+KeepCurrent = KeepCurrentFlag()
+KEEP_CURRENT = KeepCurrentFlag()
+
+DeleteCurrent = DeleteCurrentFlag()
+DELETE_CURRENT = DeleteCurrentFlag()

{persidict-0.25.0 → persidict-0.26.0}/src/persidict/persi_dict.py

@@ -26,7 +26,7 @@ from parameterizable import ParameterizableClass
 from typing import Any, Sequence, Optional
 from collections.abc import MutableMapping
 
-from .nochange_const import NO_CHANGE
+from .jokers import KEEP_CURRENT, DELETE_CURRENT, Joker
 from .safe_str_tuple import SafeStrTuple
 
 PersiDictKey = SafeStrTuple | Sequence[str] | str
@@ -161,9 +161,11 @@ class PersiDict(MutableMapping, ParameterizableClass):
 
     def __setitem__(self, key:PersiDictKey, value:Any):
         """Set self[key] to value."""
-        if value is NO_CHANGE:
+        if value is KEEP_CURRENT:
             return
-        if self.immutable_items:
+        elif value is DELETE_CURRENT:
+            self.delete_if_exists(key)
+        elif self.immutable_items:
             if key in self:
                 raise KeyError("Can't modify an immutable key-value pair")
         raise NotImplementedError
@@ -216,7 +218,7 @@ class PersiDict(MutableMapping, ParameterizableClass):
         """
         # TODO: check edge cases to ensure the same semantics as standard dicts
         key = SafeStrTuple(key)
-        assert not default is NO_CHANGE
+        assert not isinstance(default, Joker)
         if key in self:
             return self[key]
         else:

{persidict-0.25.0 → persidict-0.26.0}/src/persidict/s3_dict.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import os
-from abc import abstractmethod
 from typing import Any, Optional
 
 import boto3
@@ -10,7 +9,7 @@ import parameterizable
 from .safe_str_tuple import SafeStrTuple
 from .safe_str_tuple_signing import sign_safe_str_tuple, unsign_safe_str_tuple
 from .persi_dict import PersiDict
-from .nochange_const import NO_CHANGE
+from .jokers import KEEP_CURRENT, DELETE_CURRENT
 from .file_dir_dict import FileDirDict, PersiDictKey
 
 S3DICT_DEFAULT_BASE_DIR = "__s3_dict__"
@@ -191,7 +190,11 @@ class S3Dict(PersiDict):
     def __setitem__(self, key:PersiDictKey, value:Any):
         """Set self[key] to value. """
 
-        if value is NO_CHANGE:
+        if value is KEEP_CURRENT:
+            return
+
+        if value is DELETE_CURRENT:
+            self.delete_if_exists(key)
             return
 
         if isinstance(value, PersiDict):

persidict-0.25.0/src/persidict/nochange_const.py

@@ -1,28 +0,0 @@
-"""A singleton constant to indicate no change in a value.
-
-When updating a value in a persistent dictionary,
-use NO_CHANGE as the new value to indicate that
-the existing value should remain unchanged.
-"""
-from typing import Any
-
-from parameterizable import (
-    ParameterizableClass
-    , register_parameterizable_class)
-
-
-class NoChangeFlag(ParameterizableClass):
-    _instance = None
-
-    def __new__(cls):
-        if cls._instance is None:
-            cls._instance = super().__new__(cls)
-        return cls._instance
-
-    def get_params(self) -> dict[str, Any]:
-        return {}
-
-register_parameterizable_class(NoChangeFlag)
-
-NoChange = NoChangeFlag()
-NO_CHANGE = NoChangeFlag()