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

persidict/file_dir_dict.py

@@ -12,6 +12,7 @@ from __future__ import annotations
 import os
 import random
 import time
+from abc import abstractmethod
 from typing import Any, Optional
 
 import joblib
@@ -44,7 +45,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
@@ -55,7 +56,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
@@ -97,35 +98,49 @@ 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 += " )"
 
         return repr_str
 
+
     def get_params(self):
         """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}"
+
+
+    @property
+    def base_dir(self) -> str:
+        """Return dictionary's base directory"""
+        return self._base_dir
+
+
     def __len__(self) -> int:
-        """ Get number of key-value pairs in the dictionary."""
+        """ Get the number of key-value pairs in the dictionary."""
 
         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)]
@@ -139,13 +154,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)
 
@@ -156,7 +171,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:
@@ -312,7 +327,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):
@@ -334,7 +349,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/persi_dict.py

@@ -93,6 +93,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(
@@ -103,6 +104,20 @@ class PersiDict(MutableMapping, ParameterizableClass):
         return params
 
 
+    @property
+    @abstractmethod
+    def base_url(self):
+        """Return dictionary's URL"""
+        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__ + "("

persidict/s3_dict.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import os
+from abc import abstractmethod
 from typing import Any, Optional
 
 import boto3
@@ -32,7 +33,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
@@ -51,7 +52,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
@@ -98,7 +99,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}"
@@ -107,6 +108,7 @@ class S3Dict(PersiDict):
 
         return repr_str
 
+
     def get_params(self):
         """Return configuration parameters of the object as a dictionary."""
         params = self.local_cache.get_params()
@@ -116,6 +118,18 @@ class S3Dict(PersiDict):
         return params
 
 
+    @property
+    def base_url(self):
+        """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)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: persidict
-Version: 0.17.4
+Version: 0.19.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

persidict-0.19.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+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,,

{persidict-0.17.4.dist-info → persidict-0.19.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.7.12
+Generator: uv 0.7.13
 Root-Is-Purelib: true
 Tag: py3-none-any

persidict-0.17.4.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=d1f85ace6909dddd95ac90cd8c8113e27e0faec53c70d51906510a8a14f67fd6,13745
-persidict/persi_dict.py,sha256=5d1b3a0426b066e917c5032ae56c22b54063739c0b2da56635fb05b662644b6d,11300
-persidict/s3_dict.py,sha256=223b465f18b0f08c87490eff698570c781590ff16a7fde525658ba1eb0744379,11409
-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.17.4.dist-info/WHEEL,sha256=b43a490154aa5cdf2e66332f4b8e5b7f1bd1f11398f8ae4d8c5943554e998b5a,79
-persidict-0.17.4.dist-info/METADATA,sha256=7cb92ac2a36a71f073934bac6c467b4139d84f973605c5f03a5fa96aece91051,9096
-persidict-0.17.4.dist-info/RECORD,,