persidict 0.2.0__tar.gz → 0.2.2__tar.gz

{persidict-0.2.0 → persidict-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: persidict
-Version: 0.2.0
+Version: 0.2.2
 Summary: Simple persistent key-value store for Python. Values are stored as files on a disk or as S3 objects on AWS cloud.
 Home-page: https://github.com/vladlpavlov/persidict
 Author: Vlad (Volodymyr) Pavlov
@@ -143,7 +143,7 @@ that simultaneously work with the same instance of a dictionary.
 * Values must be pickleable Python objects.
 * Insertion order is not preserved.
 * You can not assign initial key-value pairs to a dictionary in its constructor.
-* Methods `quiet_delete()`, `mtimestamp()`, `get_subdict()` and `subdicts()` 
+* Methods `delete_if_exists()`, `mtimestamp()`, `get_subdict()` and `subdicts()` 
 are available
 
 ## Fine Tuning

{persidict-0.2.0 → persidict-0.2.2}/README.md

@@ -122,7 +122,7 @@ that simultaneously work with the same instance of a dictionary.
 * Values must be pickleable Python objects.
 * Insertion order is not preserved.
 * You can not assign initial key-value pairs to a dictionary in its constructor.
-* Methods `quiet_delete()`, `mtimestamp()`, `get_subdict()` and `subdicts()` 
+* Methods `delete_if_exists()`, `mtimestamp()`, `get_subdict()` and `subdicts()` 
 are available
 
 ## Fine Tuning

{persidict-0.2.0 → persidict-0.2.2}/persidict/__init__.py

@@ -17,6 +17,9 @@ S3_Dict (inherited from PersiDict): a dictionary that
 stores key-value pairs as S3 objects on AWS.
 A key is used to compose an objectname, while a value is stored
 as a pickle or a json S3 object.
+
+The package also offers a helper function get_safe_chars(),
+which returns a set of URL/filename-safe characters permitted in keys.
 """
 
 from .safe_str_tuple import SafeStrTuple, get_safe_chars

{persidict-0.2.0 → persidict-0.2.2}/persidict/persi_dict.py

@@ -6,10 +6,14 @@ Python's built-in Dict, with a few variations
 (e.g. insertion order is not preserved) and additional methods.
 
 PersiDict persistently stores key-value pairs.
+
 A key is a sequence of strings in a form of SafeStrTuple.
+Regular strings and their sequences can also be passed to PersiDict as keys,
+in this case they will be automatically converted to SafeStrTuple.
+
 A value can be any Python object.
 
-'Persstently' means that key-value pairs are saved in a durable storage,
+'Persistently' means that key-value pairs are saved in a durable storage,
 such as a local hard-drive or AWS S3 cloud, and can be retrieved
 even after the Python process that created the dictionary has terminated.
 """
@@ -22,11 +26,14 @@ from collections.abc import MutableMapping
 
 from .safe_str_tuple import SafeStrTuple
 
-PersiDictKey = Union[SafeStrTuple, str, Sequence[str]]
+PersiDictKey = Union[SafeStrTuple, Sequence[str], str]
 """ A value which can be used as a key for PersiDict. 
 
-PersiDictKey must be a string or a sequence of strings.
-The characters within strings must be to URL/filename-safe.
+PersiDict-s accept keys on a form of SafeStrTuple,
+or a string, or a sequence of strings.
+The characters within strings must be URL/filename-safe.
+If a string (or a sequence of strings) is passed to a PersiDict as a key,
+it will be automatically converted into SafeStrTuple.
 """
 
 class PersiDict(MutableMapping):
@@ -195,11 +202,12 @@ class PersiDict(MutableMapping):
             del self[k]
 
 
-    def quiet_delete(self, key:PersiDictKey):
+    def delete_if_exists(self, key:PersiDictKey) -> bool:
         """ Delete an item without raising an exception if it doesn't exist.
 
-        This method is absent in the original dict API, it is added here
-        to minimize network calls for (remote) persistent dictionaries.
+        Returns True if the item existed and was deleted, False otherwise.
+
+        This method is absent in the original dict API.
         """
 
         if self.immutable_items: # TODO: change to exceptions
@@ -207,21 +215,22 @@ class PersiDict(MutableMapping):
 
         key = SafeStrTuple(key)
 
-        try:
-            self.__delitem__(key)
-        except:
-            pass
+        if key in self:
+            del self[key]
+            return True
+        else:
+            return False
 
 
     def get_subdict(self, prefix_key:PersiDictKey) -> PersiDict:
-        """Get a subdictionary containing items with the same prefix_key.
+        """Get a sub-dictionary containing items with the same prefix_key.
 
         This method is absent in the original dict API.
         """
         raise NotImplementedError
 
     def subdicts(self) -> Dict[str, PersiDict]:
-        """Get a dictionary of subdictionaries.
+        """Get a dictionary of sub-dictionaries.
 
         This method is absent in the original dict API.
         """

{persidict-0.2.0 → persidict-0.2.2}/persidict.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: persidict
-Version: 0.2.0
+Version: 0.2.2
 Summary: Simple persistent key-value store for Python. Values are stored as files on a disk or as S3 objects on AWS cloud.
 Home-page: https://github.com/vladlpavlov/persidict
 Author: Vlad (Volodymyr) Pavlov
@@ -143,7 +143,7 @@ that simultaneously work with the same instance of a dictionary.
 * Values must be pickleable Python objects.
 * Insertion order is not preserved.
 * You can not assign initial key-value pairs to a dictionary in its constructor.
-* Methods `quiet_delete()`, `mtimestamp()`, `get_subdict()` and `subdicts()` 
+* Methods `delete_if_exists()`, `mtimestamp()`, `get_subdict()` and `subdicts()` 
 are available
 
 ## Fine Tuning

{persidict-0.2.0 → persidict-0.2.2}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as f:
 
 setuptools.setup(
     name="persidict"
-    ,version="0.2.0"
+    ,version="0.2.2"
     ,author="Vlad (Volodymyr) Pavlov"
     ,author_email="vlpavlov@ieee.org"
     ,description= "Simple persistent key-value store for Python. "