Skip to content

academy.logging.recommended

recommended_logging 

recommended_logging(
    level: int | str = INFO,
    *,
    logfile: str | Path | None = None,
    logfile_level: int | str | None = None,
    color: bool = True,
    extra: int = False
) -> LogConfig

Returns a LogConfig that is hopefully useful to most users.

The config object can be passed to other environments to get the same log configuration in those other environments.

Source code in academy/logging/recommended.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def recommended_logging(
    level: int | str = logging.INFO,
    *,
    logfile: str | pathlib.Path | None = None,
    logfile_level: int | str | None = None,
    color: bool = True,
    extra: int = False,
) -> LogConfig:
    """Returns a LogConfig that is hopefully useful to most users.

    The config object can be passed to other environments to get the same
    log configuration in those other environments.
    """
    configs: list[LogConfig] = []

    # Always makes a console logger.
    configs.append(ConsoleLogging(level=level, color=color, extra=extra))

    # If a log file is specified, make human readable logger
    if logfile is not None:
        logfile_level = level if logfile_level is None else logfile_level
        configs.append(
            FileLogging(logfile=logfile, level=logfile_level, extra=extra),
        )

    lc = configs[0] if len(configs) == 1 else MultiLogging(configs)

    return lc