timeout-sampler

Install timeout-sampler, write your first polling loop, and understand the core iteration pattern in under two minutes

Learn how to create a TimeoutSampler iterator, yield function results, and break on a success condition

Wrap any function with the @retry decorator so it automatically polls until a truthy return value or timeout

Configure exceptions_dict to selectively ignore, match by message text, or re-raise exceptions during polling

Toggle elapsed-time logging, function-call details, and argument visibility using print_log, print_func_log, and print_func_args

Use the TimeoutWatch helper to measure remaining time in custom polling or orchestration workflows

Copy-paste recipes for waiting on API readiness, retrying flaky operations, polling with partial functions, and combining exception filters

Complete constructor parameters, iteration behavior, exception handling methods, and return semantics for TimeoutSampler

All parameters accepted by the retry decorator and how they map to TimeoutSampler options

Constructor and remaining_time() method reference for the TimeoutWatch time-tracking class

Attributes, string representation, and access to last_exp and elapsed_time on the TimeoutExpiredError exception

Understand the inheritance-aware exception matching algorithm, message filtering, and the three outcome categories when an exception is raised inside the polled function

Document the sensitive_keys parameter available on both TimeoutSampler and @retry, explain the built-in default sensitive keys (authorization, token, access_token, password, secret, api_key, apikey), show how to add custom keys via the sensitive_keys parameter, and describe the recursive redaction behavior that masks values in nested dicts, lists, and tuples in logged arguments.

Document the ability to use callable (lambda or function) filters in exceptions_dict values alongside string filters. Cover the ExceptionFilter and ExceptionsDict public type aliases, explain that callables receive the exception instance and return a truthy value to ignore/retry, show examples like filtering by exception attributes (e.g., HTTP status codes), combining string and callable filters in the same list, and describe error handling when a callable filter itself raises.