Skip to main content

Thread-safe rate limiter and retry decorator for Python - token bucket pacing, resilient API call management, zero dependencies.

Project description

call-limiter 🚀

PyPI - Version Build Status Coverage Python Versions License

Thread-safe Python decorators for synchronized rate limiting and retry logic.

📦 Core Components

  • CallLimiter: A high-precision throttler that paces function calls to stay within specific rate limits.
  • CallRetry: A resilience decorator that re-runs failed functions with a configurable delay and exception handling.
  • ResilientLimiter: A hybrid solution that combines pacing with Coordinated Recovery, ensuring retries never exceed your defined rate limit across threads.

🛠 Installation

pip install call-limiter

Component 1: CallLimiter

Scenario: I want to "rate limit" (throttle) my function so it limits my calls to 5 calls per second. I also want to have an option to select if I want 5 calls to fire instantly or spread across evenly in the 1 second period.

Usage-1: 5 calls per 1 second with burst (instantly fire all 5 calls) Best for: Maximizing throughput when the target API allows short spikes.

My function to throttle: my_function

from call_limiter import CallLimiter

limiter = CallLimiter(calls=5, period=1, allow_burst=True)
throttled_func = limiter(my_function)

Usage-2: 5 calls per 1 second paced (evenly spread calls) Best for: Avoiding "spiky" traffic patterns that trigger anti-bot protections.

from call_limiter import CallLimiter

# This forces a call exactly every 0.2 seconds (1s / 5 calls)
limiter = CallLimiter(calls=5, period=1, allow_burst=False)
throttled_func = limiter(my_function)

Component 2: CallRetry

Scenario: I want a retry logic to use with my function calls. If my_function raises ValueError exception, it should retry up to 5 times with 1-second delay between attempts. I want to log every retry with retry_logger function. if it still fails, it should use fail_handler function. (if not provided, raise error)

from call_limiter import CallRetry

# This configuration perfectly mirrors your scenario:
retry = CallRetry(
    retry_count=5,
    retry_interval=1.0,
    retry_exceptions=(ValueError,), # Trigger
    on_retry=retry_logger,           # Observability
    fallback=fail_handler            # Outcome (Plan B)
)

# If fail_handler is a function, this returns its result on ultimate failure.
# If you didn't pass fail_handler, it would raise the ValueError.
resilient_func = retry(my_function)

Component 3: ResilientLimiter

Scenario: I want a rate limiter that can also handle failed calls. my_function should be called
Flow Logic:

  • 5 calls/per second with burst (or drip),
  • max_retry = 3 (if it fails)
  • on_retry=retry_handler, notify me by calling optional retry_handler, if not provided ignore!
  • fallback=falback_handler if it still fails notify me, if not provided raise error! Note: each retry will comply "5 calls/per second with burst (or drip)" tempo to respect rate limiter
    Note: on_retry receives (exception, attempt_number), while fallback is a simple callable.
from call_limiter import ResilientLimiter


limiter = ResilientLimiter(
    calls=5,
    period=1.0,
    allow_burst=True,
    retry_count=3,
    on_retry=retry_handler,
    fallback=fail_handler
)

@limiter
def my_function():
    # This will respect the 5/sec pace, even during retries.
    pass

✨ Key Features

  • Low-Jitter Timing: Uses time.perf_counter() and resolution-aware sleeping to prevent the "creeping delays" common in standard rate limiters.
  • Zero-Hardcode Logic: Accounts for "OS Jitter" to ensure time.sleep remains accurate even under system load.
  • Thread-Safe: Designed for multithreaded environments where multiple workers hit the same limited resource.
  • Thread-Synchronized State: Shared locks ensure that 10 threads hitting the same limiter behave as a single unit.
  • Synchronized Pacing: In hybrid mode, retries are queued through the global limiter, preventing a 'thundering herd' and ensuring you never exceed your quota during recovery.

📋 Links

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

call_limiter-1.0.0.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

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

call_limiter-1.0.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file call_limiter-1.0.0.tar.gz.

File metadata

  • Download URL: call_limiter-1.0.0.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for call_limiter-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b5cbb7546da0da8f3181743616adeb9bd31520360e33857ed8b78f3cd50b9b70
MD5 a454fbf7e232264f7e19c0c7bede4afc
BLAKE2b-256 2aeaf81399ba81325d13a31aead6a3033b7c8562c8dca465c3cce80e1972412b

See more details on using hashes here.

Provenance

The following attestation bundles were made for call_limiter-1.0.0.tar.gz:

Publisher: publish.yml on eyukselen/call-limiter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file call_limiter-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: call_limiter-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for call_limiter-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c25b76ec4cbfa06271f72cab3a4ed139532a9e02359cc3744586f34a9b82173e
MD5 582733e6b71c39ced643da03eedfcabc
BLAKE2b-256 6f568b9ab505fa79d400bc9cb6bad5ef721c189699a4f4c0884906f85695c2c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for call_limiter-1.0.0-py3-none-any.whl:

Publisher: publish.yml on eyukselen/call-limiter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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