Skip to main content

philiprehberger-retry-kit

Tests PyPI version Last updated

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

Preset Functions with Jitter

Preset functions accept a jitter parameter that randomizes the initial delay by a factor between 0.8 and 1.2, helping to spread out retry storms.

from philiprehberger_retry_kit import exponential, gentle, network_request, database_query, aggressive, retry

result = retry(lambda: fetch_data(), **exponential(jitter=True))
result = retry(lambda: gentle_op(), **gentle(jitter=True))
result = retry(lambda: api_call(), **network_request(jitter=True))
result = retry(lambda: db_query(), **database_query(jitter=True))
result = retry(lambda: transient_op(), **aggressive(jitter=True))

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

Circuit Breaker as Context Manager

breaker = CircuitBreaker(failure_threshold=3, reset_timeout=10.0)

try:
    with breaker:
        result = fetch_data()
except CircuitOpenError:
    print("Circuit is open")

On __enter__, the breaker checks if the circuit is open and raises CircuitOpenError if so. On __exit__, it records success or failure based on whether an exception occurred.

Async Circuit Breaker

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

Resetting a Circuit Breaker

breaker = CircuitBreaker(failure_threshold=2, reset_timeout=10.0)

# ...after failures have tripped the breaker open
breaker.reset()  # Clear failure count and return to CLOSED state
result = breaker.call(lambda: fetch_data())

API

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()
CircuitBreaker.reset() Reset the circuit to CLOSED state and clear failure count
CircuitBreaker.__enter__ / __exit__ Context manager support for circuit breaker
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"
exponential(jitter=False) Preset function returning aggressive config, with optional jitter
gentle(jitter=False) Preset function returning gentle config, with optional jitter
network_request(jitter=False) Preset function returning network request config, with optional jitter
database_query(jitter=False) Preset function returning database query config, with optional jitter
aggressive(jitter=False) Preset function returning aggressive config (short delays, many attempts), with optional jitter

Development

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

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT

Release files for philiprehberger-retry-kit 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for philiprehberger-retry-kit 0.4.0
File Size Uploaded
philiprehberger_retry_kit-0.4.0.tar.gz 189.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for philiprehberger-retry-kit 0.4.0
File Interpreter ABI Platform
philiprehberger_retry_kit-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 196.6 kB

Release files / philiprehberger_retry_kit-0.4.0.tar.gz

Download URL philiprehberger_retry_kit-0.4.0.tar.gz
Size 189.0 kB
Tags Source
SHA-256 checksum
How to use checksums
d7ba2dbb9f51c4af2c2f8b5b686479d8561fe83cbf95958394084a881b555d5e
BLAKE2b-256 checksum
How to use checksums
0cb1722972c81ed26b955707b8114e66325d701161704e0dc65a0818d307af78
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / philiprehberger_retry_kit-0.4.0-py3-none-any.whl

Download URL philiprehberger_retry_kit-0.4.0-py3-none-any.whl
Size 7.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c0b61018551371bd3e8c2371285ac3deb4337c726719bb5c79b1a54a37dc3d3d
BLAKE2b-256 checksum
How to use checksums
f3d1c34d3b95c14266042f3a169b4bfc7ad54b7c1ebd0b4a9aaf96f70478dcf7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page