Skip to main content

Rock solid async python generic distributed rate limiters (concurrency and time) backed by Redis.

Project description

async-redis-rate-limiters

Python Badge UV Badge Mergify Badge Renovate Badge MIT Licensed

Rock solid async python generic distributed rate limiters (concurrency and time) backed by Redis.

[!WARNING]
This is a very preliminary version of the library and only concurrency limiters are available for now.

Features

  • ✅ Support very high concurrency (>100K), keep a reasonable number of connections to Redis (default: 300)
  • ✅ Rock solid with Redis/Network failures (multiple attempts, exponential backoff, etc.)
    • you can restart the Redis server during the execution without any exception or losing any semaphore! (of course, if persistence is setup in the redis instance)
  • ✅ Very high performances with almost no polling at all
  • ✅ Memory backend (for testing)

Non-features

  • ❌ No time based rate limiters (yet)
  • ❌ No blocking support, only async Python

Installation

pip install async-redis-rate-limiters

(or same with your favorite package manager)

Usage

import asyncio
from async_redis_rate_limiters import DistributedSemaphoreManager


async def worker(manager: DistributedSemaphoreManager):
    # Limit the concurrency to 10 concurrent tasks for the key "test"
    async with manager.get_semaphore("test", 10):
        # concurrency limit enforced here
        pass


async def main():
    manager = DistributedSemaphoreManager(
        redis_url="redis://localhost:6379",
        redis_max_connections=100,
        redis_ttl=3600,  # semaphore max duration (seconds)
    )
    tasks = [asyncio.create_task(worker(manager)) for _ in range(1000)]
    await asyncio.gather(*tasks)


if __name__ == "__main__":
    asyncio.run(main())
What about if you want to use the memory backend?

WARNING: the memory backend is just a wrapper on a classic asyncio.Semaphore, it is not "distributed" at all!

manager = DistributedSemaphoreManager(
    backend = "memory"
)

# and use it classically

Dev

  • Lint the code:

make lint

  • Run the tests:

make test

note: you need a redis instance listening to localhost:6379

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

async_redis_rate_limiters-0.1.3.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

async_redis_rate_limiters-0.1.3-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file async_redis_rate_limiters-0.1.3.tar.gz.

File metadata

File hashes

Hashes for async_redis_rate_limiters-0.1.3.tar.gz
Algorithm Hash digest
SHA256 0f638d61f5e8c10fbac0dc36db8334985f7f7bdf503a4beff5b63daaa3a93f1d
MD5 733ab55123be3050b688ebcd8e105f0b
BLAKE2b-256 5fb8d2d9f3ae09ff69ecc14f9ac4fe4eb8dcfddd7ab935d936ed98f4e1e4e193

See more details on using hashes here.

File details

Details for the file async_redis_rate_limiters-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for async_redis_rate_limiters-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b67217265f652b9886be1b4d10b29bfa2eef499345fa88413c42f046faf80111
MD5 0735c1cff1d8f4861c326a0964433f14
BLAKE2b-256 f02a0d7df9e815b9c23145d13b6f92719ad998565ddd550394b4427843d72548

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