mirror of
https://github.com/jxxghp/MoviePilot.git
synced 2026-03-20 12:08:09 +08:00
150 lines
5.8 KiB
Python
150 lines
5.8 KiB
Python
import functools
|
||
import threading
|
||
import time
|
||
from typing import Any, Callable, Optional, Tuple
|
||
|
||
from app.log import logger
|
||
from app.schemas import ImmediateException, RateLimitExceededException, LimitException
|
||
|
||
|
||
def retry(ExceptionToCheck: Any,
|
||
tries: int = 3, delay: int = 3, backoff: int = 2, logger: Any = None):
|
||
"""
|
||
:param ExceptionToCheck: 需要捕获的异常
|
||
:param tries: 重试次数
|
||
:param delay: 延迟时间
|
||
:param backoff: 延迟倍数
|
||
:param logger: 日志对象
|
||
"""
|
||
|
||
def deco_retry(f):
|
||
def f_retry(*args, **kwargs):
|
||
mtries, mdelay = tries, delay
|
||
while mtries > 1:
|
||
try:
|
||
return f(*args, **kwargs)
|
||
except ImmediateException:
|
||
raise
|
||
except ExceptionToCheck as e:
|
||
msg = f"{str(e)}, {mdelay} 秒后重试 ..."
|
||
if logger:
|
||
logger.warn(msg)
|
||
else:
|
||
print(msg)
|
||
time.sleep(mdelay)
|
||
mtries -= 1
|
||
mdelay *= backoff
|
||
return f(*args, **kwargs)
|
||
|
||
return f_retry
|
||
|
||
return deco_retry
|
||
|
||
|
||
class RateLimiter:
|
||
"""
|
||
限流器类,用于处理调用的限流逻辑
|
||
通过增加等待时间逐步减少调用的频率,以避免触发限流
|
||
"""
|
||
|
||
def __init__(self, base_wait: int = 60, max_wait: int = 600, backoff_factor: float = 2.0, source: str = ""):
|
||
"""
|
||
初始化 RateLimiter 实例
|
||
:param base_wait: 基础等待时间(秒),默认值为 60 秒(1 分钟)
|
||
:param max_wait: 最大等待时间(秒),默认值为 600 秒(10 分钟)
|
||
:param backoff_factor: 等待时间的递增倍数,默认值为 2.0,表示指数退避
|
||
:param source: 业务来源或上下文信息,默认值为 ""
|
||
"""
|
||
self.next_allowed_time = 0
|
||
self.current_wait = base_wait
|
||
self.base_wait = base_wait
|
||
self.max_wait = max_wait
|
||
self.backoff_factor = backoff_factor
|
||
self.source = source
|
||
self.lock = threading.Lock()
|
||
|
||
def can_call(self) -> Tuple[bool, str]:
|
||
"""
|
||
检查是否可以进行下一次调用
|
||
:return: 如果当前时间超过下一次允许调用的时间,返回 True;否则返回 False
|
||
"""
|
||
current_time = time.time()
|
||
with self.lock:
|
||
if current_time >= self.next_allowed_time:
|
||
return True, ""
|
||
wait_time = self.next_allowed_time - current_time
|
||
message = self.format_log(f"限流期间,跳过调用,将在 {wait_time:.2f} 秒后允许继续调用")
|
||
logger.info(message)
|
||
return False, message
|
||
|
||
def reset(self):
|
||
"""
|
||
重置等待时间
|
||
当调用成功时调用此方法,重置当前等待时间为基础等待时间
|
||
"""
|
||
with self.lock:
|
||
if self.next_allowed_time != 0 or self.current_wait > self.base_wait:
|
||
logger.info(self.format_log(f"调用成功,重置限流等待时间为{self.base_wait}秒"))
|
||
self.next_allowed_time = 0
|
||
self.current_wait = self.base_wait
|
||
|
||
def trigger_limit(self):
|
||
"""
|
||
触发限流
|
||
当触发限流异常时调用此方法,增加下一次允许调用的时间并更新当前等待时间
|
||
"""
|
||
current_time = time.time()
|
||
with self.lock:
|
||
self.next_allowed_time = current_time + self.current_wait
|
||
logger.warn(self.format_log(f"触发限流,将在 {self.current_wait} 秒后允许继续调用"))
|
||
self.current_wait = min(self.current_wait * self.backoff_factor, self.max_wait)
|
||
|
||
def format_log(self, message: str) -> str:
|
||
"""
|
||
格式化日志消息
|
||
:param message: 日志内容
|
||
:return: 格式化后的日志消息
|
||
"""
|
||
return f"[{self.source}] {message}" if self.source else message
|
||
|
||
|
||
def rate_limit_handler(base_wait: int = 60, max_wait: int = 600, backoff_factor: float = 2.0,
|
||
raise_on_limit: bool = True, source: str = "") -> Callable:
|
||
"""
|
||
装饰器,用于处理限流逻辑,支持动态控制是否在限流时抛出异常
|
||
:param base_wait: 基础等待时间(秒),默认值为 60 秒(1 分钟)
|
||
:param max_wait: 最大等待时间(秒),默认值为 600 秒(10 分钟)
|
||
:param backoff_factor: 等待时间的递增倍数,默认值为 2.0
|
||
:param raise_on_limit: 控制默认情况下是否在限流时抛出异常,默认为 True(限流时抛出异常)。
|
||
如果在函数调用时传入 `raise_exception` 参数,则以传入值为准。
|
||
:param source: 业务来源或上下文信息,默认为 ""
|
||
:return: 装饰器函数
|
||
"""
|
||
rate_limiter = RateLimiter(base_wait, max_wait, backoff_factor, source)
|
||
|
||
def decorator(func: Callable) -> Callable:
|
||
@functools.wraps(func)
|
||
def wrapper(*args, **kwargs) -> Optional[Any]:
|
||
# 动态检查是否传入了 raise_exception,否则使用默认的 raise_on_limit
|
||
raise_exception = kwargs.get("raise_exception", raise_on_limit)
|
||
can_call, message = rate_limiter.can_call()
|
||
if not can_call:
|
||
if raise_exception:
|
||
raise RateLimitExceededException(message)
|
||
return None
|
||
|
||
try:
|
||
result = func(*args, **kwargs)
|
||
rate_limiter.reset()
|
||
return result
|
||
except LimitException as e:
|
||
rate_limiter.trigger_limit()
|
||
logger.error(rate_limiter.format_log(f"触发限流:{str(e)}"))
|
||
if raise_exception:
|
||
raise e
|
||
return None
|
||
|
||
return wrapper
|
||
|
||
return decorator
|