Reference

wait

waiter.wait

alias of waiter.awaiter.awaiter

waiter

class waiter.base.waiter(delays, timeout=inf)

An iterable which sleeps for given delays.

Parameters

• delays – any iterable of seconds, or a scalar which is repeated endlessly

• timeout – optional timeout for iteration

Stats

Stats class attribute

stats

Stats instance attribute

__add__(step)

Generate incremental backoff.

__ge__(floor)

Limit minimum delay generated.

__getitem__(slc)

Slice delays, e.g., to limit attempt count.

__init__(delays, timeout=inf)

Initialize self. See help(type(self)) for accurate signature.

__iter__()

Generate a slow loop of elapsed time.

__le__(ceiling)

Limit maximum delay generated.

__mul__(factor)

Generate exponential backoff.

classmethod accumulate(*args, **kwargs)

Create waiter based on itertools.accumulate (requires Python 3).

classmethod count(*args, **kwargs)

Create waiter based on itertools.count.

classmethod exponential(base, **kwargs)

Create waiter with exponential backoff.

classmethod fibonacci(delay, **kwargs)

Create waiter with fibonacci backoff.

filtered(predicate, func, iterable)

Provisionally generate arg, func(arg) pairs while predicate evaluates to true.

map(func, *iterables)

Return new waiter with function mapped across delays.

poll(predicate, func, *args, **kwargs)

Repeat function call until predicate evaluates to true.

polling(predicate)

Return a decorator for poll.

classmethod polynomial(exp, **kwargs)

Create waiter with polynomial backoff.

random(start, stop)

Add random jitter within given range.

repeat(func, *args, **kwargs)

Repeat function call.

repeating(func)

A decorator for repeat.

retry(exception, func, *args, **kwargs)

Repeat function call until exception isn’t raised.

retrying(exception)

Return a decorator for retry.

stream(queue, size=None)

Generate chained values in groups from an iterable.

The queue can be extended while in use.

suppressed(exception, func, iterable)

Provisionally generate arg, func(arg) pairs while exception isn’t raised.

throttle(iterable)

Delay iteration.

awaiter

class waiter.awaiter.awaiter(delays, timeout=inf)

Bases: waiter.base.waiter

An iterable which sleeps for given delays.

Parameters

• delays – any iterable of seconds, or a scalar which is repeated endlessly

• timeout – optional timeout for iteration

Note

Overloads for async coroutine functions.

__aiter__()

Generate a slow loop of elapsed time.

poll

Repeat function call until predicate evaluates to true.

repeat

Repeat function call.

retry

Repeat function call until exception isn’t raised.

throttle

Delay iteration.

suppress

waiter.suppress(*exceptions)

Backport of contextlib.suppress, which also records exception.

first

waiter.first(predicate, iterable, *default)

Return first item which evaluates to true, like any with filtering.

Stats

class waiter.base.Stats(**kwds)

Bases: collections.Counter

Mapping of attempt counts.

Note

The Stats interface is considered provisional. It can be customized by overriding at the class or instance level.

add(attempt, elapsed)

Record attempt and return next value.

property failures

number of repeat attempts

property total

total number of attempts