about summary refs log tree commit diff stats
path: root/fungus/logger.py
blob: 41955cfbed189c4f0cc469964747b6a00ebd2746 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
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
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
#!/usr/bin/python3
"""Centralised logging configuration for Fungus Launcher.

Sets up a root logger with a single console handler that writes to
stderr (so stdout remains clean for pipes).  All submodules should
obtain their logger via ``get_logger(name)`` rather than calling
``logging.getLogger`` directly — this ensures the handler is
installed exactly once at first call.

Usage::

    from fungus.logger import get_logger, set_level
    log = get_logger(__name__)
    log.info("something happened")
    log.debug("verbose details")
    log.error("something went wrong: %s", exc)

    # Enable debug output from the CLI::

    set_level(logging.DEBUG)
"""

import logging
import sys

_handler: logging.Handler | None = None


def set_level(level: int) -> None:
    """Set the minimum logging level for all loggers.

    Installs the handler if it has not yet been created, then sets
    both the root logger and the handler to *level*.
    """
    global _handler

    if not _handler:
        _handler = logging.StreamHandler(sys.stderr)
        _handler.setFormatter(
            logging.Formatter("[%(name)s] %(levelname)s %(message)s")
        )
        logging.root.addHandler(_handler)

    logging.root.setLevel(level)
    _handler.setLevel(level)


def get_logger(name: str | None = None) -> logging.Logger:
    """Return a logger named *name* (or the root logger).

    The first call installs a ``StreamHandler`` writing to
    ``sys.stderr`` with a simple ``[name] level message`` format.
    Subsequent calls reuse the same handler.
    """
    global _handler

    logger = logging.getLogger(name)

    if not _handler:
        _handler = logging.StreamHandler(sys.stderr)
        _handler.setFormatter(
            logging.Formatter("[%(name)s] %(levelname)s %(message)s")
        )
        logger.addHandler(_handler)

    # Leave the logger at NOTSET so it inherits from the root logger.
    # The handler's own level (INFO by default) controls the minimum
    # severity; passing -v/--verbose raises it to DEBUG.
    return logger