get_rich_logger

Package for creating a rich logger.

get_rich_logger(level='NOTSET', name=None, log_format='%(message)s', traceback_show_locals=False, traceback_hide_dunder_sunder_locals=True, traceback_extra_lines=10, traceback_suppressed_modules=(), **logging_basic_config_extra_kwargs)

Substitute for logging.getLogger(), but pre-configured as rich logger with rich traceback.

Parameters:

Name	Type	Description	Default
level	Literal['NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'] | Literal[0, 10, 20, 30, 40, 50]	The logging level to use.	'NOTSET'
name	str	The name of the logger. Recommended to use __name__.	None
log_format	str	The format string to use for the rich logger.	'%(message)s'
traceback_show_locals	bool	Whether to show local variables in tracebacks.	False
traceback_hide_dunder_sunder_locals	bool	Whether to hide dunder and sunder variables in tracebacks. Only applicable to unhandled errors.	True
traceback_extra_lines	int	The number of extra lines to show in tracebacks.	10
traceback_suppressed_modules	Iterable[ModuleType]	The modules to suppress in tracebacks (e.g., pandas).	()
logging_basic_config_extra_kwargs	Unpack[LoggingBasicConfigExtraKwargs]	Extra keyword arguments to pass to logging.basicConfig().	{}

Returns:

Type	Description
Logger	The configured rich logger.

Raises:

Type	Description
TypeError	If additional_handlers is not a logging.Handler, Iterable[logging.Handler], or None.

Examples:

Python

import logging
from get_rich_logger import get_rich_logger

logger: logging.Logger = get_rich_logger(
    level="DEBUG",
    name=__name__,
    traceback_show_locals=True,
    traceback_extra_lines=10,
    traceback_suppressed_modules=(),
)

logging.debug("This is a rich debug message!")  # (1)

1 / 0  # (2)

1. Logs will be colored and formatted with rich.
2. Unhandled errors will have rich traceback.

Source code in src\get_rich_logger\_logger.py

def get_rich_logger(
    level: Literal["NOTSET", "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
    | Literal[0, 10, 20, 30, 40, 50] = "NOTSET",
    name: str | None = None,
    log_format: str = "%(message)s",  # Renamed the 'format' parameter
    traceback_show_locals: bool = False,
    traceback_hide_dunder_sunder_locals: bool = True,
    traceback_extra_lines: int = 10,
    traceback_suppressed_modules: Iterable[ModuleType] = (),
    **logging_basic_config_extra_kwargs: Unpack[LoggingBasicConfigExtraKwargs],
) -> logging.Logger:
    """
    Substitute for
    [logging.getLogger()](https://docs.python.org/3/library/logging.html),
    but pre-configured as rich logger with rich traceback.

    Parameters
    ----------
    level : Literal["NOTSET","DEBUG","INFO","WARNING","ERROR","CRITICAL"] | Literal[0, 10, 20, 30, 40, 50], optional
        The logging level to use.
    name : str, optional
        The name of the logger. Recommended to use `__name__`.
    log_format : str, optional
        The format string to use for the rich logger.
    traceback_show_locals : bool, optional
        Whether to show local variables in tracebacks.
    traceback_hide_dunder_sunder_locals : bool, optional
        Whether to hide dunder and sunder variables in tracebacks.
        Only applicable to unhandled errors.
    traceback_extra_lines : int, optional
        The number of extra lines to show in tracebacks.
    traceback_suppressed_modules : Iterable[ModuleType], optional
        The modules to suppress in tracebacks (e.g., pandas).
    logging_basic_config_extra_kwargs : Unpack[LoggingBasicConfigExtraKwargs], optional
        Extra keyword arguments to pass to
        [logging.basicConfig()](https://docs.python.org/3/library/logging.html#logging.basicConfig).

    Returns
    -------
    logging.Logger
        The configured rich logger.

    Raises
    ------
    TypeError
        If additional_handlers is not a logging.Handler,
        Iterable[logging.Handler], or None.

    Examples
    --------
    === "Python"
        ``` python linenums="1"
        import logging
        from get_rich_logger import get_rich_logger

        logger: logging.Logger = get_rich_logger(
            level="DEBUG",
            name=__name__,
            traceback_show_locals=True,
            traceback_extra_lines=10,
            traceback_suppressed_modules=(),
        )

        logging.debug("This is a rich debug message!")  # (1)

        1 / 0  # (2)
        ```

        1.  Logs will be colored and formatted with rich.
        2.  Unhandled errors will have rich traceback.

    """

    # install rich traceback for unhandled exceptions
    traceback.install(
        extra_lines=traceback_extra_lines,
        theme="monokai",
        show_locals=traceback_show_locals,
        locals_hide_dunder=traceback_hide_dunder_sunder_locals,
        locals_hide_sunder=traceback_hide_dunder_sunder_locals,
        suppress=traceback_suppressed_modules,
    )

    # configure the rich handler
    rich_handler: logging.Handler = RichHandler(
        level=logging.getLevelName(level),
        omit_repeated_times=False,
        rich_tracebacks=True,
        tracebacks_extra_lines=traceback_extra_lines,
        tracebacks_theme="monokai",
        tracebacks_word_wrap=False,
        tracebacks_show_locals=traceback_show_locals,
        tracebacks_suppress=traceback_suppressed_modules,
        log_time_format="[%Y-%m-%d %H:%M:%S] ",
    )

    # configure the logger
    logging.basicConfig(
        level=logging.getLevelName(level),
        format=log_format,
        handlers=[rich_handler],
        **logging_basic_config_extra_kwargs,
    )

    # return the rich logger
    return logging.getLogger(name)