validators

Loguru validators.

Pass objects, strings, bools, etc for evaluation.

Each validator checks for existence (unless none_ok=True), then type, then value (if a list of allowed values is passed).

validate_compression_str(string=None, none_ok=True)

Validate a Loguru compression string value.

Parameters:

Name	Type	Description	Default
string	str	The compression string to validate	None
none_ok	bool	If True, allows null values	True

Returns

(str): A validated compression string

Source code in src/red_utils/ext/loguru_utils/validators.py

def validate_compression_str(string: str = None, none_ok: bool = True) -> str:
    """Validate a Loguru compression string value.

    Params:
        string (str): The compression string to validate
        none_ok (bool): If `True`, allows null values

    Returns
    -------
        (str): A validated compression string
    """
    if none_ok:
        return string
    elif not string:
        raise ValueError("Missing a compression string to validate")

    if not isinstance(string, str):
        raise TypeError(f"Invalid type for string: ({type(string)}). Must be type(str)")

    if string not in valid_compression_strs:
        raise ValueError(
            f"Invalid compression type: [{type(string)}]. Must be one of {valid_compression_strs}"
        )

    return string

validate_level(level=None, none_ok=False)

Validate a Loguru compression string value.

Parameters:

Name	Type	Description	Default
level	str	A log level string	None
none_ok	bool	If True, allows null values	False

Returns

(str): A validated log level string

Source code in src/red_utils/ext/loguru_utils/validators.py

def validate_level(level: str = None, none_ok: bool = False) -> str:
    """Validate a Loguru compression string value.

    Params:
        level (str): A log level string
        none_ok (bool): If `True`, allows null values

    Returns
    -------
        (str): A validated log level string
    """
    if none_ok:
        return level
    elif not level:
        raise ValueError("Missing a log level string to evaluate.")

    if not isinstance(level, str):
        raise TypeError(f"Invalid level type: [{type(level)}]")

    try:
        for _level in log_levels:
            if not level == _level.name or not level == _level.level_name:
                pass
            else:
                return _level

    except ValueError as exc:
        raise ValueError(f"Unhandled exception validating log level. Details: {exc}")

validate_logger(_logger=None, none_ok=False)

Validate a loguru.Logger object.

Parameters:

Name	Type	Description	Default
_logger	logger	A Loguru logger	None
none_ok	bool	If True, allows null values	False

Returns

(loguru.logger): A validated `loguru.logger`

Source code in src/red_utils/ext/loguru_utils/validators.py

def validate_logger(_logger: logger = None, none_ok: bool = False) -> logger:
    """Validate a loguru.Logger object.

    Params:
        _logger (loguru.logger): A Loguru `logger`
        none_ok (bool): If `True`, allows null values

    Returns
    -------
        (loguru.logger): A validated `loguru.logger`
    """
    if none_ok:
        return _logger
    elif not _logger:
        raise ValueError("Missing loguru Logger object to validate")

    if not isinstance(_logger, type(logger)):
        raise TypeError(
            f"Invalid type for logger: {type(_logger)}. Must be type(Logger)"
        )

    return _logger