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.4.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.4-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for async_redis_rate_limiters-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9852e04bbd4dda359a3434f86cc45ca4d2ce48cf7ade36f283fd60e4da7156ee
MD5 dff4ca159af111083a9c1756cbb615ec
BLAKE2b-256 1621b32a82d9b844cdaf8fc9d2af826ef63a9d0bab7fff7a41651cdbbc99f4f7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for async_redis_rate_limiters-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cc3163b5c7e0e7e6696605417c73b5a87ba8270678e3dabc1465fdc3d1690054
MD5 2bb250cecd4318d2eb66e4e186633120
BLAKE2b-256 fcab0c5988867faafc4921ea11cdbf32c8b806e1f24d5388c81886945c8773d2

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