Log

This module provides a custom Logger class for logging messages with additional information.

The Logger class provides static methods for logging messages at different levels (INFO, DEBUG, WARNING, ERROR, CRITICAL). Each log message includes the current time, file name, function name, and line number.

MAIN_DIR module-attribute

MAIN_DIR = dirname(dirname(dirname(abspath(__file__))))

timestamp module-attribute

timestamp = strftime('%Y-%m-%d_%H-%M-%S')

Logger

A custom Logger class for logging messages with additional information.

This Logger provides static methods for logging messages at different levels (INFO, DEBUG, WARNING, ERROR, CRITICAL). Each log message includes the current time, file name, function name, and line number.

CRITICAL staticmethod

CRITICAL(message: str) -> None

Logs a critical message.

PARAMETER	DESCRIPTION
message	The message to log. TYPE: str

Source code in AnilistMangaUpdater/Utils/log.py

@staticmethod
def CRITICAL(message: str) -> None:
    """
    Logs a critical message.

    Parameters:
        message (str): The message to log.
    """
    Logger.log(message, logging.CRITICAL)

DEBUG staticmethod

DEBUG(message: str) -> None

Logs a debug message.

PARAMETER	DESCRIPTION
message	The message to log. TYPE: str

Source code in AnilistMangaUpdater/Utils/log.py

@staticmethod
def DEBUG(message: str) -> None:
    """
    Logs a debug message.

    Parameters:
        message (str): The message to log.
    """
    Logger.log(message, logging.DEBUG)

ERROR staticmethod

ERROR(message: str) -> None

Logs an error message.

PARAMETER	DESCRIPTION
message	The message to log. TYPE: str

Source code in AnilistMangaUpdater/Utils/log.py

@staticmethod
def ERROR(message: str) -> None:
    """
    Logs an error message.

    Parameters:
        message (str): The message to log.
    """
    Logger.log(message, logging.ERROR)

INFO staticmethod

INFO(message: str) -> None

Logs an informational message.

PARAMETER	DESCRIPTION
message	The message to log. TYPE: str

Source code in AnilistMangaUpdater/Utils/log.py

@staticmethod
def INFO(message: str) -> None:
    """
    Logs an informational message.

    Parameters:
        message (str): The message to log.
    """
    Logger.log(message, logging.INFO)

WARNING staticmethod

WARNING(message: str) -> None

Logs a warning message.

Parameters: message (str): The message to log.

Source code in AnilistMangaUpdater/Utils/log.py

@staticmethod
def WARNING(message: str) -> None:
    """
    Logs a warning message.

    Parameters:
    message (str): The message to log.
    """
    Logger.log(message, logging.WARNING)

log staticmethod

log(message: str, level: int) -> None

Logs a message with the current time, file name, function name, and line number.

PARAMETER	DESCRIPTION
message	The message to log. TYPE: str
level	The logging level of the message (e.g., logging.INFO, logging.DEBUG). TYPE: int

Source code in AnilistMangaUpdater/Utils/log.py

@staticmethod
def log(message: str, level: int) -> None:
    """
    Logs a message with the current time, file name, function name, and line number.

    Parameters:
        message (str): The message to log.
        level (int): The logging level of the message (e.g., logging.INFO, logging.DEBUG).
    """
    # Get the current frame
    frame = inspect.currentframe()
    for _ in range(3):
        if frame is not None:
            frame = frame.f_back

    if frame is not None:
        func = frame.f_code

        # Prepare the log message
        log_message = (
            f"Level: {logging.getLevelName(level)}, "
            f"File: ..\\{os.path.relpath(func.co_filename, start=MAIN_DIR)}, "
            f"Function: {func.co_name}, Line: {frame.f_lineno}, "
            f"Message: {message}"
        )

        # Log the message at the appropriate level
        logging.log(level, log_message)
    else:
        logging.error("Error: Could not get the current frame.")

manage_log_files staticmethod

manage_log_files(max_logs: int) -> None

Manages the number of log files in the logs directory.

PARAMETER	DESCRIPTION
max_logs	The maximum number of log files to keep. TYPE: int

Source code in AnilistMangaUpdater/Utils/log.py

@staticmethod
def manage_log_files(max_logs: int) -> None:
    """
    Manages the number of log files in the logs directory.

    Parameters:
        max_logs (int): The maximum number of log files to keep.
    """
    log_files = glob.glob("logs/*.log")
    log_files.sort(key=os.path.getctime)

    while len(log_files) > max_logs:
        os.remove(log_files.pop(0))

setup staticmethod

setup(max_logs: int = 15) -> None

Sets up the logger to print to both the terminal and a file.

PARAMETER	DESCRIPTION
max_logs	The maximum number of log files to keep. TYPE: int DEFAULT: 15

Source code in AnilistMangaUpdater/Utils/log.py

@staticmethod
def setup(max_logs: int = 15) -> None:
    """
    Sets up the logger to print to both the terminal and a file.

    Parameters:
        max_logs (int): The maximum number of log files to keep.
    """
    handlers: List[Handler] = [
        logging.FileHandler("logs/latest.log", encoding="utf-8"),
        logging.StreamHandler(stream=sys.stdout),
    ]
    logging.basicConfig(level=logging.DEBUG, format="%(asctime)s, %(message)s", handlers=handlers)

    logging.getLogger().handlers = handlers
    Logger.manage_log_files(max_logs)