Skip to content

Aggregation classes

Aggregation classes.

Average

Aggregation class for calculating the average value.

Parameters:

Name Type Description Default
precision str

The accuracy of rounding. By default = .00

 '.00'
rounding str

Rounding mode. By default = ROUND_HALF_EVEN

 ROUND_HALF_EVEN
Source code in src\scruby\aggregation.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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,
        )

get()

Get arithmetic average value.

Returns:

Type Description
Decimal

Number (Decimal) - Average value.
Source code in src\scruby\aggregation.py 
44
45
46
47
48
49
50
51
52
53
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,
    )

set(number)

Add value.

Parameters:

Name Type Description Default
number int | float

Current value (int | float).

 required
Source code in src\scruby\aggregation.py 
35
36
37
38
39
40
41
42
def set(self, number: int | float) -> None:
    """Add value.

    Args:
        number: Current value (int | float).
    """
    self.value += Decimal(str(number))
    self.counter += 1

Counter

Aggregation class for calculating the number of documents.

Parameters:

Name Type Description Default
limit int

The maximum counter value.

 1000
Source code in src\scruby\aggregation.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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

check()

Check the condition of the counter.

Returns:

Type Description
bool

Boolean value. If True, the maximum value is achieved.
Source code in src\scruby\aggregation.py 
67
68
69
70
71
72
73
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

next()

Increment the counter on one.

Source code in src\scruby\aggregation.py 
75
76
77
def next(self) -> None:
    """Increment the counter on one."""
    self.counter += 1

Max

Aggregation class for calculating the maximum value.

Source code in src\scruby\aggregation.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
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

get()

Get maximum value.

Returns:

Type Description
Any

Number (int|float) - Maximum value.
Source code in src\scruby\aggregation.py 
 95
 96
 97
 98
 99
100
101
def get(self) -> Any:
    """Get maximum value.

    Returns:
        Number (int|float) - Maximum value.
    """
    return self.value

set(number)

Add value.

Parameters:

Name Type Description Default
number int | float

Current value.

 required
Source code in src\scruby\aggregation.py 
86
87
88
89
90
91
92
93
def set(self, number: int | float) -> None:
    """Add value.

    Args:
        number: Current value.
    """
    if number > self.value:
        self.value = number

Min

Aggregation class for calculating the minimum value.

Source code in src\scruby\aggregation.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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

get()

Get minimum value.

Returns:

Type Description
Any

Number (int|float) - Minimum value.
Source code in src\scruby\aggregation.py 
119
120
121
122
123
124
125
def get(self) -> Any:
    """Get minimum value.

    Returns:
        Number (int|float) - Minimum value.
    """
    return self.value

set(number)

Add value.

Parameters:

Name Type Description Default
number int | float

Current value.

 required
Source code in src\scruby\aggregation.py 
110
111
112
113
114
115
116
117
def set(self, number: int | float) -> None:
    """Add value.

    Args:
        number: Current value.
    """
    if self.value == 0 or number < self.value:
        self.value = number

Sum

Aggregation class for calculating sum of values.

Source code in src\scruby\aggregation.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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

get()

Get sum of values.

Returns:

Type Description
Decimal

Number (int|float) - Sum of values.
Source code in src\scruby\aggregation.py 
142
143
144
145
146
147
148
def get(self) -> Decimal:
    """Get sum of values.

    Returns:
        Number (int|float) - Sum of values.
    """
    return self.value

set(number)

Add value.

Parameters:

Name Type Description Default
number int | float

Current value.

 required
Source code in src\scruby\aggregation.py 
134
135
136
137
138
139
140
def set(self, number: int | float) -> None:
    """Add value.

    Args:
        number: Current value.
    """
    self.value += Decimal(str(number))