pyrate_limiter.limiter module

Limiter class implementation

class pyrate_limiter.limiter.Limiter(argument, clock=<pyrate_limiter.clocks.TimeClock object>, raise_when_fail=True, max_delay=None, retry_until_max_delay=False, buffer_ms=50)

Bases: object

This class responsibility is to sum up all underlying logic and make working with async/sync functions easily

__init__(argument, clock=<pyrate_limiter.clocks.TimeClock object>, raise_when_fail=True, max_delay=None, retry_until_max_delay=False, buffer_ms=50)

Init Limiter using either a single bucket / multiple-bucket factory / single rate / rate list.

Parameters:

• argument (Union[BucketFactory, AbstractBucket, Rate, List[Rate]]) – The bucket or rate configuration.

• clock (AbstractClock, optional) – The clock instance to use for rate limiting. Defaults to TimeClock().

• raise_when_fail (bool, optional) – Whether to raise an exception when rate limiting fails. Defaults to True.

• max_delay (Optional[Union[int, Duration]], optional) – The maximum delay allowed for rate limiting.

• None. (Defaults to)

• retry_until_max_delay (bool, optional) – If True, retry operations until the maximum delay is reached. Useful for ensuring operations eventually succeed within the allowed delay window. Defaults to False.

as_decorator()

Use limiter decorator Use with both sync & async function

Return type:

Callable[[Callable[[Any], Tuple[str, int]]], Callable[[Callable[[Any], Any]], Callable[[Any], Any]]]

bucket_factory

buckets()

Get list of active buckets

Return type:

List[AbstractBucket]

buffer_ms

delay_or_raise(bucket, item)

On try_acquire failed, handle delay or raise error immediately

Return type:

Union[bool, Awaitable[bool]]

dispose(bucket)

Dispose/Remove a specific bucket, using bucket-id or bucket object as param

Return type:

bool

handle_bucket_put(bucket, item)

Putting item into bucket

Return type:

Union[bool, Awaitable[bool]]

lock

max_delay = None

raise_when_fail

retry_until_max_delay

try_acquire(name, weight=1)

Try acquiring an item with name & weight Return true on success, false on failure

Return type:

Union[bool, Awaitable[bool]]

async try_acquire_async(name, weight=1)

async version of try_acquire.

This uses a top level, thread-local async lock to ensure that the async loop doesn’t block

This does not make the entire code async: use an async bucket for that.

Return type:

bool

class pyrate_limiter.limiter.SingleBucketFactory(bucket, clock)

Bases: BucketFactory

Single-bucket factory for quick use with Limiter

bucket

clock

get(_)

Get the corresponding bucket to this item

Return type:

AbstractBucket

wrap_item(name, weight=1)

Add the current timestamp to the receiving item using any clock backend - Turn it into a RateItem - Can return either a coroutine or a RateItem instance

pyrate_limiter.limiter.combined_lock(locks, timeout_sec=None)

Acquires and releases multiple locks. Intended to be used in multiprocessing for a cross-process lock combined with in process thread RLocks