Skip to content

Loggers¤

Main API¤

logger module-attribute ¤

logger: Logger = _get()

Our global logger, used throughout the library.

Griffe's output and error messages are logging messages.

Griffe provides the patch_loggers function so dependent libraries can patch Griffe 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 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)
Referenced by:

get_logger ¤

get_logger(name: str = 'griffe') -> Logger

Create and return a new logger instance.

Parameters:

  • name ¤

    (str, default: 'griffe' ) –

    The logger name.

Returns:

Referenced by:
Source code in src/griffe/_internal/logger.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
def get_logger(name: str = "griffe") -> Logger:
    """Create and return a new logger instance.

    Parameters:
        name: The logger name.

    Returns:
        The logger.
    """
    return Logger._get(name)

Logger ¤

Logger(name: str)
Returned by:

Methods:

  • disable –

    Temporarily disable logging.

Source code in src/griffe/_internal/logger.py 
24
25
26
def __init__(self, name: str) -> None:
    # Default logger that can be patched by third-party.
    self._logger = self.__class__._default_logger(name)

disable ¤

disable() -> Iterator[None]

Temporarily disable logging.

Referenced by:
Source code in src/griffe/_internal/logger.py 
32
33
34
35
36
37
38
39
40
@contextmanager
def disable(self) -> Iterator[None]:
    """Temporarily disable logging."""
    old_level = self._logger.level
    self._logger.setLevel(100)
    try:
        yield
    finally:
        self._logger.setLevel(old_level)

LogLevel ¤

Bases: str, Enum


              flowchart TD
              griffe.LogLevel[LogLevel]

              

              click griffe.LogLevel href "" "griffe.LogLevel"

Enumeration of available log levels.

Used by:

Attributes:

  • critical –

    The CRITICAL log level.

  • debug –

    The DEBUG log level.

  • error –

    The ERROR log level.

  • info –

    The INFO log level.

  • success –

    The SUCCESS log level.

  • trace –

    The TRACE log level.

  • warning –

    The WARNING log level.

critical class-attribute instance-attribute ¤

critical = 'critical'

The CRITICAL log level.

debug class-attribute instance-attribute ¤

debug = 'debug'

The DEBUG log level.

Used by:

error class-attribute instance-attribute ¤

error = 'error'

The ERROR log level.

Used by:

info class-attribute instance-attribute ¤

info = 'info'

The INFO log level.

success class-attribute instance-attribute ¤

success = 'success'

The SUCCESS log level.

trace class-attribute instance-attribute ¤

trace = 'trace'

The TRACE log level.

warning class-attribute instance-attribute ¤

warning = 'warning'

The WARNING log level.

Used by:

DEFAULT_LOG_LEVEL module-attribute ¤

DEFAULT_LOG_LEVEL = os.getenv(
    "GRIFFE_LOG_LEVEL", "INFO"
).upper()

The default log level for the CLI.

This can be overridden by the GRIFFE_LOG_LEVEL environment variable.

Advanced API¤

patch_loggers ¤

patch_loggers(
    get_logger_func: Callable[[str], Any],
) -> None

Patch Griffe logger and Griffe extensions' loggers.

Parameters:

  • get_logger_func ¤

    (Callable[[str], Any]) –

    A function accepting a name as parameter and returning a logger.

Referenced by:
Source code in src/griffe/_internal/logger.py 
105
106
107
108
109
110
111
def patch_loggers(get_logger_func: Callable[[str], Any]) -> None:
    """Patch Griffe logger and Griffe extensions' loggers.

    Parameters:
        get_logger_func: A function accepting a name as parameter and returning a logger.
    """
    Logger._patch_loggers(get_logger_func)