scruby 0.14.1__py3-none-any.whl → 0.14.2__py3-none-any.whl

scruby/aggregation.py

@@ -41,11 +41,11 @@ class Counter:
     """Aggregation class for calculating the number of documents.
 
     Args:
-        max: The maximum counter value.
+        limit: The maximum counter value.
     """
 
-    def __init__(self, max: int = 1000) -> None:
-        self.max = max
+    def __init__(self, limit: int = 1000) -> None:
+        self.limit = limit
         self.counter = 0
 
     def check(self) -> bool:
@@ -54,7 +54,7 @@ class Counter:
         Returns:
             Boolean value. If `True`, the maximum value is achieved.
         """
-        return self.counter >= self.max
+        return self.counter >= self.limit
 
     def next(self) -> None:
         """Increment the counter on one."""

scruby/db.py

@@ -335,7 +335,7 @@ class Scruby[T]:
     def find_many(
         self,
         filter_fn: Callable,
-        db_query_docs_limit: int = 1000,
+        limit_docs: int = 1000,
         max_workers: int | None = None,
         timeout: float | None = None,
     ) -> list[T] | None:
@@ -347,7 +347,7 @@ class Scruby[T]:
 
         Args:
             filter_fn: A function that execute the conditions of filtering.
-            db_query_docs_limit: Limiting the number of request results. By default = 1000.
+            limit_docs: Limiting the number of documents. 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.
@@ -363,7 +363,7 @@ class Scruby[T]:
         with concurrent.futures.ThreadPoolExecutor(max_workers) as executor:
             results = []
             for branch_number in branch_numbers:
-                if counter == db_query_docs_limit:
+                if counter == limit_docs:
                     break
                 future = executor.submit(
                     search_task_fn,
@@ -538,12 +538,16 @@ class Scruby[T]:
                 docs.append(class_model.model_validate_json(val))
         return docs
 
-    def run_custom_task(self, custom_task: Callable) -> Any:
+    def run_custom_task(self, custom_task_fn: Callable, limit_docs: int = 1000) -> 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.
+
+        Args:
+            custom_task_fn: A function that execute the custom task.
+            limit_docs: Limiting the number of documents. By default = 1000.
         """
         kwargs = {
             "get_docs_fn": self._task_get_docs,
@@ -551,5 +555,6 @@ class Scruby[T]:
             "hash_reduce_left": self.__hash_reduce_left,
             "db_root": self.__db_root,
             "class_model": self.__class_model,
+            "limit_docs": limit_docs,
         }
-        return custom_task(**kwargs)
+        return custom_task_fn(**kwargs)

{scruby-0.14.1.dist-info → scruby-0.14.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.14.1
+Version: 0.14.2
 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.14.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+scruby/__init__.py,sha256=GOVcjXmcOEDBbJQJDJlQq-x3M-VGJaMSN278EXsl2po,884
+scruby/aggregation.py,sha256=x_9ZJQHJHDISxRvddS5A2Hb0saIcfPTh1Veyf2KgX8A,2919
+scruby/constants.py,sha256=3LZfcxcuRqwzoB0-iogLMjKBZRdxfWJmTbyPwVRhQgY,1007
+scruby/db.py,sha256=_-2h6x1WkND52q-lDGYBFcQJ_7Mwxq3Rh4ZFfqIinsQ,21100
+scruby/errors.py,sha256=aHQri4LNcFVQrSHwjyzb1fL8O49SwjYEU4QgMOo4uyA,622
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.14.2.dist-info/METADATA,sha256=vWhruXyj6cQyhPbXjMsUnz-j3L92eImp_R1QxX16BH0,10925
+scruby-0.14.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.14.2.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.14.2.dist-info/RECORD,,

scruby-0.14.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-scruby/__init__.py,sha256=GOVcjXmcOEDBbJQJDJlQq-x3M-VGJaMSN278EXsl2po,884
-scruby/aggregation.py,sha256=fOsfMyCm28frKOFHmWzuGU81QPeJTJfs4EVIIroxOcQ,2909
-scruby/constants.py,sha256=3LZfcxcuRqwzoB0-iogLMjKBZRdxfWJmTbyPwVRhQgY,1007
-scruby/db.py,sha256=OXtMqq9y6RQkHHWOgFVXqI96v7g58SIoLUq-h09WxjI,20899
-scruby/errors.py,sha256=aHQri4LNcFVQrSHwjyzb1fL8O49SwjYEU4QgMOo4uyA,622
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.14.1.dist-info/METADATA,sha256=cnKZxapHkg2CRAFX_M1AgMiZ5oDNvW0nSjaTnlnryLw,10925
-scruby-0.14.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.14.1.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.14.1.dist-info/RECORD,,