scruby 0.7.1__py3-none-any.whl → 0.8.0__py3-none-any.whl

scruby/constants.py

@@ -4,10 +4,10 @@ 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.
-    - `0` - 4294967296 keys (by default).
-    - `2` - 16777216 keys.
-    - `4` - 65536 keys.
-    - `6` - 256 keys (main purpose is tests).
+    - `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
@@ -24,8 +24,8 @@ from typing import Literal
 DB_ROOT: str = "ScrubyDB"
 
 # The length of the hash reduction on the left side.
-# 0 = 4294967296 keys (by default).
-# 2 = 16777216 keys.
-# 4 = 65536 keys.
-# 6 = 256 keys (main purpose is tests).
+# 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

@@ -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.
@@ -229,7 +229,54 @@ class Scruby[T]:
                     db_root,
                     class_model,
                 )
-                result = future.result(timeout)
-                if result is not None:
-                    return result
+                doc = future.result(timeout)
+                if doc is not None:
+                    return doc
         return None
+
+    def find_many(
+        self,
+        filter_fn: Callable,
+        db_query_docs_limit: int = 1000,
+        max_workers: int | None = None,
+        timeout: float | None = None,
+    ) -> list[T] | None:
+        """Find documents.
+
+        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.
+            db_query_docs_limit: Limiting the number of request results. By default = 1000.
+            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
+        db_root: str = self.__db_root
+        class_model: T = self.__class_model
+        counter: int = 0
+        with concurrent.futures.ThreadPoolExecutor(max_workers) as executor:
+            results = []
+            for key in keys:
+                if counter == db_query_docs_limit:
+                    break
+                future = executor.submit(
+                    search_task_fn,
+                    key,
+                    filter_fn,
+                    length_reduction_hash,
+                    db_root,
+                    class_model,
+                )
+                doc = future.result(timeout)
+                if doc is not None:
+                    results.append(doc)
+                    counter += 1
+        return results or None

{scruby-0.7.1.dist-info → scruby-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.7.1
+Version: 0.8.0
 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_REDUCTION_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."""
@@ -224,6 +225,66 @@ if __name__ == "__main__":
     anyio.run(main)
 ```
 
+```python
+"""Find documents.
+
+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.
+"""
+
+import anyio
+import datetime
+from pydantic import BaseModel, EmailStr
+from pydantic_extra_types.phone_numbers import PhoneNumber
+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
+                                     # (main purpose is tests).
+
+class User(BaseModel):
+    """Model of User."""
+    first_name: str
+    last_name: str
+    birthday: datetime.datetime
+    email: EmailStr
+    phone: PhoneNumber
+
+async def main() -> None:
+    """Example."""
+    # Get collection of `User`.
+    user_coll = Scruby(User)
+
+    # Create users.
+    for num in range(1, 10):
+        user = User(
+            first_name="John",
+            last_name="Smith",
+            birthday=datetime.datetime(1970, 1, num),
+            email=f"John_Smith_{num}@gmail.com",
+            phone=f"+44798612345{num}",
+        )
+        await db.set_key(f"+44798612345{num}", user)
+
+    # Find users by email.
+    users: list[User] | None = user_coll.find_many(
+        filter_fn=lambda doc: doc.email == "John_Smith_5@gmail.com" or doc.email == "John_Smith_8@gmail.com",
+    )
+    if users is not None:
+        pp(users)
+    else:
+        print("No users!")
+
+    # Full database deletion.
+    # Hint: The main purpose is tests.
+    await Scruby.napalm()
+
+if __name__ == "__main__":
+    anyio.run(main)
+```
+
 ## Changelog
 
 [View the change history](https://github.com/kebasyaty/scruby/blob/v0/CHANGELOG.md "Changelog").

scruby-0.8.0.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=FWCrcpzP93V1fk7NXhp6x2UgGkwqvk7qXvphm38R0X8,10130
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.8.0.dist-info/METADATA,sha256=Ktsxx4l5cmeVST2tzADKs7Hazi3WD1zjSS53QVpyJY8,10314
+scruby-0.8.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.8.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.8.0.dist-info/RECORD,,

scruby-0.7.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-scruby/__init__.py,sha256=myX7sG-7oAQZGdgfZtTGXYCCraTeuwi7SjBoltftpnM,648
-scruby/constants.py,sha256=XcBbK_gkDC0makWE34M8gUotwj3smi2sWY4mMnfzUt4,874
-scruby/db.py,sha256=FkYBsVYERtauTlWjl8b8cDTTIaH1w7lOzAneWUtNLDE,8114
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.7.1.dist-info/METADATA,sha256=qkiNaSRnF2pnWMImFLsAz16MMRD_amaDImy9DbFwNoM,8616
-scruby-0.7.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.7.1.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.7.1.dist-info/RECORD,,