Skip to main content

This library is inspired by this book and this implementation https://github.com/vostok/throttling.

Features:

  1. Set capacity(max parallel requests) and queue(max queued requests) limits.
  2. Per-consumer limits. For instance, to not allow any consumer to use more than 70% of service's capacity.
  3. Per-request priorities. For instance, to not allow requests with lowest priority to be queued or to now allow requests with normal priority to use more than 90% of service's capacity.

Example:

from aio_throttle import Throttler, MaxFractionCapacityQuota, ThrottlePriority, ThrottleResult

capacity_limit = 100
queue_limit = 200
consumer_quotas = [MaxFractionCapacityQuota(0.7)]
priority_quotas = [MaxFractionCapacityQuota(0.9, ThrottlePriority.NORMAL)]
throttler = Throttler(capacity_limit, queue_limit, consumer_quotas, priority_quotas)


consumer, priority = "yet another consumer", ThrottlePriority.HIGH
async with throttler.throttle(consumer=consumer, priority=priority) as result:
    ... # check if result is ThrottleResult.ACCEPTED or not

Example of an integration with aiohttp and prometheus_client()

import aiohttp
import aiohttp.web
import aiohttp.web_request
import aiohttp.web_response

import aio_throttle


@aio_throttle.aiohttp_ignore() # do not throttle this handler 
async def healthcheck(_: aiohttp.web_request.Request) -> aiohttp.web_response.Response:
    return aiohttp.web_response.Response()


async def authorize(_: aiohttp.web_request.Request) -> aiohttp.web_response.Response:
    return aiohttp.web_response.Response()


async def create_app() -> aiohttp.web.Application:
    app = aiohttp.web.Application(middlewares=[
        aio_throttle.aiohttp_middleware_factory(
                capacity_limit=20,
                queue_limit=100,
                consumer_quotas=[aio_throttle.MaxFractionCapacityQuota[str](0.7)],
                priority_quotas=[
                    aio_throttle.MaxFractionCapacityQuota[aio_throttle.ThrottlePriority](
                        0.9, aio_throttle.ThrottlePriority.NORMAL
                    )
                ],
                metrics_provider=aio_throttle.PROMETHEUS_METRICS_PROVIDER,
            ),
    ])
    app.router.add_get("/healthcheck", healthcheck)
    app.router.add_post("/authorize", authorize)
    return app


aiohttp.web.run_app(create_app(), port=8080, access_log=None)

Release files for aio-throttle 1.7.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 aio-throttle 1.7.0
File Size Uploaded
aio-throttle-1.7.0.tar.gz 8.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aio-throttle 1.7.0
File Interpreter ABI Platform
aio_throttle-1.7.0-py3-none-any.whl Python 3 none any Details

Total release size: 18.4 kB

Release files / aio-throttle-1.7.0.tar.gz

Download URL aio-throttle-1.7.0.tar.gz
Size 8.3 kB
Tags Source
SHA-256 checksum
How to use checksums
ce969ebb149ffe59231008a71917165893a38c40b49c3e5201c24209a49b9829
BLAKE2b-256 checksum
How to use checksums
bc0f72748a063f9caa57fbd18cb8eeebc2c41b570f88dfc68c0cb47acd869611
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

Release files / aio_throttle-1.7.0-py3-none-any.whl

Download URL aio_throttle-1.7.0-py3-none-any.whl
Size 10.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6b96d8c3f999be21e060ba013da6601628973cacb61633ce17fc07f80f821716
BLAKE2b-256 checksum
How to use checksums
1bf3e4145220b66fa9dd773434cbbda69742454a601531b818a4513ec64b1651
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

Release history Release notifications | RSS feed

This release

1.7.0 This release

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.0

2 release files

1.4.1

2 release files

1.3.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.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