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)#

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)#: Init Limiter using either a single bucket / multiple-bucket factory / single rate / rate list

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]]]

buckets()#

Get list of active buckets

delay_or_raise(bucket, item)#

On try_acquire failed, handle delay or raise error immediately

dispose(bucket)#

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

handle_bucket_put(bucket, item)#

Putting item into bucket

try_acquire(name, weight=1)#

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

class pyrate_limiter.limiter.SingleBucketFactory(bucket, clock)#

Single-bucket factory for quick use with Limiter

get(_)#

Get the corresponding bucket to this item

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