Skip to content

rigging.logging

We use loguru for logging. This module provides a function to configure logging handlers.

To just enable rigging logs to flow, call logger.enable("rigging") after importing the module.

LogLevelLiteral = t.Literal['trace', 'debug', 'info', 'success', 'warning', 'error', 'critical'] module-attribute #

Valid logging levels.

configure_logging(log_level: LogLevelLiteral, log_file: pathlib.Path | None = None, log_file_level: LogLevelLiteral = 'debug') -> None #

Configures common loguru handlers.

Parameters:

  • log_level (LogLevelLiteral) –

    The desired log level.

  • log_file (Path | None, default: None ) –

    The path to the log file. If None, logging will only be done to the console.

  • log_file_level (LogLevelLiteral, default: 'debug' ) –

    The log level for the log file.

Source code in rigging/logging.py 
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
54
55
56
57
58
59
60
61
62
def configure_logging(
    log_level: LogLevelLiteral,
    log_file: pathlib.Path | None = None,
    log_file_level: LogLevelLiteral = "debug",
) -> None:
    """
    Configures common loguru handlers.

    Args:
        log_level: The desired log level.
        log_file: The path to the log file. If None, logging
            will only be done to the console.
        log_file_level: The log level for the log file.
    """
    global g_configured

    if g_configured:
        return

    logger.enable("rigging")

    logger.level("TRACE", color="<magenta>", icon="[T]")
    logger.level("DEBUG", color="<blue>", icon="[_]")
    logger.level("INFO", color="<cyan>", icon="[=]")
    logger.level("SUCCESS", color="<green>", icon="[+]")
    logger.level("WARNING", color="<yellow>", icon="[-]")
    logger.level("ERROR", color="<red>", icon="[!]")
    logger.level("CRITICAL", color="<RED>", icon="[x]")

    custom_format = "<green>{time:HH:mm:ss.SSS}</green> | <level>{level.icon}</level> {message}"

    logger.remove()
    logger.add(sys.stderr, format=custom_format, level=log_level.upper())

    if log_file is not None:
        logger.add(log_file, format=custom_format, level=log_file_level.upper())
        logger.info(f"Logging to {log_file}")

    g_configured = True