Skip to content

taps.logging

taps/logging.py

init_logging() 

init_logging(
    logfile: Path | None = None,
    level: int | str = logging.INFO,
    logfile_level: int | str = logging.INFO,
    force: bool = False,
) -> None

Initialize logging with custom formats.

Adds a custom log levels RUN and APP which are higher than INFO and lower than WARNING. RUN is used by the benchmark harness and APP is using within the applications.

Usage 
import logging
from taps.logging import init_logger

init_logger(...)

logger = logging.getLogger(__name__)
logger.log(RUN_LOG_LEVEL, 'message')

Parameters:

  • logfile (str, default: None ) –

    option filepath to write log to.

  • level ((int, str), default: INFO ) –

    minimum logging level.

  • logfile_level ((int, str), default: INFO ) –

    minimum logging level for the logfile.

  • force (bool, default: False ) –

    remove any existing handlers attached to the root handler. This option is useful to silencing the third-party package logging. Note: should not be set when running inside pytest.

Source code in taps/logging.py 
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def init_logging(
    logfile: pathlib.Path | None = None,
    level: int | str = logging.INFO,
    logfile_level: int | str = logging.INFO,
    force: bool = False,
) -> None:
    """Initialize logging with custom formats.

    Adds a custom log levels `RUN` and `APP` which are higher than `INFO` and
    lower than `WARNING`. `RUN` is used by the benchmark harness
    and `APP` is using within the applications.

    Usage:
        ```python
        import logging
        from taps.logging import init_logger

        init_logger(...)

        logger = logging.getLogger(__name__)
        logger.log(RUN_LOG_LEVEL, 'message')
        ```

    Args:
        logfile (str): option filepath to write log to.
        level (int, str): minimum logging level.
        logfile_level (int, str): minimum logging level for the logfile.
        force (bool): remove any existing handlers attached to the root
            handler. This option is useful to silencing the third-party
            package logging. Note: should not be set when running inside
            pytest.
    """
    logging.addLevelName(RUN_LOG_LEVEL, 'RUN')
    logging.addLevelName(APP_LOG_LEVEL, 'APP')

    stdout_handler = logging.StreamHandler(sys.stdout)
    stdout_handler.setLevel(level)

    handlers: list[logging.Handler] = [stdout_handler]
    if logfile is not None:
        logfile.parent.mkdir(parents=True, exist_ok=True)
        handler = logging.FileHandler(logfile)
        handler.setLevel(logfile_level)
        handlers.append(handler)

    kwargs: dict[str, Any] = {}
    if force:  # pragma: no cover
        kwargs['force'] = force

    logging.basicConfig(
        format=(
            '[%(asctime)s.%(msecs)03d] %(levelname)-5s (%(name)s) :: '
            '%(message)s'
        ),
        datefmt='%Y-%m-%d %H:%M:%S',
        level=logging.DEBUG,
        handlers=handlers,
        **kwargs,
    )