persidict 0.19.0__tar.gz → 0.21.0__tar.gz

{persidict-0.19.0 → persidict-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: persidict
-Version: 0.19.0
+Version: 0.21.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
@@ -155,12 +155,13 @@ that simultaneously work with the same instance of a dictionary.
 * Values must be pickleable Python objects.
 * You can constrain values to be an instance of a specific class.
 * Insertion order is not preserved.
-* You can not assign initial key-value pairs to a dictionary in its constructor.
+* You cannot assign initial key-value pairs to a dictionary in its constructor.
 * `PersiDict` API has additional methods `delete_if_exists()`, `timestamp()`,
 `get_subdict()`, `subdicts()`, `random_keys()`, `newest_keys()`, 
 `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 to avoid actually setting/updating a value.
 
 ## Fine Tuning
 

{persidict-0.19.0 → persidict-0.21.0}/README.md

@@ -122,12 +122,13 @@ that simultaneously work with the same instance of a dictionary.
 * Values must be pickleable Python objects.
 * You can constrain values to be an instance of a specific class.
 * Insertion order is not preserved.
-* You can not assign initial key-value pairs to a dictionary in its constructor.
+* You cannot assign initial key-value pairs to a dictionary in its constructor.
 * `PersiDict` API has additional methods `delete_if_exists()`, `timestamp()`,
 `get_subdict()`, `subdicts()`, `random_keys()`, `newest_keys()`, 
 `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 to avoid actually setting/updating a value.
 
 ## Fine Tuning
 

{persidict-0.19.0 → persidict-0.21.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "persidict"
-version = "0.19.0"
+version = "0.21.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.19.0 → persidict-0.21.0}/src/persidict/__init__.py

@@ -26,4 +26,5 @@ from .safe_chars import get_safe_chars, replace_unsafe_chars
 from .safe_str_tuple import SafeStrTuple
 from .persi_dict import PersiDict
 from .file_dir_dict import FileDirDict
-from .s3_dict import S3Dict
+from .s3_dict import S3Dict
+from .nochange_const import *

{persidict-0.19.0 → persidict-0.21.0}/src/persidict/file_dir_dict.py

@@ -21,6 +21,7 @@ import jsonpickle.ext.numpy as jsonpickle_numpy
 import jsonpickle.ext.pandas as jsonpickle_pandas
 import parameterizable
 
+from .nochange_const import NO_CHANGE
 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
@@ -298,6 +299,9 @@ class FileDirDict(PersiDict):
     def __setitem__(self, key:PersiDictKey, value:Any):
         """Set self[key] to value."""
 
+        if value is NO_CHANGE:
+            return
+
         if isinstance(value, PersiDict):
             raise TypeError(
                 f"You are not allowed to store a PersiDict "

persidict-0.21.0/src/persidict/nochange_const.py

@@ -0,0 +1,17 @@
+"""A singleton constant to indicate no change in a value.
+
+When updating a val ue in a persistent dictionary,
+use NO_CHANGE as the new value to indicate that
+the existing value should remain unchanged.
+"""
+
+class NoChangeFlag:
+    _instance = None
+
+    def __new__(cls):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+        return cls._instance
+
+NoChange = NoChangeFlag()
+NO_CHANGE = NoChangeFlag()

{persidict-0.19.0 → persidict-0.21.0}/src/persidict/persi_dict.py

@@ -26,6 +26,7 @@ from parameterizable import ParameterizableClass
 from typing import Any, Sequence, Optional
 from collections.abc import MutableMapping
 
+from .nochange_const import NO_CHANGE
 from .safe_str_tuple import SafeStrTuple
 
 PersiDictKey = SafeStrTuple | Sequence[str] | str
@@ -148,6 +149,8 @@ class PersiDict(MutableMapping, ParameterizableClass):
 
     def __setitem__(self, key:PersiDictKey, value:Any):
         """Set self[key] to value."""
+        if value is NO_CHANGE:
+            return
         if self.immutable_items:
             if key in self:
                 raise KeyError("Can't modify an immutable key-value pair")
@@ -201,6 +204,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
         if key in self:
             return self[key]
         else:

{persidict-0.19.0 → persidict-0.21.0}/src/persidict/s3_dict.py

@@ -10,6 +10,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 .file_dir_dict import FileDirDict, PersiDictKey
 
 S3DICT_DEFAULT_BASE_DIR = "__s3_dict__"
@@ -123,13 +124,13 @@ class S3Dict(PersiDict):
         """Return dictionary's URl"""
         return f"s3://{self.bucket_name}/{self.root_prefix}"
 
+
     @property
     def base_dir(self) -> str:
         """Return dictionary's base directory in the local filesystem"""
         return self.local_cache.base_dir
 
 
-
     def _build_full_objectname(self, key:PersiDictKey) -> str:
         """ Convert PersiDictKey into an S3 objectname. """
         key = SafeStrTuple(key)
@@ -179,6 +180,9 @@ class S3Dict(PersiDict):
     def __setitem__(self, key:PersiDictKey, value:Any):
         """Set self[key] to value. """
 
+        if value is NO_CHANGE:
+            return
+
         if isinstance(value, PersiDict):
             raise TypeError(
                 f"You are not allowed to store a PersiDict "