scruby 0.9.3__py3-none-any.whl → 0.27.2__py3-none-any.whl

scruby/__init__.py

@@ -1,29 +1,37 @@
-"""A fast key-value storage library.
-
-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 database consists of collections.
-The maximum size of the one collection is 16**8=4294967296 branches,
-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.
-"""
-
-from __future__ import annotations
-
-__all__ = ("Scruby",)
-
-import logging
-
-from scruby.db import Scruby
-
-logging.basicConfig(
-    level=logging.INFO,
-    datefmt="%Y-%m-%d %H:%M:%S",
-    format="[%(asctime)s.%(msecs)03d] %(module)10s:%(lineno)-3d %(levelname)-7s - %(message)s",
-)
+#
+# .|'''|                        '||
+# ||                             ||
+# `|'''|, .|'', '||''| '||  ||`  ||''|, '||  ||`
+#  .   || ||     ||     ||  ||   ||  ||  `|..||
+#  |...|' `|..' .||.    `|..'|. .||..|'      ||
+#                                         ,  |'
+#                                          ''
+#
+# Copyright (c) 2025 Gennady Kostyunin
+# SPDX-License-Identifier: MIT
+#
+"""Asynchronous library for building and managing a hybrid database, by scheme of key-value.
+
+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,
+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.
+
+The effectiveness of the search for documents based on a quantum loop,
+requires a large number of processor threads.
+"""
+
+from __future__ import annotations
+
+__all__ = (
+    "settings",
+    "Scruby",
+)
+
+from scruby import settings
+from scruby.db import Scruby

scruby/aggregation.py

@@ -0,0 +1,152 @@
+# Scruby - Asynchronous library for building and managing a hybrid database, by scheme of key-value.
+# Copyright (c) 2025 Gennady Kostyunin
+# SPDX-License-Identifier: MIT
+#
+"""Aggregation classes."""
+
+from __future__ import annotations
+
+__all__ = (
+    "Average",
+    "Counter",
+    "Max",
+    "Min",
+    "Sum",
+)
+
+from decimal import ROUND_HALF_EVEN, Decimal
+from typing import Any
+
+
+class Average:
+    """Aggregation class for calculating the average value.
+
+    Args:
+        precision: The accuracy of rounding. `By default = .00`
+        rounding: Rounding mode. `By default = ROUND_HALF_EVEN`
+    """
+
+    def __init__(  # noqa: D107
+        self,
+        precision: str = ".00",
+        rounding: str = ROUND_HALF_EVEN,
+    ) -> None:
+        self.value = Decimal()
+        self.counter = 0
+        self.precision = precision
+        self.rounding = rounding
+
+    def set(self, number: int | float) -> None:
+        """Add value.
+
+        Args:
+            number: Current value (int | float).
+        """
+        self.value += Decimal(str(number))
+        self.counter += 1
+
+    def get(self) -> Decimal:
+        """Get arithmetic average value.
+
+        Returns:
+            Number (Decimal) - Average value.
+        """
+        return (self.value / Decimal(str(self.counter))).quantize(
+            exp=Decimal(self.precision),
+            rounding=self.rounding,
+        )
+
+
+class Counter:
+    """Aggregation class for calculating the number of documents.
+
+    Args:
+        limit: The maximum counter value.
+    """
+
+    def __init__(self, limit: int = 1000) -> None:  # noqa: D107
+        self.limit = limit
+        self.counter = 0
+
+    def check(self) -> bool:
+        """Check the condition of the counter.
+
+        Returns:
+            Boolean value. If `True`, the maximum value is achieved.
+        """
+        return self.counter >= self.limit
+
+    def next(self) -> None:
+        """Increment the counter on one."""
+        self.counter += 1
+
+
+class Max:
+    """Aggregation class for calculating the maximum value."""
+
+    def __init__(self) -> None:  # noqa: D107
+        self.value: Any = 0
+
+    def set(self, number: int | float) -> None:
+        """Add value.
+
+        Args:
+            number: Current value.
+        """
+        if number > self.value:
+            self.value = number
+
+    def get(self) -> Any:
+        """Get maximum value.
+
+        Returns:
+            Number (int|float) - Maximum value.
+        """
+        return self.value
+
+
+class Min:
+    """Aggregation class for calculating the minimum value."""
+
+    def __init__(self) -> None:  # noqa: D107
+        self.value: Any = 0
+
+    def set(self, number: int | float) -> None:
+        """Add value.
+
+        Args:
+            number: Current value.
+        """
+        if self.value == 0 or number < self.value:
+            self.value = number
+
+    def get(self) -> Any:
+        """Get minimum value.
+
+        Returns:
+            Number (int|float) - Minimum value.
+        """
+        return self.value
+
+
+class Sum:
+    """Aggregation class for calculating sum of values."""
+
+    def __init__(self) -> None:  # noqa: D107
+        self.value = Decimal()
+
+    def set(self, number: int | float) -> None:
+        """Add value.
+
+        Args:
+            number: Current value.
+        """
+        self.value += Decimal(str(number))
+
+    def get(self) -> Decimal:
+        """Get sum of values.
+
+        Returns:
+            Number (int|float) - Sum of values.
+        """
+        return self.value