Skip to content

logger ¤

Logging functions.

Classes:

  • PluginLogger –

    A logger adapter to prefix messages with the originating package name.

Functions:

PluginLogger ¤

PluginLogger(prefix: str, logger: Logger)

Bases: LoggerAdapter

A logger adapter to prefix messages with the originating package name.

Parameters:

  • prefix (str) –

    The string to insert in front of every message.

  • logger (Logger) –

    The logger instance.

Methods:

Source code in src/mkdocs_llmstxt/logger.py 
15
16
17
18
19
20
21
22
23
def __init__(self, prefix: str, logger: logging.Logger):
    """Initialize the object.

    Arguments:
        prefix: The string to insert in front of every message.
        logger: The logger instance.
    """
    super().__init__(logger, {})
    self.prefix = prefix

process ¤

process(
    msg: str, kwargs: MutableMapping[str, Any]
) -> tuple[str, Any]

Process the message.

Parameters:

Returns:

Source code in src/mkdocs_llmstxt/logger.py 
25
26
27
28
29
30
31
32
33
34
35
def process(self, msg: str, kwargs: MutableMapping[str, Any]) -> tuple[str, Any]:
    """Process the message.

    Arguments:
        msg: The message:
        kwargs: Remaining arguments.

    Returns:
        The processed message.
    """
    return f"{self.prefix}: {msg}", kwargs

get_logger ¤

get_logger(name: str) -> PluginLogger

Return a logger for plugins.

Parameters:

  • name (str) –

    The name to use with logging.getLogger.

Returns:

  • PluginLogger –

    A logger configured to work well in MkDocs, prefixing each message with the plugin package name.

Source code in src/mkdocs_llmstxt/logger.py 
38
39
40
41
42
43
44
45
46
47
48
49
def get_logger(name: str) -> PluginLogger:
    """Return a logger for plugins.

    Arguments:
        name: The name to use with `logging.getLogger`.

    Returns:
        A logger configured to work well in MkDocs,
            prefixing each message with the plugin package name.
    """
    logger = logging.getLogger(f"mkdocs.plugins.{name}")
    return PluginLogger(name.split(".", 1)[0], logger)