GitHub

WithRateLimiter

API reference for WithRateLimiter.

with_rate_limiter(key=, limit=, window=, ...) gives a function for .pipe that runs an effect under that consume (its options are RateLimiterService.consume's).

Functions

__init__

__init__(limiter) -> None
ParameterTypeDescription
limiterRateLimiterService
def __init__(self, limiter: RateLimiterService) -> None:
    self._limiter = limiter

__call__

__call__(*, key, limit, window, algorithm='fixed-window', on_exceeded='fail', tokens=1) -> Limit
ParameterTypeDescription
keystr
limitfloat
windowDurationInput
algorithmAlgorithm = 'fixed-window'
on_exceededOnExceeded = 'fail'
tokensfloat = 1

Returns Limit

def __call__(
    self,
    *,
    key: str,
    limit: float,
    window: DurationInput,
    algorithm: Algorithm = "fixed-window",
    on_exceeded: OnExceeded = "fail",
    tokens: float = 1,
) -> Limit:
    return Limit(
        self._limiter.consume(
            key=key,
            limit=limit,
            window=window,
            algorithm=algorithm,
            on_exceeded=on_exceeded,
            tokens=tokens,
        )
    )