scruby 0.10.2__py3-none-any.whl → 0.10.4__py3-none-any.whl

scruby/constants.py

@@ -3,7 +3,7 @@
 The module contains the following variables:
 
 - `DB_ROOT` - Path to root directory of database. `By default = "ScrubyDB"` (*in root of project*).
-- `LENGTH_REDUCTION_HASH` - The length of the hash reduction on the left side.
+- `HASH_REDUCE_LEFT` - The length of the hash reduction on the left side.
     - `0` - 4294967296 branches in collection (by default).
     - `2` - 16777216 branches in collectionю
     - `4` - 65536 branches in collectionю
@@ -14,7 +14,7 @@ from __future__ import annotations
 
 __all__ = (
     "DB_ROOT",
-    "LENGTH_REDUCTION_HASH",
+    "HASH_REDUCE_LEFT",
 )
 
 from typing import Literal
@@ -28,4 +28,4 @@ DB_ROOT: str = "ScrubyDB"
 # 2 = 16777216 branches in collectionю
 # 4 = 65536 branches in collectionю
 # 6 = 256 branches in collection (main purpose is tests).
-LENGTH_REDUCTION_HASH: Literal[0, 2, 4, 6] = 0
+HASH_REDUCE_LEFT: Literal[0, 2, 4, 6] = 0

scruby/db.py

@@ -44,9 +44,9 @@ class Scruby[T]:
         self.__meta = _Meta
         self.__class_model = class_model
         self.__db_root = constants.DB_ROOT
-        self.__length_reduction_hash = constants.LENGTH_REDUCTION_HASH
+        self.__hash_reduce_left = constants.HASH_REDUCE_LEFT
         # The maximum number of keys.
-        match self.__length_reduction_hash:
+        match self.__hash_reduce_left:
             case 0:
                 self.__max_num_keys = 4294967296
             case 2:
@@ -56,10 +56,11 @@ class Scruby[T]:
             case 6:
                 self.__max_num_keys = 256
             case _ as unreachable:
-                msg: str = f"{unreachable} - Unacceptable value for LENGTH_REDUCTION_HASH."
+                msg: str = f"{unreachable} - Unacceptable value for HASH_REDUCE_LEFT."
                 logger.critical(msg)
                 assert_never(Never(unreachable))
-        # Create metadata if absent.
+        # 1.Create metadata if absent.
+        # 2.Check metadata.
         self._create_metadata()
 
     def _create_metadata(self) -> None:
@@ -68,7 +69,7 @@ class Scruby[T]:
         This method is for internal use.
         """
         key: int = 0
-        key_as_hash: str = f"{key:08x}"[self.__length_reduction_hash :]
+        key_as_hash: str = f"{key:08x}"[self.__hash_reduce_left :]
         separated_hash: str = "/".join(list(key_as_hash))
         branch_path = SyncPath(
             *(
@@ -92,7 +93,7 @@ class Scruby[T]:
         This method is for internal use.
         """
         key: int = 0
-        key_as_hash: str = f"{key:08x}"[self.__length_reduction_hash :]
+        key_as_hash: str = f"{key:08x}"[self.__hash_reduce_left :]
         separated_hash: str = "/".join(list(key_as_hash))
         return Path(
             *(
@@ -148,7 +149,7 @@ class Scruby[T]:
             logger.error("The key should not be empty.")
             raise KeyError("The key should not be empty.")
         # Key to crc32 sum.
-        key_as_hash: str = f"{zlib.crc32(key.encode('utf-8')):08x}"[self.__length_reduction_hash :]
+        key_as_hash: str = f"{zlib.crc32(key.encode('utf-8')):08x}"[self.__hash_reduce_left :]
         # Convert crc32 sum in the segment of path.
         separated_hash: str = "/".join(list(key_as_hash))
         # The path of the branch to the database.
@@ -265,10 +266,10 @@ class Scruby[T]:
         return
 
     @staticmethod
-    def _search_task(
+    def _task_find(
         key: int,
         filter_fn: Callable,
-        length_reduction_hash: str,
+        HASH_REDUCE_LEFT: str,
         db_root: str,
         class_model: T,
     ) -> dict[str, Any] | None:
@@ -276,7 +277,7 @@ class Scruby[T]:
 
         This method is for internal use.
         """
-        key_as_hash: str = f"{key:08x}"[length_reduction_hash:]
+        key_as_hash: str = f"{key:08x}"[HASH_REDUCE_LEFT:]
         separated_hash: str = "/".join(list(key_as_hash))
         leaf_path: SyncPath = SyncPath(
             *(
@@ -316,8 +317,8 @@ class Scruby[T]:
                      If None, then there is no limit on the wait time.
         """
         keys: range = range(1, self.__max_num_keys)
-        search_task_fn: Callable = self._search_task
-        length_reduction_hash: int = self.__length_reduction_hash
+        search_task_fn: Callable = self._task_find
+        HASH_REDUCE_LEFT: int = self.__hash_reduce_left
         db_root: str = self.__db_root
         class_model: T = self.__class_model
         with concurrent.futures.ThreadPoolExecutor(max_workers) as executor:
@@ -326,7 +327,7 @@ class Scruby[T]:
                     search_task_fn,
                     key,
                     filter_fn,
-                    length_reduction_hash,
+                    HASH_REDUCE_LEFT,
                     db_root,
                     class_model,
                 )
@@ -358,8 +359,8 @@ class Scruby[T]:
                      If None, then there is no limit on the wait time.
         """
         keys: range = range(1, self.__max_num_keys)
-        search_task_fn: Callable = self._search_task
-        length_reduction_hash: int = self.__length_reduction_hash
+        search_task_fn: Callable = self._task_find
+        HASH_REDUCE_LEFT: int = self.__hash_reduce_left
         db_root: str = self.__db_root
         class_model: T = self.__class_model
         counter: int = 0
@@ -372,7 +373,7 @@ class Scruby[T]:
                     search_task_fn,
                     key,
                     filter_fn,
-                    length_reduction_hash,
+                    HASH_REDUCE_LEFT,
                     db_root,
                     class_model,
                 )
@@ -401,10 +402,23 @@ class Scruby[T]:
         max_workers: int | None = None,
         timeout: float | None = None,
     ) -> int:
-        """Count the number of documents a matching the filter in this collection."""
+        """Count the number of documents a matching the filter in this collection.
+
+        The search is based on the effect of a quantum loop.
+        The search effectiveness depends on the number of processor threads.
+        Ideally, hundreds and even thousands of threads are required.
+
+        Args:
+            filter_fn: A function that execute the conditions of filtering.
+            max_workers: The maximum number of processes that can be used to
+                         execute the given calls. If None or not given then as many
+                         worker processes will be created as the machine has processors.
+            timeout: The number of seconds to wait for the result if the future isn't done.
+                     If None, then there is no limit on the wait time.
+        """
         keys: range = range(1, self.__max_num_keys)
-        search_task_fn: Callable = self._search_task
-        length_reduction_hash: int = self.__length_reduction_hash
+        search_task_fn: Callable = self._task_find
+        HASH_REDUCE_LEFT: int = self.__hash_reduce_left
         db_root: str = self.__db_root
         class_model: T = self.__class_model
         counter: int = 0
@@ -414,10 +428,10 @@ class Scruby[T]:
                     search_task_fn,
                     key,
                     filter_fn,
-                    length_reduction_hash,
+                    HASH_REDUCE_LEFT,
                     db_root,
                     class_model,
                 )
                 if future.result(timeout) is not None:
                     counter += 1
-            return counter
+        return counter

scruby/errors.py

@@ -0,0 +1,23 @@
+"""Scruby Exceptions."""
+
+from __future__ import annotations
+
+__all__ = (
+    "ScrubyException",
+    "MetadataValueError",
+)
+
+
+class ScrubyException(Exception):
+    """Root Custom Exception."""
+
+    def __init__(self, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]  # noqa: D107
+        super().__init__(*args, **kwargs)
+
+
+class MetadataValueError(ScrubyException):
+    """Exception is raised if value of variable in metadata does not matching expected."""
+
+    def __init__(self, message: str) -> None:  # noqa: D107
+        self.message = message
+        super().__init__(self.message)

{scruby-0.10.2.dist-info → scruby-0.10.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.10.2
+Version: 0.10.4
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -175,7 +175,7 @@ from scruby import Scruby, constants
 from pprint import pprint as pp
 
 constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
-constants.LENGTH_REDUCTION_HASH = 6  # 256 branches in collection
+constants.HASH_REDUCE_LEFT = 6  # 256 branches in collection
                                      # (main purpose is tests).
 
 class User(BaseModel):
@@ -246,7 +246,7 @@ from scruby import Scruby, constants
 from pprint import pprint as pp
 
 constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
-constants.LENGTH_REDUCTION_HASH = 6  # 256 branches in collection
+constants.HASH_REDUCE_LEFT = 6  # 256 branches in collection
                                      # (main purpose is tests).
 
 class User(BaseModel):

scruby-0.10.4.dist-info/RECORD

@@ -0,0 +1,9 @@
+scruby/__init__.py,sha256=wFwUS1KcLxfIopXOVS8gPue9fNzIIU2cVj_RgK5drz4,849
+scruby/constants.py,sha256=3LZfcxcuRqwzoB0-iogLMjKBZRdxfWJmTbyPwVRhQgY,1007
+scruby/db.py,sha256=k_I2rphHG7Y5vq8oGDoimlKEwPEwmYzkqn7_DO0M6ic,15853
+scruby/errors.py,sha256=aHQri4LNcFVQrSHwjyzb1fL8O49SwjYEU4QgMOo4uyA,622
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.10.4.dist-info/METADATA,sha256=oJLzRBPPatu6dsq7EQyxf-UHQn4uJ1kF3C7Q-heqVNw,10819
+scruby-0.10.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.10.4.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.10.4.dist-info/RECORD,,

scruby-0.10.2.dist-info/RECORD

@@ -1,8 +0,0 @@
-scruby/__init__.py,sha256=wFwUS1KcLxfIopXOVS8gPue9fNzIIU2cVj_RgK5drz4,849
-scruby/constants.py,sha256=GbB-O0qaVdi5EHUp-zRAppFXLR-oHxpXUFVAOCpS0C8,1022
-scruby/db.py,sha256=LwSmkgFfxHLIKIJ6skE4FZ-Ad2GAItKbXYiMPBS8f18,15189
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.10.2.dist-info/METADATA,sha256=cJT0AGNe98yqY0CChu-lUmxLy03jy99U_11YdHndrvk,10829
-scruby-0.10.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.10.2.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.10.2.dist-info/RECORD,,