verbose_logger.VerboseLogger Class Reference

Collaboration diagram for verbose_logger.VerboseLogger:

Public Member Functions
	__init__ (self, Logger logger, LogMode log_mode, int message_ljust, str exceptions_file, TextIO|TextIOWrapper standard_output=sys.stdout)
Any	__getattr__ (self, str name)
	FromConfig (cls)
	Log (self, str level, str message, LogMode log_mode=LogMode.RETICENTLY)
	LogException (self, Exception exception)
	RestoreFormat (self, int index)
int	UpdateFormat (self, str logger_label, str logger_color)

Private Member Functions
	__Configure (self, TextIO|Any|None output=None)
Callable	__LogMethod (self, str level)

Private Attributes
	__colors
	__exceptions_file
	__format
	__labels
	__log_mode
	__logger
	__message_ljust
	__standard_output

Static Private Attributes
list	__colors = []
str	__exceptions_file
Callable	__format [[dict], str]
list	__labels = []
LogMode	__log_mode
Logger	__logger
int	__message_ljust
TextIOWrapper	__standard_output | TextIO | Any

Detailed Description

Реализует расширенное логирование с возможностью настройки уровня
детализации, формата сообщений и записи исключений в файл.

Constructor & Destructor Documentation

__init__()

verbose_logger.VerboseLogger.__init__	(		self,
		Logger	logger,
		LogMode	log_mode,
		int	message_ljust,
		str	exceptions_file,
		TextIO | TextIOWrapper	standard_output = sys.stdout )

Инициализирует класс VerboseLogger.

Args:
    logger (Logger): объект логгера loguru.
    log_mode (LogMode): режим логирования (RETICENTLY или VERBOSELY).
    message_ljust (int): ширина поля для выравнивания сообщений.
    exceptions_file (str): путь к файлу для записи исключений.
    standard_output (TextIO | TextIOWrapper, optional): вывод.

               standard_output: TextIO | TextIOWrapper = sys.stdout):
    """
    Инициализирует класс VerboseLogger.
 
    Args:
        logger (Logger): объект логгера loguru.
        log_mode (LogMode): режим логирования (RETICENTLY или VERBOSELY).
        message_ljust (int): ширина поля для выравнивания сообщений.
        exceptions_file (str): путь к файлу для записи исключений.
        standard_output (TextIO | TextIOWrapper, optional): вывод.
    """
 
    self.__logger = logger
    self.__log_mode = log_mode
 
    self.__message_ljust = message_ljust
    self.__exceptions_file = exceptions_file
 
    self.__standard_output = standard_output
 

Member Function Documentation

__Configure()

verbose_logger.VerboseLogger.__Configure ( self, TextIO | Any | None output = None )

private

Настраивает вывод логгера.

Args:
    output (TextIO | Any | None, optional): поток вывода.

  def __Configure(self,
                  output: TextIO | Any | None = None):
    """
    Настраивает вывод логгера.
 
    Args:
        output (TextIO | Any | None, optional): поток вывода.
    """
 
    # если вывод не задан, используем стандартный.
    if output is None:
      output = self.__standard_output
 
    # удаляем предыдущие обработчики.
    self.__logger.remove()
    # добавляем новый обработчик с заданным форматом и выводом.
    self.__logger.add(sink=output,
                      format=self.__format)

Here is the caller graph for this function:

__getattr__()

Any verbose_logger.VerboseLogger.__getattr__	(		self,
		str	name )

Перехватывает обращение к атрибутам класса.

Если это методы логирования (debug, info и т.д.), возвращает функцию-
обертку для логирования. В противном случае, возвращает атрибут из
базового логгера loguru.

Args:
    name (str): имя атрибута.

Returns:
    Any: атрибут или функция-обертка для логирования.

  def __getattr__(self,
                  name: str) -> Any:
    """
    Перехватывает обращение к атрибутам класса.
 
    Если это методы логирования (debug, info и т.д.), возвращает функцию-
    обертку для логирования. В противном случае, возвращает атрибут из
    базового логгера loguru.
 
    Args:
        name (str): имя атрибута.
 
    Returns:
        Any: атрибут или функция-обертка для логирования.
    """
 
    # проверяем, является ли имя одним из уровней логирования.
    if name in [string.lower() for string in
                loguru.logger._core.levels.keys()]:  # type: ignore
      # возвращаем обертку для метода логирования.
      return self.__LogMethod(name)
 
    # иначе возвращаем атрибут из базового логгера.
    else:  # другие методы loguru.logger
      return getattr(self.__logger, name)
 
 

Here is the call graph for this function:

__LogMethod()

Callable verbose_logger.VerboseLogger.__LogMethod ( self, str level )

private

Создает функцию-обертку для логирования сообщений с определенным уровнем.

Args:
    level (str): уровень логирования.

Returns:
    Callable: функция-обертка для логирования.

  def __LogMethod(self,
                  level: str) -> Callable:
    """
    Создает функцию-обертку для логирования сообщений с определенным уровнем.
 
    Args:
        level (str): уровень логирования.
 
    Returns:
        Callable: функция-обертка для логирования.
    """
 
    # получаем имя уровня в верхнем регистре.
    level_name = level.upper()
 
    def Wrapper(message: str = f"{"-" * (self.__message_ljust - 1)}",
                log_mode: LogMode = LogMode.RETICENTLY):
      # в том случае, если сообщение состоит из одного символа, превращаем в полосу.
      if len(message) == 1:
        message = f"{f"{message}" * (self.__message_ljust - 1)}"
 
      # вызываем метод Log с заданным уровнем и сообщением.
      self.Log(level_name, message, log_mode)
 
    # возвращаем функцию-обертку.
    return Wrapper

Here is the call graph for this function:

Here is the caller graph for this function:

FromConfig()

verbose_logger.VerboseLogger.FromConfig

(

cls

)

Создает экземпляр VerboseLogger на основе конфигурации.

Returns:
    VerboseLogger: экземпляр класса.

  def FromConfig(cls):
    """
    Создает экземпляр VerboseLogger на основе конфигурации.
 
    Returns:
        VerboseLogger: экземпляр класса.
    """
 
    # получаем конфигурацию для verbose логгера.
    v_logger_config = config["Utils"]["VerboseLogger"]
 
    # создаем и возвращаем экземпляр класса.
    return cls(loguru.logger,
               LogMode.VERBOSELY if v_logger_config["verbose_print"]
               else LogMode.RETICENTLY,
               v_logger_config["message_ljust"],
               v_logger_config["exceptions_file"],
               v_logger_config["exceptions_file"] if
               v_logger_config["output_to_exceptions_file"]
               else sys.stdout)
 

Log()

verbose_logger.VerboseLogger.Log	(		self,
		str	level,
		str	message,
		LogMode	log_mode = LogMode.RETICENTLY )

Логирует сообщение с указанным уровнем.

Args:
    level (str): уровень логирования.
    message (str): сообщение для логирования.
    log_mode (LogMode, optional): режим логирования.

Raises:
    NotImplementedError: если не установлен формат логгера.

          message: str,
          log_mode: LogMode = LogMode.RETICENTLY):
    """
    Логирует сообщение с указанным уровнем.
 
    Args:
        level (str): уровень логирования.
        message (str): сообщение для логирования.
        log_mode (LogMode, optional): режим логирования.
 
    Raises:
        NotImplementedError: если не установлен формат логгера.
    """
 
    # проверяем, установлен ли формат логгера.
    if len(self.__labels) == 0:
      raise NotImplementedError(
          "VerboseLogger: logger format is not set. Call "
          "'logger.UpdateFormat' first!")
 
    # логируем сообщение, если режим логирования соответствует.
    if self.__log_mode == LogMode.VERBOSELY or\
            log_mode == LogMode.RETICENTLY:
      self.__logger.log(level, message)

Here is the caller graph for this function:

LogException()

verbose_logger.VerboseLogger.LogException	(		self,
		Exception	exception )

Логирует исключение в консоль и записываем его в файл.

Args:
    exception (Exception): объект исключения.

Raises:
    NotImplementedError: если не установлен формат логгера.

                   exception: Exception):
    """
    Логирует исключение в консоль и записываем его в файл.
 
    Args:
        exception (Exception): объект исключения.
 
    Raises:
        NotImplementedError: если не установлен формат логгера.
    """
 
    # проверяем, установлен ли формат логгера.
    if len(self.__labels) == 0:
      raise NotImplementedError(
          "VerboseLogger: logger format is not set. Call "
          "'logger.UpdateFormat' first.")
 
    # логируем исключение в консоль.
    self.__logger.error(f"{exception}")
 
    try:
      # настраиваем логгер для записи в файл исключений.
      self.__Configure(self.__exceptions_file)
 
      # логируем traceback в файл исключений.
      self.__logger.error(
          f"{re.sub(r'"(.*?)\",\s+line\s+(\d+)',
                    r'\1:\2', traceback.format_exc())}")
 
    # если не удалось записать исключение в файл.
    except Exception as exception:
      self.__logger.error(
          "VerboseLogger: failed to write exception to file: "
          f"{exception}.")
 
    # в любом случае восстанавливаем исходную конфигурацию логгера.
    finally:
      self.__Configure()

Here is the call graph for this function:

RestoreFormat()

verbose_logger.VerboseLogger.RestoreFormat	(		self,
		int	index )

Восстанавливает формат логгера по индексу.

Args:
    index (int): индекс одного из предыдущих форматов.

Raises:
    NotImplementedError: если не установлен формат логгера.
    IndexError: если index выходит за границы.

  def RestoreFormat(self, index: int):
    """
    Восстанавливает формат логгера по индексу.
 
    Args:
        index (int): индекс одного из предыдущих форматов.
 
    Raises:
        NotImplementedError: если не установлен формат логгера.
        IndexError: если index выходит за границы.
    """
 
    # проверяем, установлен ли формат логгера.
    if len(self.__labels) == 0:
      raise NotImplementedError(
          "VerboseLogger: logger format is not set. Call "
          "'logger.UpdateFormat' first.")
 
    # проверяем, не выходит ли index за границы.
    if index >= len(self.__labels):
      raise IndexError(
          f"VerboseLogger: RestoreFormat: index ({index}) is out of "
          f"range [0, {len(self.__labels) - 1}].")
 
    # если текущий формат уже установлен, предупреждаем и выходим.
    if index == len(self.__labels) - 1:
      self.__logger.warning("Current format is already set.")
      return
 
    # задаем формат вывода.
    self.__format = lambda record: "[{time:DD.MM.YYYY HH:mm:ss}] " +\
        f"<{self.__colors[index]}>{self.__labels[index]}:" \
        f"</{self.__colors[index]}> " +\
        f"{record['message']} ".ljust(self.__message_ljust) +\
        f"[<level>{record['level']}</level>]\n"
 
    # обрезаем списки заголовков и цветов.
    self.__labels = self.__labels[:index + 1]
    self.__colors = self.__colors[:index + 1]
 
    # настраиваем логгер.
    self.__Configure()
 

UpdateFormat()

int verbose_logger.VerboseLogger.UpdateFormat	(		self,
		str	logger_label,
		str	logger_color )

Обновляет формат вывода логирования.

Args:
    logger_label (str): текст заголовка для логирования.
    logger_color (str): цвет заголовка для логирования.

Returns:
    int: индекс текущего формата.

                   logger_color: str) -> int:
    """
    Обновляет формат вывода логирования.
 
    Args:
        logger_label (str): текст заголовка для логирования.
        logger_color (str): цвет заголовка для логирования.
 
    Returns:
        int: индекс текущего формата.
    """
 
    # задаем формат вывода.
    self.__format = lambda record: "[{time:DD.MM.YYYY HH:mm:ss}] " +\
        f"<{logger_color}>{logger_label}:</{logger_color}> " +\
        f"{record['message']} ".ljust(self.__message_ljust) +\
        f"[<level>{record['level']}</level>]\n"
 
    # добавляем заголовок и цвет в списки.
    self.__labels.append(logger_label)
    self.__colors.append(logger_color)
 
    # настраиваем логгер.
    self.__Configure()
 
    return len(self.__labels) - 1
 

Member Data Documentation

__colors [1/2]

list verbose_logger.VerboseLogger.__colors = []

staticprivate

__colors [2/2]

verbose_logger.VerboseLogger.__colors

private

__exceptions_file [1/2]

str verbose_logger.VerboseLogger.__exceptions_file

staticprivate

__exceptions_file [2/2]

verbose_logger.VerboseLogger.__exceptions_file

private

__format [1/2]

Callable verbose_logger.VerboseLogger.__format [[dict], str]

staticprivate

__format [2/2]

verbose_logger.VerboseLogger.__format

private

__labels [1/2]

list verbose_logger.VerboseLogger.__labels = []

staticprivate

__labels [2/2]

verbose_logger.VerboseLogger.__labels

private

__log_mode [1/2]

LogMode verbose_logger.VerboseLogger.__log_mode

staticprivate

__log_mode [2/2]

verbose_logger.VerboseLogger.__log_mode

private

__logger [1/2]

Logger verbose_logger.VerboseLogger.__logger

staticprivate

__logger [2/2]

verbose_logger.VerboseLogger.__logger

private

__message_ljust [1/2]

int verbose_logger.VerboseLogger.__message_ljust

staticprivate

__message_ljust [2/2]

verbose_logger.VerboseLogger.__message_ljust

private

__standard_output [1/2]

TextIOWrapper verbose_logger.VerboseLogger.__standard_output | TextIO | Any

staticprivate

__standard_output [2/2]

verbose_logger.VerboseLogger.__standard_output

private

---

The documentation for this class was generated from the following file:

• verbose_logger.py