persidict 0.19.0__py3-none-any.whl → 0.20.0__py3-none-any.whl

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/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/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 NoChange_Class:
+    _instance = None
+
+    def __new__(cls):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+        return cls._instance
+
+NoChange = NoChange_Class()
+NO_CHANGE = NoChange_Class()

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/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 "

{persidict-0.19.0.dist-info → persidict-0.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: persidict
-Version: 0.19.0
+Version: 0.20.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.20.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+persidict/.DS_Store,sha256=d65165279105ca6773180500688df4bdc69a2c7b771752f0a46ef120b7fd8ec3,6148
+persidict/__init__.py,sha256=34e758e6e566fc18225214b430cf492938d6f3d48b36e678ab947f15c780a699,1185
+persidict/file_dir_dict.py,sha256=438558ea1f06a8e280609a4aaa94a6fea05d82ce2ef79bd401af94b014da82a6,14132
+persidict/nochange_const.py,sha256=d569d9283a684150e380b08ebdeb232783dd0e51938bfbbadf27327952027f3e,443
+persidict/persi_dict.py,sha256=7301a8a6a41bb4c2fbd29d31e0421287d53f6a88c66e9324656db1043e5e2b55,11728
+persidict/s3_dict.py,sha256=acc676f92ae993364f1fa70d74e95c182b2f263f29eae99f3b554f45aededfe5,11834
+persidict/safe_chars.py,sha256=59a20e96205d2e5675d827a911ad42ddbd553f1bd7e2cda1be765a9c2c4ce814,565
+persidict/safe_str_tuple.py,sha256=71393904bdebfb213ad8429fed59e04da52964076c01324f2238821aa4339325,3717
+persidict/safe_str_tuple_signing.py,sha256=e6e0a3015651a8ea2ef8aa43670f84c5ba1cdfedefb9ac8932aaebb7c699d1c9,3742
+persidict-0.20.0.dist-info/WHEEL,sha256=c133ef911c90b05f7e14d8679ba99146f9154fcd271b7398cf8f672283b94e05,79
+persidict-0.20.0.dist-info/METADATA,sha256=f8d494dd74e77144e57c8db653c0b7da471c3d71e313804caee9ad6ae78f3855,9172
+persidict-0.20.0.dist-info/RECORD,,

persidict-0.19.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-persidict/.DS_Store,sha256=d65165279105ca6773180500688df4bdc69a2c7b771752f0a46ef120b7fd8ec3,6148
-persidict/__init__.py,sha256=f589b6292bef0ee7c6f6ef087dacbecc5943a64deed8839b02f8342db3032b25,1155
-persidict/file_dir_dict.py,sha256=441c311572b61be643f6536dfd0c157c03faebe4a01c26fa22d77386cbdd5a5d,14043
-persidict/persi_dict.py,sha256=040fb1ed1358fa36a4d445d9fd3b899087a1030c7e76fb39da7e15c766aec41a,11600
-persidict/s3_dict.py,sha256=fb84d32ff0aa0d873d7d0742a374fab12d9aae272dbcde82ddee7f7af7487eba,11745
-persidict/safe_chars.py,sha256=59a20e96205d2e5675d827a911ad42ddbd553f1bd7e2cda1be765a9c2c4ce814,565
-persidict/safe_str_tuple.py,sha256=71393904bdebfb213ad8429fed59e04da52964076c01324f2238821aa4339325,3717
-persidict/safe_str_tuple_signing.py,sha256=e6e0a3015651a8ea2ef8aa43670f84c5ba1cdfedefb9ac8932aaebb7c699d1c9,3742
-persidict-0.19.0.dist-info/WHEEL,sha256=c133ef911c90b05f7e14d8679ba99146f9154fcd271b7398cf8f672283b94e05,79
-persidict-0.19.0.dist-info/METADATA,sha256=f28075650e95b00558605e23225933e6e1a4fb0ba8e2fb5705c4acc86373edab,9096
-persidict-0.19.0.dist-info/RECORD,,