scruby 0.10.1__py3-none-any.whl → 0.10.3__py3-none-any.whl

scruby/db.py

@@ -27,6 +27,9 @@ T = TypeVar("T")
 class _Meta(BaseModel):
     """Metadata of Collection."""
 
+    db_root: str
+    model_name: str
+    length_reduction_hash: int
     counter_documents: int
 
 
@@ -59,7 +62,8 @@ class Scruby[T]:
                 msg: str = f"{unreachable} - Unacceptable value for LENGTH_REDUCTION_HASH."
                 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:
@@ -80,6 +84,9 @@ class Scruby[T]:
         if not branch_path.exists():
             branch_path.mkdir(parents=True)
             meta = _Meta(
+                db_root=self.__db_root,
+                model_name=self.__class_model.__name__,
+                length_reduction_hash=self.__length_reduction_hash,
                 counter_documents=0,
             )
             meta_json = meta.model_dump_json()
@@ -265,7 +272,7 @@ class Scruby[T]:
         return
 
     @staticmethod
-    def _search_task(
+    def _task_find(
         key: int,
         filter_fn: Callable,
         length_reduction_hash: str,
@@ -316,7 +323,7 @@ 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
+        search_task_fn: Callable = self._task_find
         length_reduction_hash: int = self.__length_reduction_hash
         db_root: str = self.__db_root
         class_model: T = self.__class_model
@@ -358,7 +365,7 @@ 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
+        search_task_fn: Callable = self._task_find
         length_reduction_hash: int = self.__length_reduction_hash
         db_root: str = self.__db_root
         class_model: T = self.__class_model
@@ -394,3 +401,43 @@ class Scruby[T]:
         """Get an estimate of the number of documents in this collection using collection metadata."""
         meta = await self._get_meta()
         return meta.counter_documents
+
+    def count_documents(
+        self,
+        filter_fn: Callable,
+        max_workers: int | None = None,
+        timeout: float | None = None,
+    ) -> int:
+        """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._task_find
+        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:
+            for key in keys:
+                future = executor.submit(
+                    search_task_fn,
+                    key,
+                    filter_fn,
+                    length_reduction_hash,
+                    db_root,
+                    class_model,
+                )
+                if future.result(timeout) is not None:
+                    counter += 1
+        return counter

scruby/errors.py

@@ -0,0 +1,20 @@
+"""XLOT Exceptions."""
+
+from __future__ import annotations
+
+__all__ = ("MetadataValueError",)
+
+
+class ScrubyException(Exception):
+    """Root Custom Exception."""
+
+    def __init__(self, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]
+        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.1.dist-info → scruby-0.10.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.10.1
+Version: 0.10.3
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby

scruby-0.10.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+scruby/__init__.py,sha256=wFwUS1KcLxfIopXOVS8gPue9fNzIIU2cVj_RgK5drz4,849
+scruby/constants.py,sha256=GbB-O0qaVdi5EHUp-zRAppFXLR-oHxpXUFVAOCpS0C8,1022
+scruby/db.py,sha256=J14Xjyc6iyb-cwBKiH8rJuioEHoYfNkLTezzvQBsJng,16181
+scruby/errors.py,sha256=4G0zNVzulBE9mM2iJLdg0EXP_W8n-L6EjZrkCCErvAU,574
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.10.3.dist-info/METADATA,sha256=JGgVH8QKtA-iGifWhNdSczfuglIT2RRw5njRuNKvG3M,10829
+scruby-0.10.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.10.3.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.10.3.dist-info/RECORD,,

scruby-0.10.1.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=d4fVb4JhGaBU_YPxByT156UGHQPTwzSizBqOpCNhW8Y,14159
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.10.1.dist-info/METADATA,sha256=k2AaJn-JijNceNIB7s13D1cB3jr4p4mW6R1z7IuXp4g,10829
-scruby-0.10.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.10.1.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.10.1.dist-info/RECORD,,