logger ¤
This module contains logging utilities.
We provide the patch_loggers
function so dependant libraries can patch loggers as they see fit.
For example, to fit in the MkDocs logging configuration and prefix each log message with the module name:
import logging
from griffe.logger import patch_loggers
class LoggerAdapter(logging.LoggerAdapter):
def __init__(self, prefix, logger):
super().__init__(logger, {})
self.prefix = prefix
def process(self, msg, kwargs):
return f"{self.prefix}: {msg}", kwargs
def get_logger(name):
logger = logging.getLogger(f"mkdocs.plugins.{name}")
return LoggerAdapter(name, logger)
patch_loggers(get_logger)
Classes:
-
LogLevel
–Enumeration of available log levels.
Functions:
-
get_logger
–Create and return a new logger instance.
-
patch_loggers
–Patch loggers.
LogLevel ¤
flowchart TD
griffe.logger.LogLevel[LogLevel]
click griffe.logger.LogLevel href "" "griffe.logger.LogLevel"
Enumeration of available log levels.