decorators Namespace Reference

Functions
Callable	IgnoreWarnings (Callable func)
Callable	ReTry (int attempts_amount=retry_config["attempts_amount"], type[Exception] exception_to_check=Exception, float sleep_time=retry_config["sleep_time"])

Variables
Config	retry_config = config["Utils"]["ReTry"]

Detailed Description

Utils/decorators.py

Этот модуль содержит декораторы для обработки исключений и игнорирования
предупреждений.

Function Documentation

IgnoreWarnings()

Callable decorators.IgnoreWarnings

(

Callable

func

)

Игнорирует предупреждения RuntimeWarning и UserWarning.

Args:
    func (Callable): декорируемая функция.

Returns:
    Callable: декорируемая функция.

def IgnoreWarnings(func: Callable) -> Callable:
  """
  Игнорирует предупреждения RuntimeWarning и UserWarning.
 
  Args:
      func (Callable): декорируемая функция.
 
  Returns:
      Callable: декорируемая функция.
  """
 
  @wraps(func)
  def Wrapper(*args, **kwargs):
    # перехватываем предупреждения.
    with warnings.catch_warnings():
      # игнорируем RuntimeWarning.
      warnings.simplefilter("ignore", RuntimeWarning)
      # игнорируем UserWarning.
      warnings.simplefilter("ignore", UserWarning)
 
      # вызываем декорируемую функцию.
      return func(*args, **kwargs)
 
  return Wrapper
 
 
# конфигурация для повторных попыток.

ReTry()

Callable decorators.ReTry	(	int	attempts_amount = retry_config["attempts_amount"],
		type[Exception]	exception_to_check = Exception,
		float	sleep_time = retry_config["sleep_time"] )

Повторяет попытки выполнения функции в случае возникновения исключения.

Если `attempts_amount == 1`, просто оборачивает декорируемую функцию в
`try-except`.

Args:
    attempts_amount (int, optional): количество попыток.
                                     Defaults to [берется из конфигурации].
    exception_to_check (type[Exception], optional): тип исключения для
                                                    перехвата. Defaults to Exception.
    sleep_time (int, optional): время ожидания между попытками (в секундах).
                                Defaults to [берется из конфигурации].

Returns:
    Callable: декорируемая функция.

          ) -> Callable:
  """
  Повторяет попытки выполнения функции в случае возникновения исключения.
 
  Если `attempts_amount == 1`, просто оборачивает декорируемую функцию в
  `try-except`.
 
  Args:
      attempts_amount (int, optional): количество попыток.
                                       Defaults to [берется из конфигурации].
      exception_to_check (type[Exception], optional): тип исключения для
                                                      перехвата. Defaults to Exception.
      sleep_time (int, optional): время ожидания между попытками (в секундах).
                                  Defaults to [берется из конфигурации].
 
  Returns:
      Callable: декорируемая функция.
  """
 
  def Decorate(func: Callable) -> Callable:
    """Декорирует функцию."""
 
    @wraps(func)
    def Wrapper(*args, **kwargs):
      # итерируемся по количеству попыток.
      for attempt in range(1, attempts_amount + 1):
        try:
          # пытаемся выполнить функцию.
          return func(*args, **kwargs)
 
        # если возникло исключение.
        except exception_to_check as exception:
          # логируем исключение.
          v_logger.LogException(exception)
 
          # если это не последняя попытка.
          if attempt < attempts_amount:
            v_logger.warning(f"Attempt: {attempt}. Retrying.")
            # ждем перед следующей попыткой.
            time.sleep(sleep_time)
 
      # если все попытки не удались.
      if attempts_amount != 1:
        v_logger.error("All attempts failed!")
      # если количество попыток равно 1,
      # значит в функции просто отлавливается исключение.
 
      return None
 
    # возвращаем функцию-обертку.
    return Wrapper
  # возвращаем декоратор.
  return Decorate

Variable Documentation

retry_config

Config decorators.retry_config = config["Utils"]["ReTry"]