▍▞ PJ logging

Simple logging with rich Panels and jsonl (or plain .log) files

Basic Usage

set_logger arguments, with types and defaults:

def set_logger(
    name: str | None = None,
    *,
    jsonl_log_file_path: pathlib.Path | str | None = None,
    jsonl_log_file_size: int = 100_000,
    jsonl_log_backup_count: int = 3,
    rich_panel_log: bool = False,
) -> logging.Logger: ...

Example, with rich's Panels only

import pj_logging

logger = pj_logging.set_logger(rich_panel_log=True)


...


logger.info("this is an info log with a rich Panel in the terminal")

Advanced usage

The set_logger function uses the logging RotatingFileHandler (docs) for the output file

For different needs, the JsonlFormatter can be assigned to a different handler

The PanelHandler can also be imported and added to an existing logger.

With this approach, it's possible to change values of the class' attributes before adding the handler to the logger.

class PanelHandler(logging.Handler):
    colors: t.ClassVar[dict[str, str]] = {
        "Debug": "blue",
        "Info": "green",
        "Warning": "yellow",
        "Error": "red",
        "Critical": "red",
    }
    fallback_color: str = "white"
    title_align: rich.align.AlignMethod = "left"
    show_error_names: bool = True