Simple Token Bucket

一个简单的令牌桶实现。

项目理念

simple-token-bucket旨在成为一个轻量级且易于使用的令牌桶库。 简单优于复杂。

安装

simple-token-bucket可在PyPI上找到

python -m pip install simple-token-bucket[redis]

该项目需要Python 3.8或更高版本才能运行。

使用示例

from simple_token_bucket import SimpleTokenBucket
from simple_token_bucket.backends.redis import RedisBackend

# Create a new bucket
third_party_api_rate_limit_bucket = SimpleTokenBucket(
    name="third_party_api",
    bucket_size=3,
    interval=10,
    backend=RedisBackend.from_url("redis://localhost:6379/0")
)

third_party_api_rate_limit_bucket.try_get_token()
third_party_api_rate_limit_bucket.try_get_token()
third_party_api_rate_limit_bucket.try_get_token()

# will raises a NotEnoughTokens exception.
third_party_api_rate_limit_bucket.try_get_token()

# after 10 seconds everything works again.
import time
time.sleep(10)
third_party_api_rate_limit_bucket.try_get_token()

最新文档可在此处找到

https://simple-token-bucket.readthedocs.io/en/latest/

贡献

欢迎贡献。请参阅文档中的贡献部分。