time_operation_parsing

Module for ParserTimeAggregationRule class

!!! classes ParserTimeAggregationRule

parse_operation_values(operation_str)

parses the operation_str to a TimeOperationType and optional percentile value

Parameters:

Name	Type	Description	Default
operation_str	str	string containing the time operation type	required

Exceptions:

Type	Description
ValueError	if the time operation type is a unknown TimeOperationType
ValueError	the operation parameter (percentile value) is not a number or < 0 or > 100

Returns:

Type	Description
Tuple[TimeOperationType, float]	parsed TimeOperationType and percentile value

Source code in parsers/time_operation_parsing.py

def parse_operation_values(operation_str: str) -> Tuple[TimeOperationType, float]:
    """parses the operation_str to a TimeOperationType and optional
    percentile value

    Args:
        operation_str (str): string containing the time operation type

    Raises:
        ValueError: if the time operation type is a unknown TimeOperationType
        ValueError: the operation parameter (percentile value) is not a
                    number or < 0 or > 100

    Returns:
        Tuple[TimeOperationType, float]: parsed TimeOperationType and percentile value
    """

    # if operation contains percentile,
    # extract percentile value from operation:
    if str.startswith(operation_str, "PERCENTILE"):
        try:
            percentile_value = float(str(operation_str)[11:-1])
        except ValueError as exc:
            message = (
                "Operation percentile is missing valid value like 'percentile(10)'"
            )
            raise ValueError(message) from exc

        # test if percentile_value is within expected limits:
        if percentile_value < 0 or percentile_value > 100:
            message = "Operation percentile should be a number between 0 and 100."
            raise ValueError(message)
        return TimeOperationType.PERCENTILE, percentile_value

    # validate operation
    match_operation = [o for o in TimeOperationType if o.name == operation_str]
    operation_value = next(iter(match_operation), None)

    if not operation_value:
        message = (
            f"Operation '{operation_str}' is not of a predefined type. Should be in:"
            + f"{[o.name for o in TimeOperationType]}."
        )
        raise ValueError(message)

    return operation_value, 0