pytilpack.ratelimit

pytilpack.ratelimit

レートリミッター。

pytilpack.httpxの429リトライ、pytilpack.functools.retry、 pytilpack.quart.set_max_concurrencyとは独立して リクエスト送信前にレートを制御するトークンバケット実装。

RateLimiter(rate, per=1.0)

トークンバケット方式のレートリミッター。

例：

毎秒10リクエストに制限する::

limiter = RateLimiter(rate=10, per=1.0)
async with limiter:
    await make_request()

初期化。

引数：

名前	タイプ	デスクリプション	デフォルト
rate	float	期間あたりの許可数。	必須
per	float	期間（秒）。	1.0

ソースコード位置： pytilpack/ratelimit.py

def __init__(self, rate: float, per: float = 1.0) -> None:
    """初期化。

    Args:
        rate: 期間あたりの許可数。
        per: 期間（秒）。
    """
    self._max_tokens = rate
    self._tokens = rate  # 満タンで開始
    self._refill_rate = rate / per  # トークン/秒
    self._last_refill = time.monotonic()
    self._lock = asyncio.Lock()

acquire() async

トークンを1つ消費する。不足時は補充されるまで待機。

ソースコード位置： pytilpack/ratelimit.py

async def acquire(self) -> None:
    """トークンを1つ消費する。不足時は補充されるまで待機。"""
    while True:
        async with self._lock:
            self._refill()
            if self._tokens >= 1.0:
                self._tokens -= 1.0
                return
            # 1トークン分の待機時間を算出
            wait_time = (1.0 - self._tokens) / self._refill_rate
        # ロック外でスリープし、他のコルーチンをブロックしない
        await asyncio.sleep(wait_time)