persidict 0.21.0__py3-none-any.whl → 0.23.0__py3-none-any.whl

persidict/file_dir_dict.py

@@ -115,8 +115,12 @@ class FileDirDict(PersiDict):
 
 
     def get_params(self):
-        """Return configuration parameters of the dictionary."""
-        params = super().get_params()
+        """Return configuration parameters of the dictionary.
+
+        This method is needed to support Parameterizable API.
+        The method is absent in the original dict API.
+        """
+        params = PersiDict.get_params(self)
         additional_params = dict(
             base_dir=self.base_dir
             , file_type=self.file_type)
@@ -126,13 +130,19 @@ class FileDirDict(PersiDict):
 
     @property
     def base_url(self) -> str:
-        """Return dictionary's URL"""
+        """Return dictionary's URL.
+
+        This property is absent in the original dict API.
+        """
         return f"file://{self._base_dir}"
 
 
     @property
     def base_dir(self) -> str:
-        """Return dictionary's base directory"""
+        """Return dictionary's base directory.
+
+        This property is absent in the original dict API.
+        """
         return self._base_dir
 
 
@@ -212,6 +222,7 @@ class FileDirDict(PersiDict):
             , digest_len=self.digest_len
             , base_class_for_values=self.base_class_for_values)
 
+
     def _read_from_file_impl(self, file_name:str) -> Any:
         """Read a value from a file. """
 
@@ -226,6 +237,7 @@ class FileDirDict(PersiDict):
                 result = f.read()
         return result
 
+
     def _read_from_file(self,file_name:str) -> Any:
         """Read a value from a file. """
 
@@ -244,6 +256,7 @@ class FileDirDict(PersiDict):
 
         return self._read_from_file_impl(file_name)
 
+
     def _save_to_file_impl(self, file_name:str, value:Any) -> None:
         """Save a value to a file. """
 
@@ -257,6 +270,7 @@ class FileDirDict(PersiDict):
             with open(file_name, 'w') as f:
                 f.write(value)
 
+
     def _save_to_file(self, file_name:str, value:Any) -> None:
         """Save a value to a file. """
 
@@ -276,12 +290,14 @@ class FileDirDict(PersiDict):
 
         self._save_to_file_impl(file_name, value)
 
+
     def __contains__(self, key:PersiDictKey) -> bool:
         """True if the dictionary has the specified key, else False. """
         key = SafeStrTuple(key)
         filename = self._build_full_path(key)
         return os.path.isfile(filename)
 
+
     def __getitem__(self, key:PersiDictKey) -> Any:
         """ Implementation for x[y] syntax. """
         key = SafeStrTuple(key)
@@ -296,6 +312,7 @@ class FileDirDict(PersiDict):
                     + f" but it is {type(result)} instead.")
         return result
 
+
     def __setitem__(self, key:PersiDictKey, value:Any):
         """Set self[key] to value."""
 
@@ -319,6 +336,7 @@ class FileDirDict(PersiDict):
             raise KeyError("Can't modify an immutable item")
         self._save_to_file(filename, value)
 
+
     def __delitem__(self, key:PersiDictKey) -> None:
         """Delete self[key]."""
         key = SafeStrTuple(key)
@@ -328,6 +346,7 @@ class FileDirDict(PersiDict):
             raise KeyError(f"File {filename} does not exist")
         os.remove(filename)
 
+
     def _generic_iter(self, iter_type: str):
         """Underlying implementation for .items()/.keys()/.values() iterators"""
         assert iter_type in {"keys", "values", "items"}

persidict/nochange_const.py

@@ -1,6 +1,6 @@
 """A singleton constant to indicate no change in a value.
 
-When updating a val ue in a persistent dictionary,
+When updating a value in a persistent dictionary,
 use NO_CHANGE as the new value to indicate that
 the existing value should remain unchanged.
 """

persidict/persi_dict.py

@@ -93,10 +93,15 @@ class PersiDict(MutableMapping, ParameterizableClass):
             raise ValueError("digest_len must be non-negative")
         self.immutable_items = bool(immutable_items)
         self.base_class_for_values = base_class_for_values
+        ParameterizableClass.__init__(self)
 
 
     def get_params(self):
-        """Return a dictionary of parameters for the PersiDict object."""
+        """Return a dictionary of parameters for the PersiDict object.
+
+        This method is needed to support Parameterizable API.
+        The method is absent in the original dict API.
+        """
         params =  dict(
             immutable_items=self.immutable_items
             , digest_len=self.digest_len
@@ -108,14 +113,20 @@ class PersiDict(MutableMapping, ParameterizableClass):
     @property
     @abstractmethod
     def base_url(self):
-        """Return dictionary's URL"""
+        """Return dictionary's URL
+
+        This property is absent in the original dict API.
+        """
         raise NotImplementedError
 
 
     @property
     @abstractmethod
     def base_dir(self):
-        """Return dictionary's base directory in the local filesystem"""
+        """Return dictionary's base directory in the local filesystem.
+
+        This property is absent in the original dict API.
+        """
         raise NotImplementedError
 
 
@@ -224,9 +235,11 @@ class PersiDict(MutableMapping, ParameterizableClass):
         except:
             return False
 
+
     def __getstate__(self):
         raise TypeError("PersiDict is not picklable.")
 
+
     def __setstate__(self, state):
         raise TypeError("PersiDict is not picklable.")
 
@@ -275,6 +288,7 @@ class PersiDict(MutableMapping, ParameterizableClass):
         """
         raise NotImplementedError
 
+
     def subdicts(self) -> dict[str, PersiDict]:
         """Get a dictionary of sub-dictionaries.
 
@@ -337,6 +351,7 @@ class PersiDict(MutableMapping, ParameterizableClass):
         result = all_keys[:max_n]
         return result
 
+
     def oldest_values(self, max_n=None):
         """Return max_n the oldest values in the dictionary.
 
@@ -346,6 +361,7 @@ class PersiDict(MutableMapping, ParameterizableClass):
         """
         return [self[k] for k in self.oldest_keys(max_n)]
 
+
     def newest_values(self, max_n=None):
         """Return max_n the newest values in the dictionary.
 

persidict/s3_dict.py

@@ -111,7 +111,11 @@ class S3Dict(PersiDict):
 
 
     def get_params(self):
-        """Return configuration parameters of the object as a dictionary."""
+        """Return configuration parameters of the object as a dictionary.
+
+        This method is needed to support Parameterizable API.
+        The method is absent in the original dict API.
+        """
         params = self.local_cache.get_params()
         params["region"] = self.region
         params["bucket_name"] = self.bucket_name
@@ -121,13 +125,19 @@ class S3Dict(PersiDict):
 
     @property
     def base_url(self):
-        """Return dictionary's URl"""
+        """Return dictionary's URl.
+
+        This property is absent in the original dict API.
+        """
         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 dictionary's base directory in the local filesystem.
+
+        This property is absent in the original dict API.
+        """
         return self.local_cache.base_dir
 
 

{persidict-0.21.0.dist-info → persidict-0.23.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: persidict
-Version: 0.21.0
+Version: 0.23.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,7 +161,8 @@ 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 to avoid actually setting/updating a value.
+* You can use NO_CHANGE constant as a fake new value 
+to avoid actually setting/updating a value.
 
 ## Fine Tuning
 

persidict-0.23.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=8b722dbd30b179b26cd5cddd567487648e24db33949aa9785800e9861be1ccde,14412
+persidict/nochange_const.py,sha256=a449c356b44a145b8118bdd846d3e517f9211887b39688e7918ddb214e856f25,436
+persidict/persi_dict.py,sha256=5bc315b09e422b37b4de439e581b28e4a5ed1cd5bc3346cf3a33662314a8afa2,12041
+persidict/s3_dict.py,sha256=f757a5a1fa6c0865fcd9468eb248dab3d2e8aacdcfd108dbfb137a3a1522b161,12099
+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.23.0.dist-info/WHEEL,sha256=c133ef911c90b05f7e14d8679ba99146f9154fcd271b7398cf8f672283b94e05,79
+persidict-0.23.0.dist-info/METADATA,sha256=a48859d85a3e0d532c80ba35b15e92e76424a3f057266a68a8f0470d44d38a68,9193
+persidict-0.23.0.dist-info/RECORD,,

persidict-0.21.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-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=679081a68766dfe3da694bca73500fc971cc7418074bfe168ae8b13609c73d80,437
-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.21.0.dist-info/WHEEL,sha256=c133ef911c90b05f7e14d8679ba99146f9154fcd271b7398cf8f672283b94e05,79
-persidict-0.21.0.dist-info/METADATA,sha256=7e184bbdf462da4cb66a3abb276975d28d30bf1076ea5a9ed706c5e78e6595bf,9172
-persidict-0.21.0.dist-info/RECORD,,