scruby 0.7.0__py3-none-any.whl → 0.7.2__py3-none-any.whl

scruby/constants.py

@@ -3,18 +3,18 @@
 The module contains the following variables:
 
 - `DB_ROOT` - Path to root directory of database. `By default = "ScrubyDB"` (*in root of project*).
-- `LENGTH_SEPARATED_HASH` - Length of separated hash for create path inside collection.
-    - `0` - 4294967296 keys (by default).
-    - `2` - 16777216 keys.
-    - `4` - 65536 keys.
-    - `6` - 256 keys (main purpose is tests).
+- `LENGTH_REDUCTION_HASH` - 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ю
+    - `6` - 256 branches in collection (main purpose is tests).
 """
 
 from __future__ import annotations
 
 __all__ = (
     "DB_ROOT",
-    "LENGTH_SEPARATED_HASH",
+    "LENGTH_REDUCTION_HASH",
 )
 
 from typing import Literal
@@ -23,9 +23,9 @@ from typing import Literal
 # By default = "ScrubyDB" (in root of project).
 DB_ROOT: str = "ScrubyDB"
 
-# Length of separated hash for create path inside collection.
-# 0 = 4294967296 keys (by default).
-# 2 = 16777216 keys.
-# 4 = 65536 keys.
-# 6 = 256 keys (main purpose is tests).
-LENGTH_SEPARATED_HASH: Literal[0, 2, 4, 6] = 0
+# 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ю
+# 6 = 256 branches in collection (main purpose is tests).
+LENGTH_REDUCTION_HASH: Literal[0, 2, 4, 6] = 0

scruby/db.py

@@ -33,9 +33,9 @@ class Scruby[T]:
     ) -> None:
         self.__class_model = class_model
         self.__db_root = constants.DB_ROOT
-        self.__length_hash = constants.LENGTH_SEPARATED_HASH
+        self.__length_reduction_hash = constants.LENGTH_REDUCTION_HASH
         # The maximum number of keys.
-        match self.__length_hash:
+        match self.__length_reduction_hash:
             case 0:
                 self.__max_num_keys = 4294967296
             case 2:
@@ -58,7 +58,7 @@ class Scruby[T]:
         if len(key) == 0:
             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_hash :]
+        key_as_hash: str = f"{zlib.crc32(key.encode('utf-8')):08x}"[self.__length_reduction_hash :]
         # Convert crc32 sum in the segment of path.
         separated_hash: str = "/".join(list(key_as_hash))
         # The path of the branch to the database.
@@ -170,12 +170,12 @@ class Scruby[T]:
     def search_task(
         key: int,
         filter_fn: Callable,
-        length_hash: str,
+        length_reduction_hash: str,
         db_root: str,
         class_model: T,
     ) -> dict[str, Any] | None:
         """Search task."""
-        key_as_hash: str = f"{key:08x}"[length_hash:]
+        key_as_hash: str = f"{key:08x}"[length_reduction_hash:]
         separated_hash: str = "/".join(list(key_as_hash))
         leaf_path: SyncPath = SyncPath(
             *(
@@ -204,7 +204,7 @@ class Scruby[T]:
 
         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 streams are required.
+        Ideally, hundreds and even thousands of threads are required.
 
         Args:
             filter_fn: A function that execute the conditions of filtering.
@@ -216,7 +216,7 @@ class Scruby[T]:
         """
         keys: range = range(1, self.__max_num_keys)
         search_task_fn: Callable = self.search_task
-        length_hash: int = self.__length_hash
+        length_reduction_hash: int = self.__length_reduction_hash
         db_root: str = self.__db_root
         class_model: T = self.__class_model
         with concurrent.futures.ThreadPoolExecutor(max_workers) as executor:
@@ -225,7 +225,7 @@ class Scruby[T]:
                     search_task_fn,
                     key,
                     filter_fn,
-                    length_hash,
+                    length_reduction_hash,
                     db_root,
                     class_model,
                 )

{scruby-0.7.0.dist-info → scruby-0.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.7.0
+Version: 0.7.2
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -160,7 +160,7 @@ if __name__ == "__main__":
 
 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 streams are required.
+Ideally, hundreds and even thousands of threads are required.
 """
 
 import anyio
@@ -171,7 +171,8 @@ from scruby import Scruby, constants
 from pprint import pprint as pp
 
 constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
-constants.LENGTH_SEPARATED_HASH = 6  # 256 keys (main purpose is tests).
+constants.LENGTH_REDUCTION_HASH = 6  # 256 branches in collection
+                                     # (main purpose is tests).
 
 class User(BaseModel):
     """Model of User."""

scruby-0.7.2.dist-info/RECORD

@@ -0,0 +1,8 @@
+scruby/__init__.py,sha256=myX7sG-7oAQZGdgfZtTGXYCCraTeuwi7SjBoltftpnM,648
+scruby/constants.py,sha256=GbB-O0qaVdi5EHUp-zRAppFXLR-oHxpXUFVAOCpS0C8,1022
+scruby/db.py,sha256=84DRrw21jiAmEsxjOOJnAfFvfE8hNdaJ-TB9BQtM0CQ,8114
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.7.2.dist-info/METADATA,sha256=b_02kOWP7dScGNwKtvVwQrv7CPiIHHIJ33OxMMz5Ink,8673
+scruby-0.7.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.7.2.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.7.2.dist-info/RECORD,,

scruby-0.7.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-scruby/__init__.py,sha256=myX7sG-7oAQZGdgfZtTGXYCCraTeuwi7SjBoltftpnM,648
-scruby/constants.py,sha256=1Po5FSYj1qst8F05L4cPyKsDHNmReXDx_IKYgNa06eI,892
-scruby/db.py,sha256=qelkW6MzI4HQOtkXDb8qOJHfqsads3vILSnddboQEOc,8034
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.7.0.dist-info/METADATA,sha256=uH-rBdWc5tDUhFxTYac6Z3EDua6z-H-mWBXo9gB47Mc,8616
-scruby-0.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.7.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.7.0.dist-info/RECORD,,