throttled-py:开箱即用的 Python 限流库

0x01 前言

1)限流的本质

限流的本质是一种通过限制系统处理请求数来应对超额流量的保护机制。

2)为什么需要限流?

系统的 CPU、内存、网络资源有限,如果没有对请求量进行限制,在面对超额突发流量时,很有可能耗尽系统资源导致服务不可用

因此,我们可以根据业务场景,以用户、调用服务、优先级等维度设置限流策略,从而避免单个来源占据大部分系统资源,确保系统稳定性。

3)为什么使用 throttled-py?

throttled-py 是目前 GitHub 开源的 Python 限流库中,限流算法及接入方式最全面的。同时具备良好的性能,相比于缓存请求记录(现有一些 Python 限流库的做法),参考 Go 主流限流库(zeromicro/go-zerothrottled/throtted)提供高效,具有线程安全保障的算法选项,基本无额外内存占用。

支持多种业内通用的限流算法及存储后端(Redis、内存),同步 / 异步(async / await)皆可用,提供灵活的限流策略配置,支持等待重试模式,提供函数调用 / 装饰器 / 上下文管理器等接入用法,为 Web / MCP / 任务队列提供应对超额流量的保护机制。

🔗 项目地址:throttled-py

0x02 功能特性

0x03 安装

shell 复制代码
$ pip install throttled-py

1)额外依赖

v2.0.0 版本起,默认安装仅包含核心功能依赖。

如需使用扩展功能,可通过以下方式安装可选依赖项(多个依赖项用逗号分隔):

shell 复制代码
$ pip install "throttled-py[redis]"

$ pip install "throttled-py[redis,in-memory]"

可选依赖项说明:

附加依赖项 描述
all 安装所有扩展依赖。
in-momory 使用内存作为存储后端。
redis 使用 Redis 作为存储后端。

0x04 快速开始

1)通用 API

2)样例

python 复制代码
from throttled import RateLimiterType, Throttled, rate_limiter, store, utils

throttle = Throttled(
    # 📈 使用令牌桶作为限流算法。
    using=RateLimiterType.TOKEN_BUCKET.value,
    # 🪣 设置配额:每秒填充 1,000 个 Token(limit),桶大小为 1,000(burst)。
    quota=rate_limiter.per_sec(1_000, burst=1_000),
    # 📁 使用内存作为存储
    store=store.MemoryStore(),
)


def call_api() -> bool:
    # 💧消耗 Key=/ping 的一个 Token。
    result = throttle.limit("/ping", cost=1)
    return result.limited


if __name__ == "__main__":
    # 💻 Python 3.12.10, Linux 5.4.119-1-tlinux4-0009.1, Arch: x86_64, Specs: 2C4G.
    # ✅ Total: 100000, 🕒 Latency: 0.0068 ms/op, 🚀 Throughput: 122513 req/s (--)
    # ❌ Denied: 98000 requests
    benchmark: utils.Benchmark = utils.Benchmark()
    denied_num: int = sum(benchmark.serial(call_api, 100_000))
    print(f"❌ Denied: {denied_num} requests")

3)异步

同步和异步拥有一致的功能和标准 API,只需将导入语句从 from throttled import ... 替换为 from throttled.asyncio import .. 即可。

例如将 2)样例 改写为异步:

python 复制代码
import asyncio
from throttled.asyncio import RateLimiterType, Throttled, rate_limiter, store, utils

throttle = Throttled(
    using=RateLimiterType.TOKEN_BUCKET.value,
    quota=rate_limiter.per_sec(1_000, burst=1_000),
    store=store.MemoryStore(),
)


async def call_api() -> bool:
    result = await throttle.limit("/ping", cost=1)
    return result.limited


async def main():
    benchmark: utils.Benchmark = utils.Benchmark()
    denied_num: int = sum(await benchmark.async_serial(call_api, 100_000))
    print(f"❌ Denied: {denied_num} requests")

if __name__ == "__main__":
    asyncio.run(main())

0x05 使用

1)基础

函数调用

python 复制代码
from throttled import Throttled

# 参数全部缺省时,默认初始化一个基于「内存」、每分钟允许通过 60 个请求、使用「令牌桶算法」的限流器。
throttle = Throttled()

# 消耗 1 次请求,输出:RateLimitResult(limited=False,
# state=RateLimitState(limit=60, remaining=59, reset_after=1, retry_after=0))
print(throttle.limit("key", 1))
# 获取限流器状态,输出:RateLimitState(limit=60, remaining=59, reset_after=1, retry_after=0)
print(throttle.peek("key"))

# 消耗 60 次请求,触发限流,输出:RateLimitResult(limited=True,
# state=RateLimitState(limit=60, remaining=59, reset_after=1, retry_after=60))
print(throttle.limit("key", 60))

作为装饰器

python 复制代码
from throttled import Throttled, exceptions, rate_limiter

# 创建一个每分钟允许通过 1 次的限流器。
@Throttled(key="/ping", quota=rate_limiter.per_min(1))
def ping() -> str:
    return "ping"

ping()
try:
    ping()  # 当触发限流时,抛出 LimitedError。
except exceptions.LimitedError as exc:
    print(exc)  # Rate limit exceeded: remaining=0, reset_after=60, retry_after=60

上下文管理器

你可以使用「上下文管理器」对代码块进行限流,允许通过时,返回 RateLimitResult

触发限流或重试超时,抛出 LimitedError

python 复制代码
from throttled import Throttled, exceptions, rate_limiter

def call_api():
    print("doing something...")

throttle: Throttled = Throttled(key="/api/v1/users/", quota=rate_limiter.per_min(1))
with throttle as rate_limit_result:
    print(f"limited: {rate_limit_result.limited}")
    call_api()

try:
    with throttle:
        call_api()
except exceptions.LimitedError as exc:
    print(exc)  # Rate limit exceeded: remaining=0, reset_after=60, retry_after=60

等待重试

默认情况下,限流判断将「即刻」返回 RateLimitResult

你可以通过 timeout 指定等待重试的超时时间,限流器将根据 RateLimitStateretry_after 进行若干次等待及重试。

一旦请求通过或超时,返回最后一次的 RateLimitResult

python 复制代码
from throttled import RateLimiterType, Throttled, rate_limiter, utils

throttle = Throttled(
    using=RateLimiterType.GCRA.value,
    quota=rate_limiter.per_sec(100, burst=100),
    # ⏳ 设置超时时间为 1 秒,表示允许等待重试,等待时间超过 1 秒返回最后一次限流结果。
    timeout=1,
)

def call_api() -> bool:
    # ⬆️⏳ 函数调用传入 timeout 将覆盖全局设置的 timeout。
    result = throttle.limit("/ping", cost=1, timeout=1)
    return result.limited


if __name__ == "__main__":
    # 👇 实际 QPS 接近预设容量(100 req/s):
    # ✅ Total: 1000, 🕒 Latency: 35.8103 ms/op, 🚀 Throughput: 111 req/s (--)
    # ❌ Denied: 8 requests
    benchmark: utils.Benchmark = utils.Benchmark()
    denied_num: int = sum(benchmark.concurrent(call_api, 1_000, workers=4))
    print(f"❌ Denied: {denied_num} requests")

2)指定存储后端

Redis

下方样例使用 Redis 作为存储后端,options 支持 Redis 的所有配置项,详见 RedisStore Options

python 复制代码
from throttled import RateLimiterType, Throttled, rate_limiter, store

@Throttled(
    key="/api/products",
    using=RateLimiterType.TOKEN_BUCKET.value,
    quota=rate_limiter.per_min(1),
    # 🌟 使用 Redis 作为存储后端
    store=store.RedisStore(server="redis://127.0.0.1:6379/0", options={"PASSWORD": ""}),
)
def products() -> list:
    return [{"name": "iPhone"}, {"name": "MacBook"}]

products()
# raise LimitedError: Rate limit exceeded: remaining=0, reset_after=60
products()

Memory

如果你希望在程序的不同位置,对同一个 Key 进行限流,请确保 Throttled 接收到的是同一个 MemoryStore,并使用一致的 Quota

下方样例使用内存作为存储后端,并在 pingpong 上对同一个 Key 进行限流:

python 复制代码
from throttled import Throttled, rate_limiter, store

# 🌟 使用 Memory 作为存储后端
mem_store = store.MemoryStore()

@Throttled(key="ping-pong", quota=rate_limiter.per_min(1), store=mem_store)
def ping() -> str:
    return "ping"

@Throttled(key="ping-pong", quota=rate_limiter.per_min(1), store=mem_store)
def pong() -> str:
    return "pong"
  
ping()
# raise LimitedError: Rate limit exceeded: remaining=0, reset_after=60
pong()

3)指定限流算法

通过 using 参数指定限流算法,支持算法如下:

python 复制代码
from throttled import RateLimiterType, Throttled, rate_limiter, store

throttle = Throttled(
    # 🌟指定限流算法
    using=RateLimiterType.FIXED_WINDOW.value,
    quota=rate_limiter.per_min(1),
    store=store.MemoryStore()
)
assert throttle.limit("key", 2).limited is True

4)指定容量

快捷创建方式

python 复制代码
from throttled import rate_limiter

rate_limiter.per_sec(60)    # 60 req/sec
rate_limiter.per_min(60)    # 60 req/min
rate_limiter.per_hour(60)   # 60 req/hour
rate_limiter.per_day(60)    # 60 req/day
rate_limiter.per_week(60)   # 60 req/week

调整突发限制

通过 burst 参数,可以调节限流对象处理突发流量的能力 ,对以下算法有效:

  • TOKEN_BUCKET
  • LEAKING_BUCKET
  • GCRA
python 复制代码
from throttled import rate_limiter

# 允许突发处理 120 个请求。
# 未指定 burst 时,默认设置为 limit 传入值。
rate_limiter.per_min(60, burst=120)

自定义配额

python 复制代码
from datetime import timedelta
from throttled import rate_limiter

# 两分钟一共允许 120 个请求,允许突发处理 150 个请求。
rate_limiter.per_duration(timedelta(minutes=2), limit=120, burst=150)

0x06 性能(Benchmarks)

1)环境

  • Python 版本: Python 3.13.1 (CPython)
  • 系统: macOS Darwin 23.6.0 (arm64)
  • Redis 版本: Redis 7.x(本地连接)

2)性能

单位:吞吐量 req/s,延迟 ms/op。

算法类型 内存(串行) 内存(并发,16 线程) Redis(串行) Redis(并发,16 线程)
对比基准 [1] 1,692,307 / 0.0002 135,018 / 0.0004 [2] 17,324 / 0.0571 16,803 / 0.9478
固定窗口 369,635 / 0.0023 57,275 / 0.2533 16,233 / 0.0610 15,835 / 1.0070
滑动窗口 265,215 / 0.0034 49,721 / 0.2996 12,605 / 0.0786 13,371 / 1.1923
令牌桶 365,678 / 0.0023 54,597 / 0.2821 13,643 / 0.0727 13,219 / 1.2057
漏桶 364,296 / 0.0023 54,136 / 0.2887 13,628 / 0.0727 12,579 / 1.2667
GCRA 373,906 / 0.0023 53,994 / 0.2895 12,901 / 0.0769 12,861 / 1.2391
  • [1] 对比基准:内存 - dict[key] += 1,Redis - INCRBY key increment
  • [2] 在内存并发对比基准中,使用 threading.RLock 保证线程安全。
  • [3] 性能:内存 - 约等于 2.5 ~ 4.5 次 dict[key] += 1 操作,Redis - 约等于 1.06 ~ 1.37 次 INCRBY key increment 操作。
  • [4] Benchmarks 程序:tests/benchmarks/test_throttled.py

0x07 了解更多

相关推荐
胡耀超20 分钟前
标签体系设计与管理:从理论基础到智能化实践的综合指南
人工智能·python·深度学习·数据挖掘·大模型·用户画像·语义分析
重庆小透明22 分钟前
力扣刷题记录【1】146.LRU缓存
java·后端·学习·算法·leetcode·缓存
博观而约取1 小时前
Django 数据迁移全解析:makemigrations & migrate 常见错误与解决方案
后端·python·django
熊猫钓鱼>_>1 小时前
用Python解锁图像处理之力:从基础到智能应用的深度探索
开发语言·图像处理·python
蛋仔聊测试2 小时前
Playwright 中特定的 Fixtures
python
寻月隐君2 小时前
Rust 异步编程实践:从 Tokio 基础到阻塞任务处理模式
后端·rust·github
GO兔2 小时前
开篇:GORM入门——Go语言的ORM王者
开发语言·后端·golang·go
蹦蹦跳跳真可爱5892 小时前
Python----大模型(使用api接口调用大模型)
人工智能·python·microsoft·语言模型
Sincerelyplz2 小时前
【Temproal】快速了解Temproal的核心概念以及使用
笔记·后端·开源
爱上语文2 小时前
Redis基础(6):SpringDataRedis
数据库·redis·后端