pbf.utils.Logging

  1import logging
  2import os
  3import re
  4from logging.handlers import TimedRotatingFileHandler
  5
  6try:
  7    from ..config import logs_level, logs_format, logs_directory
  8    from ..utils import Path
  9except ImportError:
 10    from pbf.config import logs_level, logs_format, logs_directory
 11    from pbf.utils import Path
 12
 13
 14class Logger:
 15    def __init__(self, name: str) -> None:
 16        """
 17        Initialize the Logger.
 18        :param name: str Logger name
 19        """
 20        self.file_handler = None
 21        self.name = name
 22        self.logger = logging.getLogger(name)
 23        self.logger.setLevel(logs_level)
 24        self.formatter = logging.Formatter(logs_format)
 25
 26        self.console_handler = logging.StreamHandler()
 27        self.console_handler.setLevel(logs_level)
 28        self.console_handler.setFormatter(self.formatter)
 29
 30        self.set_file(logs_directory)
 31
 32        self.logger.addHandler(self.console_handler)
 33
 34    def get_logger(self) -> logging.Logger:
 35        """
 36        Get the logger.
 37        :return: logging.Logger
 38        """
 39        return self.logger
 40
 41    def set_level(self, level: str) -> None:
 42        """
 43        Set the logger level.
 44        :param level: str level
 45        :return: None
 46        """
 47        self.logger.setLevel(level)
 48        self.console_handler.setLevel(level)
 49        self.file_handler.setLevel(level)
 50
 51    def set_format(self, format: str) -> None:
 52        """
 53        Set the logger format.
 54        :param format: str format
 55        :return: None
 56        """
 57        self.formatter = logging.Formatter(format)
 58        self.console_handler.setFormatter(self.formatter)
 59        self.file_handler.setFormatter(self.formatter)
 60
 61    def set_file(self, file: str) -> None:
 62        """
 63        Set the logger file.
 64        :param file: str file path
 65        :return: None
 66        """
 67        self.file_handler = TimedRotatingFileHandler(
 68            filename=os.path.join(Path.replace(file), "log"), when="MIDNIGHT", interval=1, backupCount=20
 69        )
 70        self.file_handler.suffix = "%Y-%m-%d.log"
 71        self.file_handler.extMatch = re.compile(r"^\d{4}-\d{2}-\d{2}.log$")
 72        self.file_handler.setFormatter(self.formatter)
 73        self.logger.addHandler(self.file_handler)
 74
 75    def info(self, message: str, *args, **kwargs) -> None:
 76        """
 77        Log the info message.
 78        :param message: str message
 79        :param args: *list
 80        :param kwargs: **dict
 81        :return: None
 82        """
 83        self.logger.info(message, *args, **kwargs)
 84
 85    def debug(self, message: str, *args, **kwargs) -> None:
 86        """
 87        Log the debug message.
 88        :param message: str message
 89        :param args: *list
 90        :param kwargs: **dict
 91        :return: None
 92        """
 93        self.logger.debug(message, *args, **kwargs)
 94
 95    def warning(self, message: str, *args, **kwargs) -> None:
 96        """
 97        Log the warning message.
 98        :param message: str message
 99        :param args: *list
100        :param kwargs: **dict
101        :return: None
102        """
103        self.logger.warning(message, *args, **kwargs)
104
105    def error(self, message: str, *args, **kwargs) -> None:
106        """
107        Log the error message.
108        :param message: str message
109        :param args: *list
110        :param kwargs: **dict
111        :return: None
112        """
113        self.logger.error(message, *args, **kwargs)
114
115    def critical(self, message: str, *args, **kwargs) -> None:
116        """
117        Log the critical message.
118        :param message: str message
119        :param args: *list
120        :param kwargs: **dict
121        :return: None
122        """
123        self.logger.critical(message, *args, **kwargs)
124
125
126if __name__ == "__main__":
127    logger = Logger("test")
128    logger.info("info")
129    logger.debug("debug")
130    logger.warning("warning")
131    logger.error("error")