custom_logger.py

# MIT License
#
# Copyright (c) 2024 Red Hat, Inc.

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

import logging
from colorama import Fore, Style


class ColoredFormatter(logging.Formatter):
    """
    Colored formatter for the logger.
    """

    COLORS = {
        "DEBUG": Fore.LIGHTBLUE_EX,
        "INFO": Fore.GREEN,
        "WARNING": Fore.YELLOW,
        "ERROR": Fore.RED,
        "CRITICAL": Fore.RED + Style.BRIGHT,
    }
    FORMAT_INFO = "%(message)s"
    FORMAT_DEBUG = "%(levelname)s - %(name)s - %(message)s"

    FORMATS = {
        logging.DEBUG: COLORS["DEBUG"] + FORMAT_DEBUG + Style.RESET_ALL,
        logging.INFO: COLORS["INFO"] + FORMAT_INFO + Style.RESET_ALL,
        logging.WARNING: COLORS["WARNING"] + FORMAT_INFO + Style.RESET_ALL,
        logging.ERROR: COLORS["ERROR"] + FORMAT_DEBUG + Style.RESET_ALL,
        logging.CRITICAL: COLORS["CRITICAL"] + FORMAT_DEBUG + Style.RESET_ALL,
    }

    def format(self, record):
        log_fmt = self.FORMATS.get(record.levelno)
        formatter = logging.Formatter(log_fmt)
        return formatter.format(record)


def setup_logger(logger_name: str = "eol_checker", level=logging.INFO):
    """
    Setup the logger.
    Args:
        logger_name: The name of the logger.
        level: The level of the logger.
    Returns:
        The logger.
    """
    logger = logging.getLogger(logger_name)

    # Check if handlers already exist (to avoid duplicate logs)
    if not logger.handlers:
        # Create a console handler
        console_handler = logging.StreamHandler()
        console_handler.setLevel(level)
        console_handler.setFormatter(ColoredFormatter())

        logger.addHandler(console_handler)
        logger.setLevel(level=logging.DEBUG)

    return logger