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 typing import AsyncContextManager
from async_redis_rate_limiters import DistributedSemaphoreManager


async def worker(semaphore: AsyncContextManager):
    async with semaphore:
        # concurrency limit enforced here
        pass


async def main():
    manager = DistributedSemaphoreManager(
        redis_url="redis://localhost:6379",
        redis_max_connections=100,
    )
    # Limit the concurrency to 10 concurrent tasks for the key "test"
    semaphore = manager.get_semaphore("test", 10)
    tasks = [asyncio.create_task(worker(semaphore)) 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.0.8.tar.gz (7.6 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.0.8-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for async_redis_rate_limiters-0.0.8.tar.gz
Algorithm Hash digest
SHA256 0067a13b0b9a11002d724c0b852cd2fd5641a5293b68b6d57eaa7d3d5e366df4
MD5 aada71bfdcf8cfe8bdd3c1d342e8ddc1
BLAKE2b-256 a57c2d98209afe5d02b03ba2d462fa4055f15594be8720769de9a8d27b04cce3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for async_redis_rate_limiters-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0f69a318cd15aa4973fca31018cdf9c73bf92ad6b9221d4f50ab2b6c75b010f6
MD5 60c1ee8e5b1fee3eda9745e2a6e5afce
BLAKE2b-256 ebca3a0abdc6f191bc1c6ff12369a87f9311fe6d8c42b15fb22ecc30ce958745

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