custom_logger.py

import logging
from logging.handlers import TimedRotatingFileHandler

custom_formatter = logging.Formatter(
    "{asctime} {levelname:<8} - ({funcName:20.20}) {message}",
    datefmt="%Y-%m-%d %H:%M:%S",
    style="{",
)


def dummy_log():
    """
    Dummy logger, mostly for tests.
    """

    class DummyLogger:
        def info(self, text):
            print(text)

        def warning(self, text):
            print(text)

        def debug(self, text):
            print(text)

        def error(self, text):
            print(text)

    return DummyLogger()


def set_log_handler(
    logger: logging.Logger,
    path: str,
    interval: int,
    nlogs: int,
    enable_debug: bool = False,
):
    """Configures the logger given with a formatter and a handler"""
    try:
        # add a rotating handler
        formatter = custom_formatter
        handler = TimedRotatingFileHandler(
            path, when="h", interval=interval, backupCount=nlogs
        )
        handler.setFormatter(formatter)
        handler.setLevel(logging.DEBUG if enable_debug else logging.INFO)
        logger.setLevel(logging.DEBUG if enable_debug else logging.INFO)

        logger.addHandler(handler)
        logger.info(f"Logging started in '{path}'")
    except Exception as e:
        return dummy_log()