Dramatiq 验证码任务:正确设置重试和时间限制

dramatiq captcha - Dramatiq CAPTCHA Tasks: Set Retries and Time Limits Right

dramatiq captcha actor 会在三个地方出问题,三处都源于 Dramatiq 的计数方式。它的时间选项以毫秒为单位,它的时间限制无法打断一个正在等待的 socket,它的重试规则会把每一个离开 actor 的异常都算进去。本文把页面获取、CapSkip 识别和表单提交放进一个 actor,然后测量时间限制在哪里能停住它,以及哪些失败值得重试。它在 Windows 上用 StubBroker 运行,所以你不需要 Redis 或 RabbitMQ。

你需要什么

  • 一台运行 CapSkip 且开着 reCAPTCHA 识别的 Windows PC。示例识别的是 reCAPTCHA v2;同样的结构适合其他类型,详见 Python 验证码识别页面.
  • Python 3.10 或更高版本,这是 dramatiq 2.2.1 和 capskip 1.7.0 声明的最低版本。我所有的测试都在 Python 3.11.7 和 3.14.0 上、使用 requests 2.34.2 运行,没有在 3.10 上测试过。
  • 不需要消息 broker。StubBroker 把队列保存在一个进程内。我既没用 Redis 也没用 RabbitMQ,所以这里的内容并不描述真实的 broker,除非某句话说明它来自源码。
  • CapSkip 的地址。在同一台 PC 上,默认的 127.0.0.1 就够了。另一台 PC 上的 worker 需要 Server mode,它让 CapSkip 监听你的网络地址或公网 IP。打开它的位置见 设置指南中的连接设置.

测试:我写了一个模拟的 CapSkip 和一个模拟的注册表单,自己设定模拟服务器的识别时间,没有使用真实的应用或 reCAPTCHA 站点。下面的每个耗时都是模拟的耗时。它表明的是 Dramatiq 和 SDK 在一次识别前后的行为,而不是一次识别要多久,模拟服务器产生的失败是我定的规则,不是 CapSkip 的行为。

把这三个包装进一个全新的虚拟环境:

# Windows, in PowerShell or cmd
python -m venv .venv
.venv\Scripts\python -m pip install dramatiq capskip requests

第 1 步:broker,以及一个能超时的 SDK

把这个代码块放在 tasks.py 的最上面。StubBroker 那一行是唯一和 broker 相关的部分;真实的队列会在那里构建 RedisBroker 或 RabbitmqBroker。这个补丁之所以存在,是因为 capskip 1.7.0 调用 requests.post 和 requests.get 时没有设置超时;我读了安装包里的 api.py。如果 CapSkip 接受了连接却始终不回答,调用会一直等到操作系统允许的极限,Dramatiq 的时间限制帮不上忙。补丁替换的是 capskip.api 内部的 requests 引用,这是 SDK 的内部部分,如果这个引用消失,代码块会在导入时直接报错。SDK 不会读取 CAPSKIP_HOST、CAPSKIP_PORT 和 CAPSKIP_API_KEY,除非你的代码去读,所以这个代码块读取它们并交给构造函数。

# tasks.py, part 1: put this at the top of tasks.py
import functools
import os
import types

import capskip.api
import dramatiq
import requests
from capskip import ApiException, CapSkip, NetworkException, TimeoutException
from dramatiq.brokers.stub import StubBroker
from dramatiq.middleware import TimeLimitExceeded

# The StubBroker keeps the queue inside this process, so it needs no Redis
# or RabbitMQ. In production, build a RedisBroker or a RabbitmqBroker here
# and pass it to dramatiq.set_broker the same way.
broker = StubBroker()
dramatiq.set_broker(broker)

# capskip 1.7.0 calls requests.post and requests.get with no timeout, and
# time_limit cannot interrupt a socket that is waiting. Give every SDK call
# 5 seconds to connect and 30 seconds of silence on a read.
if not hasattr(capskip.api, "requests"):
    raise RuntimeError("capskip changed how it makes HTTP calls: recheck this patch")
capskip.api.requests = types.SimpleNamespace(
    RequestException=requests.RequestException,
    post=functools.partial(requests.post, timeout=(5, 30)),
    get=functools.partial(requests.get, timeout=(5, 30)),
)

# The SDK does not read these variables itself; this code passes them in.
solver = CapSkip(
    apiKey=os.environ.get("CAPSKIP_API_KEY", "capskip"),
    host=os.environ.get("CAPSKIP_HOST", "127.0.0.1"),
    port=int(os.environ.get("CAPSKIP_PORT", "8080")),
)

第 2 步:actor,所有时间都用毫秒

dramatiq captcha actor 加载页面取 cookie,识别,并在一次尝试里提交表单。CapSkip 的结果只能读一次,而 token 大约两分钟后就会过期(reCAPTCHA token 的有效期能持续多久),所以重试必须从页面重新开始。

每个时间选项都以毫秒为单位:这里的 min_backoff 是 15 秒,time_limit 是 8 分钟。8 分钟是算出来的:SDK 轮询 300 秒,加上最多 5 秒的休眠,再加上四次 HTTP 调用,每次可能等 5 秒建立连接、再等 30 秒读取时的静默,CapSkip 沉默时一共约 445 秒。

worth_retrying 在每次失败的尝试之后运行。一次失败的识别以包含 ERROR_CAPTCHA_UNSOLVABLE 的 ApiException 形式到达(该错误是什么意思),下次可能就能成功,无法连上的 CapSkip、SDK 的超时、Dramatiq 的限制,以及表单返回的 403、408、429 或 5xx 也是如此。缺少或格式错误的 sitekey 或页面 URL 会在提交任务时被拒绝,错误码是不含 UNSOLVABLE 的 ERROR_ 开头的代码,错误的 API 密钥也同样被拒绝,所以这些情况会让消息终结;表单返回的、上面三种之外的 4xx 也会让它终结,因为重来还是会得到同样的结果,你代码里的 bug 也一样。格式正确但错误的 sitekey 仍可能以 ERROR_CAPTCHA_UNSOLVABLE 的形式到来,并用完三次重试;我没能在真实应用上测试这一点。

# tasks.py, part 2: add this below part 1
MAX_RETRIES = 3


def worth_retrying(retries_so_far, exc):
    # Dramatiq calls this after every failed attempt. While retry_when is
    # set, max_retries is ignored, so the count lives here.
    if retries_so_far >= MAX_RETRIES:
        return False
    if isinstance(exc, ApiException):
        # CapSkip reports a solve that failed this way. A refused sitekey,
        # page URL or API key would be refused again.
        return "ERROR_CAPTCHA_UNSOLVABLE" in str(exc)
    if isinstance(exc, requests.HTTPError):
        # 403 and 429 can mean a refused or expired token, 5xx a site hiccup;
        # a 404 or 400 would be answered the same way next time.
        status = exc.response.status_code if exc.response is not None else 0
        return status in (403, 408, 429) or status >= 500
    transient = (NetworkException, TimeoutException, TimeLimitExceeded, requests.RequestException)
    return isinstance(exc, transient)


@dramatiq.actor(
    queue_name="captcha",
    retry_when=worth_retrying,
    min_backoff=15_000,  # milliseconds, not seconds
    max_backoff=120_000,
    time_limit=480_000,  # milliseconds as well: 8 minutes
)
def sign_up(sitekey, page_url, email):
    with requests.Session() as session:
        session.get(page_url, timeout=(5, 30))  # picks up the page's cookies
        # Solve inside the attempt, right before the form submission: a result is
        # read once, and a token ages.
        token = solver.recaptcha(sitekey=sitekey, url=page_url)["code"]
        reply = session.post(
            page_url,
            data={"email": email, "g-recaptcha-response": token},
            headers={"Referer": page_url},
            timeout=(5, 30),
        )
        reply.raise_for_status()

第 3 步:用真实的 worker 线程运行,不用 broker

这个脚本在一个进程里启动四个 Dramatiq worker 线程,发送一条消息,并等待队列清空。把它保存为 run_local.py,放在 tasks.py 旁边,把 YOUR_SITEKEY 换成你有权自动化操作的某个页面的 sitekey,运行时在 PAGE_URL 里传入那个页面的地址。

# run_local.py: real worker threads, no Redis or RabbitMQ
import os

from dramatiq import Worker

from tasks import broker, sign_up

# The dramatiq command emits this event for you. It starts the thread
# behind time_limit, so a script has to emit it itself.
broker.emit_after("process_boot")
worker = Worker(broker, worker_threads=4)
worker.start()
try:
    sign_up.send(
        "YOUR_SITEKEY",
        os.environ.get("PAGE_URL", "https://example.com/signup"),
        "[email protected]",
    )
    # fail_fast=False: do not re-raise an actor's exception out of join
    broker.join("captcha", fail_fast=False)
    worker.join()
finally:
    worker.stop()
print("dead-lettered messages:", len(broker.dead_letters))

在存放 tasks.py 的文件夹里,用 PowerShell 运行:

# PowerShell
$env:PAGE_URL = "https://your-page/signup"
.venv\Scripts\python run_local.py

在 cmd 里,运行 set PAGE_URL=https://your-page/signup,然后运行同样的 python 命令。

emit_after 那一行启动 time_limit 背后的监视线程。dramatiq 命令会替你做这件事,脚本必须自己做;没有它,在一次 6 秒的识别上设 2 秒的限制,actor 照样跑了 7.8 到 7.9 秒。Dramatiq 2 里 broker 的 join 方法还会重新抛出死信消息的异常,除非你传 fail_fast=False。在模拟服务器上,运行了一条消息,表单接受了一次提交,脚本打印出 0 条死信消息。

time_limit 能打断什么、不能打断什么

TimeLimit 中间件每秒唤醒一次监视线程。对超过限制的消息,监视线程请 CPython 在 worker 线程里抛出 TimeLimitExceeded,它会在那个线程下次运行 Python 代码时到达。一个在休眠的线程,或一个在等 socket 的线程,没有在运行任何 Python 代码。 Dramatiq 用户指南 给出的默认值是 10 分钟,这已经足以覆盖第 2 步里的算式。

SDK 在两次状态轮询之间休眠,最多 5 秒,所以在休眠中途触发的限制要等休眠结束才生效(下表前两行)。一个沉默的 CapSkip 更糟(第三、四行)。按 SDK 的原样,actor 会一直跑到卡住的调用返回,只有第 1 步的补丁在 30 秒读取超时处限制了它。所以只有每个阻塞调用都有自己的超时,time_limit 才管用。

TimeLimitExceeded 派生自 BaseException,所以针对 Exception 的处理器接不住它。针对 BaseException 的处理器可以,而 Dramatiq 此时会把它算作成功(最后一行)。要记录一次失败的识别,请捕获 CapSkipError。

模拟设置发生了什么
CapSkip 始终不完成,限制 3 秒在 3.8 秒或 7.8 秒处停止,取决于监视线程的一秒节拍与 SDK 休眠错开的位置(我在两个 Python 版本上做的运行中,五次对一次)
CapSkip 始终不完成,限制 8 秒在两个 Python 版本上都约在 12.9 秒处停止
状态调用沉默 25 秒,没有补丁,限制 3 秒限制在 3 到 4 秒时被记录,actor 一直跑到 25.0 秒,从未使用那次回复里的 token
状态调用沉默 45 秒,第 1 步的补丁,限制 3 秒在 30.0 秒处停止
限制写成 330(按秒的习惯),识别 6 秒每次尝试都在 2 秒内停止;浪费了四次识别,然后进入死信
识别外面包着 BaseException 处理器消息被算作成功,没有重试,没有死信

Dramatiq 会重试哪些失败

Retries 中间件默认开启,对验证码来说它的默认值过于宽松。我从一个运行中的 broker 里读出来:20 次重试,最小退避 15 秒,这让第一次重试要等 15 到 30 秒,上限 7 天。一个不带任何选项的 actor 会把被拒绝的 sitekey 重试最多 20 次。

max_retries 选项统计的是重试次数而不是尝试次数,每个离开 actor 的异常都算,TimeLimitExceeded 也不例外。传入 retry_when 就会完全接管,这就是 worth_retrying 保留自己计数的原因。actor 选项 "throws" 按类跳过重试并记录一行 info,但 ApiException 既包含失败的识别,也包含被拒绝的密钥,所以示例使用 retry_when。当 worth_retrying 说不重试时,日志里仍然写着 "Retries exceeded for message";请读它上面那行异常。

每次延迟等于 min_backoff 乘以 2 的已重试次数次方,再乘以一个 1 到 2 的随机因子,如果结果超过 max_backoff,就在 max_backoff 的一半到全部之间重新抽取。取 300 和 2000 时,范围是 300 到 600、600 到 1200 和 1000 到 2000 毫秒,我看到的延迟在 Python 3.11 上是 453、896 和 1599,在 3.14 上是 477、1028 和 1219。每次重试都是一次新的识别,被放弃的那次尝试会在 CapSkip 里留下一个没人读取的任务:在 330 那一行里,提交了四个任务,没有读取任何 token。

模拟设置发生了什么
示例 actor,每次识别都失败4 次识别,3 行重试日志,然后是 "Retries exceeded" 和一条死信
示例 actor,模拟服务器用一个 ERROR_ 错误码拒绝 sitekey(模拟服务器的规则)1 次识别,不重试,进入死信
示例 actor,表单对每次提交都回复 404、405 或 400每次 1 次识别,不重试,进入死信
普通 actor,max_retries 为 3,抛出被拒绝密钥的错误4 次运行了一个永远不可能成功的请求
站点对第一次表单提交回复 4032 次识别,第二个 token 被接受
普通 actor,throws 设为 ValidationException,并抛出它1 次运行,一行 info,进入死信

Windows 上的 worker:线程、停止与 Server mode

dramatiq 命令会加载你指定的模块,所以 tasks.py 里的 broker 那一行决定 worker 消费什么。用 StubBroker 时,启动的 worker 只是空转,因为每个进程有自己的队列;我只用它来检查这个命令。默认情况下,它每个逻辑处理器启动一个进程,每个进程 8 个线程。这台 PC 有 24 个,默认打印了 24 行 "Worker process is ready for action":192 个线程,每个都能启动一次识别。CapSkip 默认设为同时运行 10 个 reCAPTCHA 识别(Max. Threads 设置;我没有运行应用,所以请核对你自己的值),而在 CapSkip 里排队的任务仍会消耗 actor 的时间限制。从一个进程、十个线程开始:

# From the folder that holds tasks.py: one process, ten threads
.venv\Scripts\dramatiq tasks --processes 1 --threads 10

为停止做好准备。我用一个慢速的模拟识别启动了命令,并向它发送 Ctrl+Break。命令不到 2 秒后退出,退出码为 21。在两个 Python 上做了六次停止,结果相同,其中两次是在识别已经结束之后,另外四次未完成的识别从未被读取。主进程用 os.kill 把信号转发给它的 worker,而 CPython 文档 写明,在 Windows 上 os.kill 会对除两个控制台事件之外的任何信号编号直接结束进程,并用这个编号作为退出码。21 就是那个编号。我没有测试 Ctrl+C 或服务停止,所以请把每一次停止都当成对正在运行的识别的一次强制终止。

Dramatiq 只会在 actor 结束之后才确认一条消息。在 Redis broker 的源码里,已死亡 worker 的未确认消息,会在它的心跳过期 60 秒(默认值)之后回到队列。我读到了这一点,没有运行过。不管哪种情况,消息都会从页面重新开始。

要让另一台 PC 上的 worker 使用,请把 CapSkip 切换到 Server mode,然后在 dramatiq 命令的环境里设置 CAPSKIP_HOST(如果开启了 API key validation,还要设置 CAPSKIP_API_KEY)。开启 Server mode 会向任何地址开放 CapSkip 端口,所以请用 Windows Firewall 阻止规则挡住所有不是你 worker 的机器。识别仍然发生在你自己的 Windows 机器上,每次识别不花钱。

常见的 Dramatiq 验证码错误

你所看到的原因修复
一次尝试之后出现 "Retries exceeded"worth_retrying 拒绝了格式错误的 sitekey、页面 URL 或 API 密钥,或者表单返回的 4xx读它上面的异常,修正输入
每次尝试都报 NetworkExceptionCapSkip 已关闭,或者它在 127.0.0.1 上而 worker 在另一台 PC 上启动它,或者使用 Server mode;见 API 文档

常见问题

StubBroker 足够用来测试 Dramatiq 验证码 actor 吗?

对 actor 本身的逻辑来说,足够:重试、退避、时间限制和死信都用真实的 worker 线程在这里跑过了。它无法展示 broker 带来的东西,比如 worker 死亡后的重新投递。

另一台机器上的 worker 能访问 CapSkip 吗?

可以,通过 Server mode。在一台有可访问地址的 Windows 机器上运行 CapSkip,并在 worker 的环境里设置 CAPSKIP_HOST。actor 不用改。

Dramatiq 和 Celery 在这方面有什么不同?

Dramatiq 只有一个时间限制,单位是毫秒,它的错误是 BaseException,而重试规则是你自己写的一个函数。延迟确认和预取的内容见指南 在 Celery 任务里识别验证码.

简短版结论

对于 dramatiq captcha actor,把获取、识别和表单提交放在一次尝试里,所有时间都用毫秒来写,并给 SDK 的 HTTP 调用设置超时,这样 time_limit 才能碰到那个线程。失败的识别、沉默的 CapSkip 或被拒绝的表单都要重试,并预料到 Windows 上的停止会杀掉正在运行的识别。有了一个 本地验证码识别工具 ,它运行在你自己的硬件上,所以一次重试或一次被杀掉的识别只花时间,别的什么都不花。