persidict 0.18.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
@@ -45,7 +46,7 @@ class FileDirDict(PersiDict):
     text files (either in jason format or as a plain text).
     """
 
-    base_dir:str
+    _base_dir:str
     file_type:str
 
     def __init__(self
@@ -56,7 +57,7 @@ class FileDirDict(PersiDict):
                  , base_class_for_values: Optional[type] = None):
         """A constructor defines location of the store and file format to use.
 
-        base_dir is a directory that will contain all the files in
+        _base_dir is a directory that will contain all the files in
         the FileDirDict. If the directory does not exist, it will be created.
 
         base_class_for_values constraints the type of values that can be
@@ -98,14 +99,15 @@ class FileDirDict(PersiDict):
                 os.mkdir(base_dir)
         assert os.path.isdir(base_dir)
 
-        self.base_dir_param = base_dir
-        self.base_dir = os.path.abspath(base_dir)
+        # self.base_dir_param = _base_dir
+        self._base_dir = os.path.abspath(base_dir)
+
 
     def __repr__(self):
         """Return repr(self)."""
 
         repr_str = super().__repr__()
-        repr_str = repr_str[:-1] + f", base_dir={self.base_dir}"
+        repr_str = repr_str[:-1] + f", _base_dir={self._base_dir}"
         repr_str += f", file_type={self.file_type}"
         repr_str += " )"
 
@@ -116,15 +118,22 @@ class FileDirDict(PersiDict):
         """Return configuration parameters of the dictionary."""
         params = super().get_params()
         additional_params = dict(
-            base_dir=self.base_dir_param
+            base_dir=self.base_dir
             , file_type=self.file_type)
         params.update(additional_params)
         return params
 
+
     @property
     def base_url(self) -> str:
         """Return dictionary's URL"""
-        return f"file://{self.base_dir}"
+        return f"file://{self._base_dir}"
+
+
+    @property
+    def base_dir(self) -> str:
+        """Return dictionary's base directory"""
+        return self._base_dir
 
 
     def __len__(self) -> int:
@@ -132,7 +141,7 @@ class FileDirDict(PersiDict):
 
         num_files = 0
         suffix = "." + self.file_type
-        for subdir_info in os.walk(self.base_dir):
+        for subdir_info in os.walk(self._base_dir):
             files = subdir_info[2]
             files = [f_name for f_name in files
                      if f_name.endswith(suffix)]
@@ -146,13 +155,13 @@ class FileDirDict(PersiDict):
         if self.immutable_items:
             raise KeyError("Can't clear a dict that contains immutable items")
 
-        for subdir_info in os.walk(self.base_dir, topdown=False):
+        for subdir_info in os.walk(self._base_dir, topdown=False):
             (subdir_name, _, files) = subdir_info
             suffix = "." + self.file_type
             for f in files:
                 if f.endswith(suffix):
                     os.remove(os.path.join(subdir_name, f))
-            if (subdir_name != self.base_dir) and (
+            if (subdir_name != self._base_dir) and (
                     len(os.listdir(subdir_name)) == 0 ):
                 os.rmdir(subdir_name)
 
@@ -163,7 +172,7 @@ class FileDirDict(PersiDict):
         """Convert a key into a filesystem path."""
 
         key = sign_safe_str_tuple(key, self.digest_len)
-        key = [self.base_dir] + list(key.strings)
+        key = [self._base_dir] + list(key.strings)
         dir_names = key[:-1] if is_file_path else key
 
         if create_subdirs:
@@ -290,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 "
@@ -319,7 +331,7 @@ class FileDirDict(PersiDict):
     def _generic_iter(self, iter_type: str):
         """Underlying implementation for .items()/.keys()/.values() iterators"""
         assert iter_type in {"keys", "values", "items"}
-        walk_results = os.walk(self.base_dir)
+        walk_results = os.walk(self._base_dir)
         ext_len = len(self.file_type) + 1
 
         def splitter(dir_path: str):
@@ -341,7 +353,7 @@ class FileDirDict(PersiDict):
                 for f in files:
                     if f.endswith(suffix):
                         prefix_key = os.path.relpath(
-                            dir_name, start=self.base_dir)
+                            dir_name, start=self._base_dir)
 
                         result_key = (*splitter(prefix_key), f[:-ext_len])
                         result_key = SafeStrTuple(result_key)

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
@@ -93,6 +94,7 @@ class PersiDict(MutableMapping, ParameterizableClass):
         self.immutable_items = bool(immutable_items)
         self.base_class_for_values = base_class_for_values
 
+
     def get_params(self):
         """Return a dictionary of parameters for the PersiDict object."""
         params =  dict(
@@ -102,6 +104,7 @@ class PersiDict(MutableMapping, ParameterizableClass):
         )
         return params
 
+
     @property
     @abstractmethod
     def base_url(self):
@@ -109,6 +112,13 @@ class PersiDict(MutableMapping, ParameterizableClass):
         raise NotImplementedError
 
 
+    @property
+    @abstractmethod
+    def base_dir(self):
+        """Return dictionary's base directory in the local filesystem"""
+        raise NotImplementedError
+
+
     def __repr__(self) -> str:
         """Return repr(self)"""
         repr_str = self.__class__.__name__ + "("
@@ -139,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")
@@ -192,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__"
@@ -33,7 +34,7 @@ class S3Dict(PersiDict):
     bucket_name: str
     root_prefix: str
     file_type: str
-    base_dir: str
+    _base_dir: str
 
     def __init__(self, bucket_name:str = "my_bucket"
                  , region:str = None
@@ -52,7 +53,7 @@ class S3Dict(PersiDict):
 
         root_prefix is a common S3 prefix for all objectnames in a dictionary.
 
-        base_dir is a local directory that will be used to store tmp files.
+        _base_dir is a local directory that will be used to store tmp files.
 
         base_class_for_values constraints the type of values that can be
         stored in the dictionary. If specified, it will be used to
@@ -99,7 +100,7 @@ class S3Dict(PersiDict):
         """Return repr(self)."""
 
         repr_str = super().__repr__()
-        repr_str = repr_str[:-1] + f", base_dir={self.local_cache.base_dir}"
+        repr_str = repr_str[:-1] + f", _base_dir={self.local_cache._base_dir}"
         repr_str += f", file_type={self.file_type}"
         repr_str += f", region={self.region}"
         repr_str += f", bucket_name={self.bucket_name}"
@@ -124,6 +125,11 @@ class S3Dict(PersiDict):
         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. """
@@ -174,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.18.0.dist-info → persidict-0.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: persidict
-Version: 0.18.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.18.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=b978200dd48fa77a7b15bc05327d5aa773cc09974e138a581da0a784d0448903,13906
-persidict/persi_dict.py,sha256=cea37db3dcd209e5a4ab382e668fad67ac97b56ef829e8466b60eccc8f771eb6,11431
-persidict/s3_dict.py,sha256=93d8a7945c565adf8aa513568a4dde3b06772e2366acbdfc3402c063aade17ef,11581
-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.18.0.dist-info/WHEEL,sha256=c133ef911c90b05f7e14d8679ba99146f9154fcd271b7398cf8f672283b94e05,79
-persidict-0.18.0.dist-info/METADATA,sha256=3567ed443b76bb83e481945ef1bfd6b20647db3f178d81022b6234d574242aa9,9096
-persidict-0.18.0.dist-info/RECORD,,