Skip to main content

Async retry with exponential backoff, circuit breaker, and cancellation for Python

Project description

philiprehberger-retry-kit

Tests PyPI version License

Retry with exponential backoff, circuit breaker, and presets for Python.

Installation

pip install philiprehberger-retry-kit

Usage

Basic Retry

from philiprehberger_retry_kit import retry

result = retry(lambda: fetch_data(), max_attempts=3)

With Options

result = retry(
    lambda: fetch_data(),
    max_attempts=5,
    backoff="exponential",      # "exponential" | "linear" | "fixed"
    initial_delay=1.0,
    max_delay=30.0,
    jitter=True,
    retry_on=lambda e: isinstance(e, ConnectionError),
    on_retry=lambda e, attempt: print(f"Retry {attempt}..."),
)

Async Retry

from philiprehberger_retry_kit import async_retry

result = await async_retry(
    lambda: async_fetch_data(),
    max_attempts=3,
    backoff="exponential",
)

Presets

from philiprehberger_retry_kit import retry, presets

result = retry(lambda: fetch_data(), **presets["network_request"])
result = retry(lambda: db_query(), **presets["database_query"])
result = retry(lambda: critical_op(), **presets["aggressive"])
result = retry(lambda: gentle_op(), **presets["gentle"])

Circuit Breaker

from philiprehberger_retry_kit import CircuitBreaker, CircuitOpenError

breaker = CircuitBreaker(
    failure_threshold=5,
    reset_timeout=30.0,
    on_state_change=lambda from_s, to_s: print(f"Circuit: {from_s} -> {to_s}"),
)

try:
    result = breaker.call(lambda: fetch_data())
except CircuitOpenError:
    print("Circuit is open, failing fast")

Async Circuit Breaker

result = await breaker.async_call(lambda: async_fetch_data())

API Reference

Function / Class Description
retry(fn, *, max_attempts=3, backoff="exponential", initial_delay=1.0, max_delay=30.0, jitter=True, retry_on=None, on_retry=None, on_success=None, on_failure=None) Retry a callable with configurable backoff
async_retry(fn, *, ...) Async version of retry() with the same parameters
CircuitBreaker(failure_threshold=5, reset_timeout=30.0, half_open_max_attempts=1, on_state_change=None, on_circuit_open=None) Circuit breaker that fails fast after repeated failures
CircuitBreaker.call(fn) Execute function through the circuit breaker
CircuitBreaker.async_call(fn) Async version of call()
RetryError Raised when all retry attempts fail (.attempts, .last_error)
CircuitOpenError Raised when circuit breaker is open
presets Dict of preset configs: "aggressive", "gentle", "network_request", "database_query"

Development

pip install -e .
python -m pytest tests/ -v

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

philiprehberger_retry_kit-0.2.3.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_retry_kit-0.2.3-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_retry_kit-0.2.3.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_retry_kit-0.2.3.tar.gz
Algorithm Hash digest
SHA256 0efb0a6f48f674151780a4a38b2b73a0bd8ff9b506e7f2b84e8c86742a9bfde9
MD5 9342ee5464db7ae7e5eeed58b4b969fb
BLAKE2b-256 2391e2a4793a0fc4febea8fa7bffbe2f5bc0add4dfc58ec8807ab8b11afff42e

See more details on using hashes here.

File details

Details for the file philiprehberger_retry_kit-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_retry_kit-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c71b2bbc65f0ea20fd218d009e40bba5cb296af23b70091ccfa13178a34bf804
MD5 df2bd7be6f580d4447574e2144f3150b
BLAKE2b-256 355dc8f29c5e0df6904d4c3515b5848a15e5844468a898c0c8ec63763aa92a2d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page