persidict 0.21.1__tar.gz → 0.23.1__tar.gz

{persidict-0.21.1 → persidict-0.23.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: persidict
-Version: 0.21.1
+Version: 0.23.1
 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

{persidict-0.21.1 → persidict-0.23.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "persidict"
-version = "0.21.1"
+version = "0.23.1"
 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.21.1 → persidict-0.23.1}/src/persidict/file_dir_dict.py

@@ -115,24 +115,35 @@ 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)
         params.update(additional_params)
-        return params
+        sorted_params = dict(sorted(params.items()))
+        return sorted_params
 
 
     @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 +223,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 +238,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 +257,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 +271,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 +291,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 +313,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 +337,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 +347,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-0.21.1 → persidict-0.23.1}/src/persidict/persi_dict.py

@@ -93,29 +93,41 @@ 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
             , base_class_for_values=self.base_class_for_values
         )
-        return params
+        sorted_params = dict(sorted(params.items()))
+        return sorted_params
 
 
     @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 +236,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 +289,7 @@ class PersiDict(MutableMapping, ParameterizableClass):
         """
         raise NotImplementedError
 
+
     def subdicts(self) -> dict[str, PersiDict]:
         """Get a dictionary of sub-dictionaries.
 
@@ -337,6 +352,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 +362,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-0.21.1 → persidict-0.23.1}/src/persidict/s3_dict.py

@@ -111,23 +111,34 @@ 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
         params["root_prefix"] = self.root_prefix
-        return params
+        sorted_params = dict(sorted(params.items()))
+        return sorted_params
 
 
     @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