scruby 0.11.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

scruby/__init__.py

@@ -1,8 +1,7 @@
-"""A fast key-value storage library.
+"""Asynchronous library for building and managing a hybrid database, by scheme of key-value.
 
-Scruby is a fast key-value storage asynchronous library that provides an
-ordered mapping from string keys to string values.
-The library uses fractal-tree addressing.
+The library uses fractal-tree addressing and
+the search for documents based on the effect of a quantum loop.
 
 The database consists of collections.
 The maximum size of the one collection is 16**8=4294967296 branches,
@@ -11,7 +10,8 @@ each branch can store one or more keys.
 The value of any key in collection can be obtained in 8 steps,
 thereby achieving high performance.
 
-In the future, to search by value of key, the use of a quantum loop is supposed.
+The effectiveness of the search for documents based on a quantum loop,
+requires a large number of processor threads.
 """
 
 from __future__ import annotations

scruby/db.py

@@ -467,7 +467,7 @@ class Scruby[T]:
     def _task_delete(
         branch_number: int,
         filter_fn: Callable,
-        hash_reduce_left: str,
+        hash_reduce_left: int,
         db_root: str,
         class_model: T,
     ) -> int:
@@ -539,3 +539,48 @@ class Scruby[T]:
         if counter < 0:
             self._sync_counter_documents(counter)
         return abs(counter)
+
+    @staticmethod
+    def _task_get_docs(
+        branch_number: int,
+        hash_reduce_left: int,
+        db_root: str,
+        class_model: T,
+    ) -> list[Any]:
+        """Get documents for custom task.
+
+        This method is for internal use.
+        """
+        branch_number_as_hash: str = f"{branch_number:08x}"[hash_reduce_left:]
+        separated_hash: str = "/".join(list(branch_number_as_hash))
+        leaf_path: SyncPath = SyncPath(
+            *(
+                db_root,
+                class_model.__name__,
+                separated_hash,
+                "leaf.json",
+            ),
+        )
+        docs = []
+        if leaf_path.exists():
+            data_json: bytes = leaf_path.read_bytes()
+            data: dict[str, str] = orjson.loads(data_json) or {}
+            for _, val in data.items():
+                docs.append(class_model.model_validate_json(val))
+        return docs
+
+    def run_custom_task(self, custom_task: Callable) -> Any:
+        """Running custom task.
+
+        This method running a task created on the basis of a quantum loop.
+        Effectiveness running task depends on the number of processor threads.
+        Ideally, hundreds and even thousands of threads are required.
+        """
+        kwargs = {
+            "get_docs_fn": self._task_get_docs,
+            "branch_numbers": range(1, self.__max_branch_number),
+            "hash_reduce_left": self.__hash_reduce_left,
+            "db_root": self.__db_root,
+            "class_model": self.__class_model,
+        }
+        return custom_task(**kwargs)

{scruby-0.11.0.dist-info → scruby-0.12.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.11.0
+Version: 0.12.0
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -43,7 +43,7 @@ Description-Content-Type: text/markdown
   </p>
   <p>
     <h1>Scruby</h1>
-    <h3>A fast key-value storage library.</h3>
+    <h3>Asynchronous library for building and managing a hybrid database,<br>by scheme of key-value.</h3>
     <p align="center">
       <a href="https://github.com/kebasyaty/scruby/actions/workflows/test.yml" alt="Build Status"><img src="https://github.com/kebasyaty/scruby/actions/workflows/test.yml/badge.svg" alt="Build Status"></a>
       <a href="https://kebasyaty.github.io/scruby/" alt="Docs"><img src="https://img.shields.io/badge/docs-available-brightgreen.svg" alt="Docs"></a>
@@ -65,20 +65,23 @@ Description-Content-Type: text/markdown
       <a href="https://github.com/kebasyaty/scruby/releases/" alt="GitHub release"><img src="https://img.shields.io/github/release/kebasyaty/scruby" alt="GitHub release"></a>
     </p>
     <p align="center">
-      Scruby is a fast key-value storage asynchronous library that provides an
-      <br>
-      ordered mapping from string keys to string values.
-      <br>
-      The library uses fractal-tree addressing.
-      <br>
-      The database consists of collections.
-      <br>
-      The maximum size of the one collection is 16**8=4294967296 branches,
-      each branch can store one or more keys.
-      <br>
-      The value of any key in collection can be obtained in 8 steps, thereby achieving high performance.
-      <br>
-      In the future, to search by value of key, the use of a quantum loop is supposed.
+        The library uses fractal-tree addressing and
+        <br>
+        the search for documents based on the effect of a quantum loop.
+        <br>
+        The database consists of collections.
+        <br>
+        The maximum size of the one collection is 16\*\*8=4294967296 branches,
+        <br>
+        each branch can store one or more keys.
+        <br>
+        The value of any key in collection can be obtained in 8 steps,
+        <br>
+        thereby achieving high performance.
+        <br>
+        The effectiveness of the search for documents based on a quantum loop,
+        <br>
+        requires a large number of processor threads.
     </p>
   </p>
 </div>
@@ -117,6 +120,7 @@ from scruby import Scruby, constants
 
 constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
 
+
 class User(BaseModel):
     """Model of User."""
     first_name: str
@@ -125,6 +129,7 @@ class User(BaseModel):
     email: EmailStr
     phone: Annotated[PhoneNumber, PhoneNumberValidator(number_format="E164")]
 
+
 async def main() -> None:
     """Example."""
     # Get collection of `User`.
@@ -154,6 +159,7 @@ async def main() -> None:
     # Hint: The main purpose is tests.
     await Scruby.napalm()
 
+
 if __name__ == "__main__":
     anyio.run(main)
 ```
@@ -176,7 +182,8 @@ from pprint import pprint as pp
 
 constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
 constants.HASH_REDUCE_LEFT = 6  # 256 branches in collection
-                                     # (main purpose is tests).
+                                # (main purpose is tests).
+
 
 class User(BaseModel):
     """Model of User."""
@@ -186,6 +193,7 @@ class User(BaseModel):
     email: EmailStr
     phone: Annotated[PhoneNumber, PhoneNumberValidator(number_format="E164")]
 
+
 async def main() -> None:
     """Example."""
     # Get collection of `User`.
@@ -225,6 +233,7 @@ async def main() -> None:
     # Hint: The main purpose is tests.
     await Scruby.napalm()
 
+
 if __name__ == "__main__":
     anyio.run(main)
 ```
@@ -247,7 +256,8 @@ from pprint import pprint as pp
 
 constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
 constants.HASH_REDUCE_LEFT = 6  # 256 branches in collection
-                                     # (main purpose is tests).
+                                # (main purpose is tests).
+
 
 class User(BaseModel):
     """Model of User."""
@@ -257,6 +267,7 @@ class User(BaseModel):
     email: EmailStr
     phone: Annotated[PhoneNumber, PhoneNumberValidator(number_format="E164")]
 
+
 async def main() -> None:
     """Example."""
     # Get collection of `User`.
@@ -286,6 +297,7 @@ async def main() -> None:
     # Hint: The main purpose is tests.
     await Scruby.napalm()
 
+
 if __name__ == "__main__":
     anyio.run(main)
 ```

scruby-0.12.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+scruby/__init__.py,sha256=GOVcjXmcOEDBbJQJDJlQq-x3M-VGJaMSN278EXsl2po,884
+scruby/constants.py,sha256=3LZfcxcuRqwzoB0-iogLMjKBZRdxfWJmTbyPwVRhQgY,1007
+scruby/db.py,sha256=fFJKCvvDmHKXzQubghG2DoRV7xumd460sHGqCDCCgh0,21877
+scruby/errors.py,sha256=aHQri4LNcFVQrSHwjyzb1fL8O49SwjYEU4QgMOo4uyA,622
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.12.0.dist-info/METADATA,sha256=Ok-HJBIDsQ-DktJRjoIORaC91Vbc8qt9UPc-VN9k57Q,10925
+scruby-0.12.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.12.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.12.0.dist-info/RECORD,,

scruby-0.11.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-scruby/__init__.py,sha256=wFwUS1KcLxfIopXOVS8gPue9fNzIIU2cVj_RgK5drz4,849
-scruby/constants.py,sha256=3LZfcxcuRqwzoB0-iogLMjKBZRdxfWJmTbyPwVRhQgY,1007
-scruby/db.py,sha256=Q7J4OKS2emiF0KzZClSjpBBLjohnccZ81T4pgoWNxqA,20269
-scruby/errors.py,sha256=aHQri4LNcFVQrSHwjyzb1fL8O49SwjYEU4QgMOo4uyA,622
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.11.0.dist-info/METADATA,sha256=yS9LDAYAqmxxn8cXHKbO7BmPEsX4o7th3VVFtgr9aoo,10824
-scruby-0.11.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.11.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.11.0.dist-info/RECORD,,