waiter
An iterable which sleeps for given delays. Aliased as wait.
Usage
waiter()Parameters
delays iterable | number-
any iterable of seconds, or a scalar which is repeated endlessly
timeout number- optional timeout for iteration
Classes
| Name | Description |
|---|---|
| Stats | Mapping of attempt counts. |
Stats
Mapping of attempt counts.
Usage
Stats()Methods
| Name | Description |
|---|---|
| add() | Record attempt and return next value. |
add()
Record attempt and return next value.
Usage
add(attempt, elapsed)Methods
| Name | Description |
|---|---|
| __add__() | Generate incremental backoff. |
| __aiter__() | Asynchronously generate a slow loop of elapsed time. |
| __ge__() | Limit minimum delay generated. |
| __getitem__() | Slice delays, e.g., to limit attempt count. |
| __iter__() | Generate a slow loop of elapsed time. |
| __le__() | Limit maximum delay generated. |
| __mul__() | Generate exponential backoff. |
| accumulate() |
Create waiter based on itertools.accumulate.
|
| count() |
Create waiter based on itertools.count.
|
| exponential() | Create waiter with exponential backoff. |
| fibonacci() | Create waiter with fibonacci backoff. |
| filtered() |
Generate arg, func(arg) pairs while predicate evaluates to true.
|
| map() | Return new waiter with function mapped across delays. |
| poll() | Repeat function call until predicate evaluates to true. |
| polling() | Return a decorator for poll. |
| polynomial() | Create waiter with polynomial backoff. |
| random() | Add random jitter within given range. |
| repeat() | Repeat function call. |
| repeating() | A decorator for repeat. |
| retry() | Repeat function call until exception isn’t raised. |
| retrying() | Return a decorator for retry. |
| stream() | Generate chained values in groups from an iterable. |
| suppressed() |
Generate arg, func(arg) pairs while exception isn’t raised.
|
| throttle() | Delay iteration. |
__add__()
Generate incremental backoff.
Usage
__add__(step)__aiter__()
Asynchronously generate a slow loop of elapsed time.
Usage
__aiter__()__ge__()
Limit minimum delay generated.
Usage
__ge__(floor)__getitem__()
Slice delays, e.g., to limit attempt count.
Usage
__getitem__(slc)__iter__()
Generate a slow loop of elapsed time.
Usage
__iter__()__le__()
Limit maximum delay generated.
Usage
__le__(ceiling)__mul__()
Generate exponential backoff.
Usage
__mul__(factor)accumulate()
Create waiter based on itertools.accumulate.
Usage
accumulate(*args, **kwargs)count()
Create waiter based on itertools.count.
Usage
count(*args, **kwargs)exponential()
Create waiter with exponential backoff.
Usage
exponential(base, **kwargs)fibonacci()
Create waiter with fibonacci backoff.
Usage
fibonacci(delay, **kwargs)filtered()
Generate arg, func(arg) pairs while predicate evaluates to true.
Usage
filtered(predicate, func, iterable)map()
Return new waiter with function mapped across delays.
Usage
map(func, *iterables)poll()
Repeat function call until predicate evaluates to true.
Usage
poll(predicate, func, *args, **kwargs)polling()
Return a decorator for poll.
Usage
polling(predicate)polynomial()
Create waiter with polynomial backoff.
Usage
polynomial(exp, **kwargs)random()
Add random jitter within given range.
Usage
random(start, stop)repeat()
Repeat function call.
Usage
repeat(func, *args, **kwargs)repeating()
A decorator for repeat.
Usage
repeating(func)retry()
Repeat function call until exception isn’t raised.
Usage
retry(exception, func, *args, **kwargs)retrying()
Return a decorator for retry.
Usage
retrying(exception)stream()
Generate chained values in groups from an iterable.
Usage
stream(queue, size=None)The queue can be extended while in use.
suppressed()
Generate arg, func(arg) pairs while exception isn’t raised.
Usage
suppressed(exception, func, iterable)throttle()
Delay iteration.
Usage
throttle(iterable)Async version delays the pull is requested.