Skip to content

loggers ¤

Logging functions.

Classes:

Functions:

LoggerAdapter ¤

LoggerAdapter(prefix: str, logger: Logger)

Bases: LoggerAdapter

A logger adapter to prefix messages.

Parameters:

  • prefix (str) –

    The string to insert in front of every message.

  • logger (Logger) –

    The logger instance.

Methods:

Source code in src/mkdocstrings/loggers.py 
30
31
32
33
34
35
36
37
38
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/mkdocstrings/loggers.py 
40
41
42
43
44
45
46
47
48
49
50
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

TemplateLogger ¤

TemplateLogger(logger: LoggerAdapter)

A wrapper class to allow logging in templates.

Attributes:

  • debug –

    Function to log a DEBUG message.

  • info –

    Function to log an INFO message.

  • warning –

    Function to log a WARNING message.

  • error –

    Function to log an ERROR message.

  • critical –

    Function to log a CRITICAL message.

Parameters:

Source code in src/mkdocstrings/loggers.py 
64
65
66
67
68
69
70
71
72
73
74
def __init__(self, logger: LoggerAdapter):
    """Initialize the object.

    Arguments:
        logger: A logger adapter.
    """
    self.debug = get_template_logger_function(logger.debug)
    self.info = get_template_logger_function(logger.info)
    self.warning = get_template_logger_function(logger.warning)
    self.error = get_template_logger_function(logger.error)
    self.critical = get_template_logger_function(logger.critical)

get_logger ¤

get_logger(name: str) -> LoggerAdapter

Return a pre-configured logger.

Parameters:

  • name (str) –

    The name to use with logging.getLogger.

Returns:

Source code in src/mkdocstrings/loggers.py 
126
127
128
129
130
131
132
133
134
135
136
def get_logger(name: str) -> LoggerAdapter:
    """Return a pre-configured logger.

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

    Returns:
        A logger configured to work well in MkDocs.
    """
    logger = logging.getLogger(f"mkdocs.plugins.{name}")
    return LoggerAdapter(name.split(".", 1)[0], logger)

get_template_logger ¤

get_template_logger() -> TemplateLogger

Return a logger usable in templates.

Returns:

Source code in src/mkdocstrings/loggers.py 
139
140
141
142
143
144
145
def get_template_logger() -> TemplateLogger:
    """Return a logger usable in templates.

    Returns:
        A template logger.
    """
    return TemplateLogger(get_logger("mkdocstrings.templates"))

get_template_logger_function ¤

get_template_logger_function(
    logger_func: Callable,
) -> Callable

Create a wrapper function that automatically receives the Jinja template context.

Parameters:

  • logger_func (Callable) –

    The logger function to use within the wrapper.

Returns:

Source code in src/mkdocstrings/loggers.py 
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def get_template_logger_function(logger_func: Callable) -> Callable:
    """Create a wrapper function that automatically receives the Jinja template context.

    Arguments:
        logger_func: The logger function to use within the wrapper.

    Returns:
        A function.
    """

    @pass_context
    def wrapper(context: Context, msg: str | None = None) -> str:
        """Log a message.

        Arguments:
            context: The template context, automatically provided by Jinja.
            msg: The message to log.

        Returns:
            An empty string.
        """
        template_path = get_template_path(context)
        logger_func(f"{template_path}: {msg or 'Rendering'}")
        return ""

    return wrapper

get_template_path ¤

get_template_path(context: Context) -> str

Return the path to the template currently using the given context.

Parameters:

  • context (Context) –

    The template context.

Returns:

  • str –

    The relative path to the template.

Source code in src/mkdocstrings/loggers.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def get_template_path(context: Context) -> str:
    """Return the path to the template currently using the given context.

    Arguments:
        context: The template context.

    Returns:
        The relative path to the template.
    """
    context_name: str = str(context.name)
    filename = context.environment.get_template(context_name).filename
    if filename:
        for template_dir in TEMPLATES_DIRS:
            with suppress(ValueError):
                return str(Path(filename).relative_to(template_dir))
        with suppress(ValueError):
            return str(Path(filename).relative_to(Path.cwd()))
        return filename
    return context_name