scruby 0.13.1__py3-none-any.whl → 0.14.0__py3-none-any.whl

scruby/aggregation.py

@@ -20,15 +20,44 @@ class Average:
         self.counter = 0.0
 
     def set(self, number: int | float) -> None:
-        """Add value."""
+        """Add value.
+
+        Args:
+            number: Current value.
+        """
         self.value += float(number)
         self.counter += 1.0
 
     def get(self) -> float:
-        """Get arithmetic average value."""
+        """Get arithmetic average value.
+
+        Returns:
+            Number (int|float) - Average value.
+        """
         return self.value / self.counter
 
 
+class Counter:
+    """Aggregation class for calculating the number of documents.
+
+    Args:
+        max: The maximum counter value.
+    """
+
+    def __init__(self, max: int = 1000) -> None:
+        self.max = max
+        self.counter = 0
+
+    def check(self) -> bool:
+        """Check the condition of the counter.
+
+        Returns:
+            Boolean value. If `True`, the maximum value is achieved.
+        """
+        self.counter += 1
+        return self.counter == self.max
+
+
 class Max:
     """Aggregation class for calculating the maximum value."""
 
@@ -36,12 +65,20 @@ class Max:
         self.value: Any = 0
 
     def set(self, number: int | float) -> None:
-        """Add value."""
+        """Add value.
+
+        Args:
+            number: Current value.
+        """
         if number > self.value:
             self.value = number
 
     def get(self) -> Any:
-        """Get maximum value."""
+        """Get maximum value.
+
+        Returns:
+            Number (int|float) - Maximum value.
+        """
         return self.value
 
 
@@ -52,12 +89,20 @@ class Min:
         self.value: Any = 0
 
     def set(self, number: int | float) -> None:
-        """Add value."""
+        """Add value.
+
+        Args:
+            number: Current value.
+        """
         if self.value == 0 or number < self.value:
             self.value = number
 
     def get(self) -> Any:
-        """Get minimum value."""
+        """Get minimum value.
+
+        Returns:
+            Number (int|float) - Minimum value.
+        """
         return self.value
 
 
@@ -68,9 +113,17 @@ class Sum:
         self.value: Any = 0
 
     def set(self, number: int | float) -> None:
-        """Add value."""
+        """Add value.
+
+        Args:
+            number: Current value.
+        """
         self.value += number
 
     def get(self) -> Any:
-        """Get sum of values."""
+        """Get sum of values.
+
+        Returns:
+            Number (int|float) - Sum of values.
+        """
         return self.value

{scruby-0.13.1.dist-info → scruby-0.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.13.1
+Version: 0.14.0
 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.13.1.dist-info → scruby-0.14.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 scruby/__init__.py,sha256=GOVcjXmcOEDBbJQJDJlQq-x3M-VGJaMSN278EXsl2po,884
-scruby/aggregation.py,sha256=AdVZNl9fV59pWMBQez5upQEuodAg3HIw0ixOnM8FrKg,1762
+scruby/aggregation.py,sha256=q84saKAP72n_VM83fEX_UY9QFz4EyVkHCVuB_1kweDQ,2833
 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.13.1.dist-info/METADATA,sha256=LlJPM_ZrH1yhQA7Yk0owqfigwt72Z2gRIVlDFdJ1cL4,10925
-scruby-0.13.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.13.1.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.13.1.dist-info/RECORD,,
+scruby-0.14.0.dist-info/METADATA,sha256=p6ClZqXYNOcJtNHLgnYXW_CZStKogI-vgqrkmvbMn-w,10925
+scruby-0.14.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.14.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.14.0.dist-info/RECORD,,