Rate limiter for async functions using Redis as a backend
Project description
asyncio-redis-rate-limit
Rate limiter for async functions using Redis as a backend.
Features
- Small and simple
- Can be used as a decorator or as a context manager
- Can be used for both clients and servers
- Works with
asyncio
- Works with any amount of processes
- Works with both
redis.asyncio.client.Redis
andaioredis
- Free of race-conditions (hopefully!)
- Fully typed with annotations and checked with mypy, PEP561 compatible
Installation
pip install asyncio-redis-rate-limit
Extras available:
pip install asyncio-redis-rate-limit[redis]
pip install asyncio-redis-rate-limit[aioredis]
Example
As a decorator:
>>> from asyncio_redis_rate_limit import rate_limit, RateSpec
>>> from redis.asyncio import Redis as AsyncRedis # pip install redis
>>> redis = AsyncRedis.from_url('redis://localhost:6379')
>>> @rate_limit(
... rate_spec=RateSpec(requests=1200, seconds=60),
... backend=redis,
... )
... async def request() -> ...:
... ... # Do something useful! Call this function as usual.
Or as a context manager:
>>> from asyncio_redis_rate_limit import RateLimiter, RateSpec
>>> from redis.asyncio import Redis as AsyncRedis # pip install redis
>>> redis = AsyncRedis.from_url('redis://localhost:6379')
>>> async def request() -> ...:
... async with RateLimiter(
... unique_key='api-name.com',
... backend=redis,
... rate_spec=RateSpec(requests=5, seconds=1),
... ):
... ... # Do the request itself.
License
Credits
This project was generated with wemake-python-package
. Current template version is: 1d63652fbb33ebe2f6d932f511b7f529a4ce2d2a. See what is updated since then.
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
Built Distribution
File details
Details for the file asyncio-redis-rate-limit-0.2.0.tar.gz
.
File metadata
- Download URL: asyncio-redis-rate-limit-0.2.0.tar.gz
- Upload date:
- Size: 5.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.11 CPython/3.8.9 Darwin/18.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37dc0294d60f2cc66b9b4069aa9d069b6a6a6006e4a519f9b03a81cca12b088e |
|
MD5 | aaf0606a8273dba4134a5a18dca784cc |
|
BLAKE2b-256 | 53415ec08c84a578460f312a7ecafad7ff1985151b83584ddda29929692e01de |
File details
Details for the file asyncio_redis_rate_limit-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: asyncio_redis_rate_limit-0.2.0-py3-none-any.whl
- Upload date:
- Size: 6.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.11 CPython/3.8.9 Darwin/18.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbd73bcf5f944cb3f6627101bb93ea114c4a9b5437c322469204a71960bc92c8 |
|
MD5 | b63fc7a6fbe5792aa21b27c3f4e6f8a0 |
|
BLAKE2b-256 | a8fa5b5c4dd0b02f521dcbd83eb2473e482a7696abc1dfe3ee1ee23b640301ab |