Skip to main content

Adaptive async rate limiting for Python, closed-loop feedback control for API concurrency.

Project description

gentlify

CI codecov PyPI Python License Typed

Adaptive async rate limiting for Python, closed-loop feedback control for API concurrency.

Zero dependencies. Asyncio-native. Fully typed.

Gentlify automatically adjusts concurrency and dispatch rate in response to failures, so your application backs off when an API is struggling and speeds up when it recovers — without manual tuning.

Installation

pip install gentlify

Requires Python 3.11+.

Quick Start

import asyncio
from gentlify import Throttle

throttle = Throttle(max_concurrency=5)

async def main():
    for item in range(20):
        async with throttle.acquire() as slot:
            await call_api(item)

asyncio.run(main())

If requests start failing, gentlify automatically halves concurrency, enters a cooling period, then gradually reaccelerates — all without any manual intervention.

Context Manager API

The primary API uses acquire() as an async context manager:

async with throttle.acquire() as slot:
    result = await call_api(item)
    slot.record_tokens(result.token_count)  # optional token tracking

On success, gentlify records the completion and checks whether to reaccelerate. On exception, it records the failure and may decelerate if the failure threshold is reached.

Decorator API

Wrap async functions directly:

@throttle.wrap
async def call_api(item):
    return await httpx.post("/api", json=item)

# Each call is automatically throttled
await call_api(my_item)

The decorator preserves the function signature and return value. Failures are recorded automatically.

Token Budget

Track and enforce token consumption within a rolling time window:

from gentlify import Throttle, TokenBudget

throttle = Throttle(
    max_concurrency=10,
    token_budget=TokenBudget(max_tokens=100_000, window_seconds=60.0),
)

async with throttle.acquire() as slot:
    result = await call_llm(prompt)
    slot.record_tokens(result.usage.total_tokens)

When the budget is exhausted, acquire() blocks until tokens expire from the rolling window.

Circuit Breaker

Automatically stop sending requests when an API is down:

from gentlify import Throttle, CircuitBreakerConfig

throttle = Throttle(
    max_concurrency=10,
    circuit_breaker=CircuitBreakerConfig(
        consecutive_failures=5,
        open_duration=30.0,
        half_open_max_calls=2,
    ),
)

After 5 consecutive failures the circuit opens, rejecting requests with CircuitOpenError for 30 seconds. It then enters half-open state, allowing 2 probe requests. If those succeed, the circuit closes; if they fail, it re-opens with a doubled delay (capped at 5x).

Retry

Automatically retry failed requests with configurable backoff — no need for a separate retry library:

from gentlify import Throttle, RetryConfig

throttle = Throttle(
    max_concurrency=5,
    retry=RetryConfig(
        max_attempts=3,
        backoff="exponential_jitter",
        base_delay=1.0,
        max_delay=60.0,
    ),
)

@throttle.wrap
async def call_api(item):
    return await httpx.post("/api", json=item)

Retries happen inside the throttled slot, so concurrency accounting stays correct. Only the final failure (after all retries are exhausted) triggers throttle deceleration — intermediate failures just trigger backoff sleep.

Backoff strategies:

  • fixed — constant delay between retries
  • exponential — delay doubles each attempt (base_delay × 2^attempt, capped at max_delay)
  • exponential_jitter — exponential with random jitter (default, recommended)

You can also filter which exceptions are retryable:

retry = RetryConfig(
    max_attempts=3,
    retryable=lambda exc: isinstance(exc, (TimeoutError, RateLimitError)),
)

Non-retryable exceptions propagate immediately without further attempts.

Configuration

From code

throttle = Throttle(
    max_concurrency=10,
    initial_concurrency=3,
    min_dispatch_interval=0.2,
    failure_threshold=3,
    cooling_period=10.0,
    total_tasks=1000,
    on_progress=lambda snap: print(f"{snap.percentage:.0f}%"),
)

From a dictionary

throttle = Throttle.from_dict({
    "max_concurrency": 10,
    "token_budget": {"max_tokens": 50000, "window_seconds": 60.0},
})

From environment variables

# Set GENTLIFY_MAX_CONCURRENCY=10, GENTLIFY_MIN_DISPATCH_INTERVAL=0.5, etc.
throttle = Throttle.from_env()

# Or with a custom prefix:
throttle = Throttle.from_env(prefix="MYAPP")

Callbacks

State change events

def on_change(event):
    print(f"[{event.kind}] {event.data}")

throttle = Throttle(
    max_concurrency=10,
    on_state_change=on_change,
)
# Prints: [decelerated] {'concurrency': (10, 5), ...}
# Prints: [reaccelerated] {'concurrency': (5, 6), ...}

Progress milestones

throttle = Throttle(
    max_concurrency=10,
    total_tasks=100,
    on_progress=lambda snap: print(
        f"{snap.percentage:.0f}% done, ETA {snap.eta_seconds:.0f}s"
    ),
)

Graceful Shutdown

# Stop accepting new requests
throttle.close()

# Wait for in-flight requests to finish
await throttle.drain()

After close(), any new acquire() call raises ThrottleClosed. In-flight requests complete normally. drain() blocks until all in-flight requests finish.

Snapshot

Inspect the throttle's current state at any time:

snap = throttle.snapshot()
print(snap.concurrency)        # current concurrency limit
print(snap.dispatch_interval)  # current dispatch interval
print(snap.state)              # RUNNING, COOLING, CIRCUIT_OPEN, etc.
print(snap.tokens_remaining)   # remaining token budget (or None)
print(snap.eta_seconds)        # estimated time remaining (or None)

Types

All public types are re-exported from the top-level package:

Type Description
Throttle Main orchestrator
ThrottleConfig Validated configuration dataclass
TokenBudget Token budget configuration
CircuitBreakerConfig Circuit breaker configuration
RetryConfig Retry and backoff configuration
ThrottleSnapshot Read-only state view
ThrottleState Enum: RUNNING, COOLING, CIRCUIT_OPEN, CLOSED, DRAINING
ThrottleEvent Structured event for state change callbacks
GentlifyError Base exception
CircuitOpenError Raised when circuit breaker is open
ThrottleClosed Raised when throttle is closed

Development

pip install -e ".[dev]"
pytest
mypy --strict src/gentlify
ruff check src/ tests/

Releasing

  1. Bump the version in src/gentlify/_version.py and pyproject.toml
  2. Update CHANGELOG.md
  3. Commit and push to main
  4. Tag the release and push:
    git tag v<version>
    git push --tags
    
  5. The GitHub Action builds and publishes to PyPI automatically via trusted publishing (OIDC)

License

Apache-2.0 — Copyright (c) 2026 Pointmatic

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

gentlify-1.6.2.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

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

gentlify-1.6.2-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file gentlify-1.6.2.tar.gz.

File metadata

  • Download URL: gentlify-1.6.2.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gentlify-1.6.2.tar.gz
Algorithm Hash digest
SHA256 5717e9ecabc3b51a9571866b6c99a706ec3616bec65c96b558888f310241a74c
MD5 e82806ebcfeec409801c2990c1fb993d
BLAKE2b-256 fdb14a11066dfe285e84401a4044c82e33436007fcbba9b7a5d0703feb7479c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for gentlify-1.6.2.tar.gz:

Publisher: publish.yml on pointmatic/gentlify

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

File details

Details for the file gentlify-1.6.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for gentlify-1.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 95ed2691049ef67e5e55036af3222ab59e44428b037d2550d4e048a2086f8b51
MD5 403fa8c48e45bc915324e485569c9f34
BLAKE2b-256 22457e01412b8c5f25605fce6f2878c709b61a9bfe402f46404332f77f98e07f

See more details on using hashes here.

Provenance

The following attestation bundles were made for gentlify-1.6.2-py3-none-any.whl:

Publisher: publish.yml on pointmatic/gentlify

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