Web Auto Form

概述#

web-auto-form 是一个 JSON 配置驱动的浏览器自动化引擎，专为表单填写、提交与结构化数据提取设计。你只需用 JSON 描述"做什么"，引擎自动处理浏览器生命周期、选择器解析、重试与错误恢复。它内置完整的 OpenAI/Claude function-calling JSON Schema，可被任何兼容 LLM 的 AI Agent 直接调用，无需额外封装。

核心价值： 零代码、确定性执行、AI Agent 原生集成、内置隐私脱敏。

---

触发条件#

当用户请求包含以下关键词或意图模式时，应调用 web_auto_form tool：

中文关键词#

"填表"、"自动提交"、"网页操作"、"自动注册"、"登录"、"注册"、"报名"、"申请"、"批量录入"、"定时提交"、"表单测试"

英文关键词#

"fill out form"、"submit form"、"auto-register"、"web automation"、"data entry"、"sign up"、"apply"、"form testing"、"batch submit"

意图模式#

• 多步浏览器交互（navigate → fill → click → extract）
• 表单提交（含文件上传、下拉选择、复选框）
• 批量数据录入（同一表单、不同数据重复填写）
• 条件表单逻辑（根据页面状态分支执行）
• 结合 URL 的动作动词组合：navigate + fill + submit、open + select + click、register + upload + confirm

不应调用的场景#

• 纯信息检索（应使用 WebFetch / WebSearch）
• 不涉及浏览器 UI 的纯 API 调用
• 需要人工验证码识别或生物特征验证的任务
• 无具体表单填写目标的大规模爬取

---

安全约束#

#约束说明1consent 必填每次调用必须包含 consent_statement 声明自动化目的，执行前记录于日志；非 headless 模式下展示并要求用户确认2禁止凭证收割不得用于抓取登录页存储的凭据、密码管理器填充数据或窃取 session token3无破坏性批量操作单次调用上限 50 步，超出需逐批获得用户确认4不绕过安全控制除非用户拥有明确授权（如自有测试环境），否则不自动化解验证码、2FA 绕过或反爬规避5域名建议白名单默认允许所有 HTTPS URL；HTTP URL 执行前给出安全警告6PII 脱敏 — 全局开关options.redact_pii（默认 true）同时控制日志输出和提取文本的脱敏；可通过 extract_schema.fields[].redact 逐字段覆盖7浏览器沙箱options.sandbox: true（默认）强制沙箱模式，防止恶意页面逃逸。仅当对可信本地测试服务器运行时才可禁用8速率限制options.step_delay_ms（默认 500ms，最小 100ms）在每步之间强制执行，防止触发反爬保护9透明性始终报告哪些步骤成功、跳过（optional）或失败——绝不静默吞掉错误

---

安装与依赖#

bash

pip install web-auto-form
playwright install chromium

Python 3.9+ 所需。引擎基于 Playwright 构建，Chromium 浏览器通过上述第二条命令安装。

---

快速开始#

最小可运行 JSON 配置（3 步：填写姓名 → 填写邮箱 → 点击提交）：

json

{
  "url": "https://example.com/apply",
  "consent_statement": "自动化填写个人数据。",
  "steps": [
    {"action": "fill", "selector": "#name",  "value": "张三"},
    {"action": "fill", "selector": "#email", "value": "zhangsan@example.com"},
    {"action": "click", "selector": "button[type='submit']"}
  ]
}

运行方式：

bash

# CLI
web_auto_form run my_form.json

# 命令行覆盖数据变量
web_auto_form run my_form.json --data user.name=李四

# 有头模式 + 调试
web_auto_form run my_form.json --no-headless --debug

Python API：

python

from web_auto_form import run, run_from_path

result = run(config_dict)       # 从 dict 执行
result = run_from_path("config.json")  # 从文件执行
print(result["status"])         # "success" | "partial" | "failed"
print(result["extracted"])      # {"field_name": "extracted value", ...}

---

完整配置参考#

顶层字段#

字段类型必填说明urlstring是起始 URL（HTTPS 或 HTTP，后者触发安全警告）consent_statementstring是自动化目的声明，记录于日志stepsStepConfig[]是有序动作列表（1–50 步）dataobject否模板变量字典，通过 {{key}} 语法访问，支持嵌套点号extract_schemaExtractSchemaConfig否执行完成后的结构化提取规则optionsOptionsConfig否全局执行设置

全局选项#

选项类型默认值说明headlessbooltrue无头模式运行浏览器viewport_widthint1280视口宽度（px）viewport_heightint800视口高度（px）user_agentstring—自定义 User-Agent 字符串localestring"en-US"浏览器 localestep_delay_msint500步骤间强制延迟（最小 100ms，最大 10000ms）max_retriesint1可重试错误的全局最大重试次数（1–5）retry_onstring[]["NETWORK_ERROR"]全局可重试错误类型列表sandboxbooltrue浏览器沙箱模式redact_piibooltrue全局 PII 脱敏开关（日志 + 提取输出）debugboolfalse保存每步截图、HTML 快照和 Playwright tracedebug_output_pathstring"./web_auto_form_debug_<timestamp>/"调试产物输出目录keep_openboolfalse完成后保持浏览器打开upload_enforce_extensionboolfalse当 file_name 扩展名与 MIME 不匹配时是否阻止上传

---

13 种 Action 类型详解#

导航与交互类#

navigate — 页面导航

字段类型必填说明action``"navigate"是—valuestring是目标 URLtimeout_msint否导航超时（默认 30000ms，最大 60000ms）descriptionstring否步骤描述（支持 {{}} 模板）

fill — 输入框填写

字段类型必填说明action``"fill"是—selectorstring是目标输入框选择器valuestring是要输入的文本（支持 {{}} 模板）selector_typestring否显式指定选择器类型（ css/ xpath/ id/ name/ placeholder/ data-testid）selector_fallbacksstring[]否备用选择器链timeout_msint否等待元素出现超时（默认 5000ms）optionalbool否找不到元素时是否跳过（默认 false）on_skipstring否optional 步骤跳过行为（ log/ abort/ set_default）descriptionstring否步骤描述

click — 元素点击

字段类型必填说明action``"click"是—selectorstring是目标元素选择器selector_typestring否显式选择器类型selector_fallbacksstring[]否备用选择器链timeout_msint否等待元素出现超时optionalbool否是否可选（默认 false）on_skipstring否可选步跳过行为screenshotbool否点击后截图（默认 false）descriptionstring否步骤描述

select — 下拉选择

字段类型必填说明action``"select"是—selectorstring是<select> 元素选择器valuestring是选项文本或 value 属性值selector_type / selector_fallbacks / timeout_ms / optional / on_skip / description—否同上

check — 复选框切换

字段类型必填说明action``"check"是—selectorstring是checkbox/radio 选择器value``"true" / "false"是选中或取消selector_type / selector_fallbacks / timeout_ms / optional / on_skip / description—否同上

upload — 文件上传

字段类型必填说明action``"upload"是—selectorstring是<input type="file"> 选择器valuestring是文件来源（见下方 4 种格式）file_namestring否覆盖上传文件名（支持 {{}} 模板）selector_type / selector_fallbacks / timeout_ms / optional / on_skip / description—否同上

文件来源 4 种格式：

格式示例行为本地路径file:///documents/resume.pdf从宿主机文件系统读取HTTPS URLhttps://cdn.example.com/resume.pdf下载到临时文件后上传Data URIdata:application/pdf;base64,JVBERi0...内存解码后上传相对路径./uploads/resume.pdf相对于工作目录解析

press_key — 键盘按键

字段类型必填说明action``"press_key"是—valuestring是按键名称（ "Enter", "Tab", "Escape", "ArrowDown" 等）selectorstring否目标元素（省略则聚焦当前活跃元素）descriptionstring否步骤描述

scroll — 页面滚动

字段类型必填说明action``"scroll"是—valuestring是"up", "down" 或像素值（如 "500"）selectorstring否滚动到指定元素（省略则滚动页面）descriptionstring否步骤描述

handle_dialog — 对话框处理

字段类型必填说明action``"handle_dialog"是—value``"accept" / "dismiss"是接受或关闭浏览器原生对话框descriptionstring否步骤描述

流程控制类#

wait — 等待

字段类型必填说明action``"wait"是—typestring否等待子类型（默认 "element"）selectorstring条件type=element 时必填valuestring条件type=timeout 或 type=function 时必填timeout_msint否最大等待时间（默认 5000ms）descriptionstring否步骤描述

4 种等待子类型：

type行为value 字段Schema 约束element（默认）轮询直到 selector 出现在 DOM忽略—navigation等待 URL 变化或 load 事件忽略—timeout无条件休眠必填：毫秒数字符串（如 "3000"）必须匹配 ^[0-9]+$``function轮询直到 JS 表达式返回 truthy必填：JS 表达式字符串必须非空

if — 条件分支

字段类型必填说明action``"if"是—conditionobject是条件定义（见下方两种模式）thenStepConfig[]是条件为 true 时执行的步骤列表elseStepConfig[]否条件为 false 时执行的步骤列表descriptionstring否步骤描述

条件模式 1 — 基于状态（state-based）：

检查元素的存在性/可见性/选中状态：

json

"condition": { "selector": "#checkbox", "state": "checked" }

支持的 state 值： exist, not_exist, visible, hidden, checked

条件模式 2 — 基于值（value-based）：

比较元素属性值与期望值：

json

"condition": {
  "selector": ".status",
  "attribute": "textContent",
  "operator": "eq",
  "expected_value": "已通过"
}

支持的 operator 值： eq, ne, contains, matches_regex

注意：两种模式互斥。若同时提供 state 和 operator， operator 优先。嵌套深度上限 3 层。

assert — 断言

字段类型必填说明action``"assert"是—selectorstring是待验证的元素选择器statestring是期望状态（ exist, not_exist, visible, hidden, enabled, disabled, checked）on_failstring否失败行为： abort（默认）/ continue / retry``max_retriesint否步骤级重试次数覆盖（ on_fail=retry 时有效）timeout_msint否等待状态满足的超时时间descriptionstring否步骤描述

extract — 运行时提取

字段类型必填说明action``"extract"是—selectorstring是提取目标元素选择器attributestring否提取目标（ text/ innerHTML/ value/任意 HTML 属性，默认 text）descriptionstring否步骤描述

与 extract_schema 不同， extract action 可在步骤序列中间实时提取。

通用步骤字段#

以下字段适用于大部分交互类动作（ fill, select, check, click, upload 等）：

字段类型默认值说明selector_typestring自动检测显式指定选择器类型selector_fallbacksstring[]—备用选择器链，按顺序尝试timeout_msint5000等待元素出现的最长时间optionalboolfalse找不到元素时是否跳过on_skipstring"log"跳过行为： log/ abort/ set_default``screenshotboolfalse步骤执行后截图max_retriesint继承全局步骤级重试次数（1–5）retry_onstring[]继承全局步骤级可重试错误类型descriptionstring—步骤描述（支持 {{}} 模板）

---

选择器系统#

自动类型检测#

选择器通过前缀自动检测类型，无需显式声明 selector_type：

前缀类型示例//XPath//div[@class='form']/input``#ID#email``[name=name 属性[name='email']``[placeholder=placeholder 属性[placeholder='Phone number']``[data-testid=data-testid 属性[data-testid='email-input']（其他）CSS 选择器div.form > input[type='text']

Fallback 链与 optional 逻辑#

解析顺序：

1. 尝试主选择器 selector

2. 若主选择器失败，按序尝试 selector_fallbacks[i]

3. 任一选择器匹配，立即使用该元素执行

4. 仅当 全部选择器（主 + 所有 fallback）在 timeout_ms 内全部失败时，触发 optional 逻辑：

   • optional: true + on_skip: "log" → 记录警告，继续执行
   • optional: true + on_skip: "abort" → 终止执行
   • optional: true + on_skip: "set_default" → 使用 value 作为 fallback 值，继续执行
   • optional: false → 抛出 ELEMENT_NOT_FOUND 错误，终止

json

{
  "action": "fill",
  "selector": "#email",
  "selector_fallbacks": ["[name='email']", "[data-testid='email-input']"],
  "value": "user@example.com"
}

最佳实践#

• 优先使用 data-testid 或稳定的 CSS class，避免自动生成的动态 ID（如 id="input_123456"）
• 为关键步骤提供 selector_fallbacks（提交按钮、文件输入等）
• XPath 仅用于 CSS 无法表达的关系（如文本匹配、兄弟节点遍历），CSS 选择器更快、更可读
• 避免依赖 DOM 位置索引 的脆弱选择器（如 div > div:nth-child(3) > input），优先使用语义化属性

---

模板变量#

data 对象支持 {{key}} 语法，通过点号访问嵌套字段。支持的字段包括： value, selector, selector_fallbacks, file_name, description, extract_schema.fields[].selector。

注入安全：选择器中的模板变量仅限于属性值位置，运行时校验渲染后的选择器无法逃逸其语法上下文（例如 [name='{{x}}'] 中的变量将进行 HTML 实体转义）。

json

{
  "data": {
    "user": {
      "name": "Zhang Wei",
      "email": "zhangwei@example.com"
    },
    "target_position": "Software Engineer"
  },
  "steps": [
    {"action": "fill", "selector": "[name='fullname']", "value": "{{user.name}}"},
    {"action": "fill", "selector": "[name='email']", "value": "{{user.email}}"},
    {"action": "select", "selector": "#position", "value": "{{target_position}}"}
  ]
}

CLI 中可通过 --data 覆盖模板变量：

bash

web_auto_form run config.json --data user.name=李四 --data target_position="Product Manager"

---

结构化提取#

extract_schema 在全部步骤完成后批量提取指定元素的内容：

json

{
  "extract_schema": {
    "fields": [
      {"name": "confirmation_message", "selector": ".success-message", "attribute": "text", "redact": false},
      {"name": "application_id", "selector": ".app-id", "attribute": "text", "redact": false},
      {"name": "user_email_displayed", "selector": ".confirmation-email", "attribute": "text", "redact": true}
    ],
    "screenshot": true
  }
}

字段类型必填说明namestring是输出结果中的字段名selectorstring是CSS/XPath 选择器（支持 {{}} 模板）attributestring否提取目标： "text"（默认）/ "innerHTML" / "value" / 任意 HTML 属性名redactbool否逐字段覆盖全局 redact_pii 设置。 false 保留原始值

如需在步骤序列中间提取数据，使用 extract action 而非 extract_schema。

---

输出格式#

工具返回标准 JSON 结构：

json

{
  "status": "success | partial | failed",
  "consent_logged": "Automating a job application form submission...",
  "steps_executed": 14,
  "steps_skipped": 1,
  "steps_failed": 0,
  "results": [
    {"step": 0, "action": "wait", "status": "ok", "duration_ms": 1200},
    {"step": 1, "action": "fill", "status": "ok", "duration_ms": 340},
    {"step": 12, "action": "assert", "status": "ok", "duration_ms": 800, "retries": 2}
  ],
  "step_screenshots": [
    {"step": 10, "screenshot": "base64-encoded-png"}
  ],
  "extracted": {
    "confirmation_message": "Your application has been submitted successfully.",
    "application_id": "APP-20260527-0042",
    "user_email_displayed": "***@***.***"
  },
  "final_screenshot": "base64-encoded-png-or-null",
  "debug_artifacts": null,
  "errors": []
}

字段类型说明statusstring"success" — 全部步骤成功； "partial" — 部分 optional 步骤跳过但无错误； "failed" — 存在步骤失败steps_executedint实际执行的步骤数steps_skippedint跳过的 optional 步骤数steps_failedint失败的步骤数resultsarray每个步骤的执行结果（含耗时）extractedobject结构化提取输出（key 来自 extract_schema.fields[].name）errorsarray错误详情列表

---

重试策略#

区分瞬时错误与永久错误，在全局和步骤两级控制：

错误分类#

错误类型行为默认是否重试NETWORK_ERROR连接重置、DNS 失败、网络层超时是TIMEOUT在 timeout_ms 内找不到元素、JS 条件未满足否NAVIGATION_FAILED页面未加载、重定向循环、HTTP 5xx是ELEMENT_NOT_FOUND所有选择器（主+fallback）均失败且 optional=false否ASSERTION_FAILED``assert 动作检测到非预期状态取决于 on_fail

两级配置#

全局级（ options 中设置，适用于所有步骤）：

json

"options": {
  "max_retries": 2,
  "retry_on": ["NETWORK_ERROR", "NAVIGATION_FAILED"]
}

步骤级（覆盖全局，仅对当前步骤有效）：

json

{
  "action": "assert",
  "selector": ".success-message",
  "state": "visible",
  "on_fail": "retry",
  "max_retries": 3,
  "description": "重试最多 3 次确认成功消息出现"
}

断言重试语义#

当 on_fail: "retry" 时，引擎仅重新执行 assert 步骤本身（重新检查元素状态），最多 max_retries 次，每次间隔 step_delay_ms。全部重试失败后 fallback 为 abort。输出 results 中记录实际重试次数。

---

调试模式#

当 options.debug: true 时，引擎在 debug_output_path（默认 ./web_auto_form_debug_<timestamp>/）生成以下产物：

产物说明每步截图PNG 格式，记录每个步骤执行后的页面状态HTML 快照每个步骤执行后的完整 DOM 快照Playwright Trace完整的 Playwright 追踪日志，可用 playwright show-trace 回放浏览器保持打开debug 模式下默认 keep_open: true，便于手动检查

---

与竞品对比#

维度web-auto-formPlaywrightSeleniumBrowser-Use工作方式JSON 配置编写代码编写代码自然语言学习曲线零门槛中等陡峭零门槛最适合批量表单填写、数据录入、注册自动化、CI 表单测试、 LLM Agent 工具现代 Web 测试、复杂 SPA 场景遗留企业系统、跨浏览器测试一次性探索任务、调研爬取AI Agent 集成****原生支持 — 内置 JSON 工具模式和系统提示需自行封装需自行封装内置（但间接）确定性100% 确定性确定性确定性非确定性（LLM 决策）执行速度快（无 LLM 推理开销）快中等慢（每步调用 LLM）隐私脱敏****内置 — 自动脱敏邮箱、电话、身份证号手动处理手动处理手动处理条件逻辑JSON 声明式 if/ else代码驱动代码驱动提示词驱动选择器韧性自动检测 + fallback 链手动处理手动处理LLM 驱动（不可靠）调试产物每步自动截图 + HTML 快照 + Playwright TraceTrace viewer手动截图有限单次运行成本免费（本地执行）免费免费每步产生 LLM API 费用

选型一句话：

• 填 表单 → web-auto-form
• 写 测试 → Playwright
• IE11/老旧系统 → Selenium
• 一次性探索 → Browser-Use

---

限制与上限#

约束项硬限制单次调用最大步骤数50嵌套深度上限（if/else）3 层单步最大超时60,000 ms（1 分钟）最大总执行时间300,000 ms（5 分钟）单步最大重试次数5最大文件上传大小50 MB最小步骤延迟100 ms默认步骤延迟500 msCLI 单次运行超时5 分钟最大视口宽度3840 px最大视口高度2160 px

---

完整工作流示例#

以下示例展示模板变量、条件分支、选择器回退、文件上传、断言、结构化提取等全部特性（来自 examples/job_application.json）：

json

{
  "url": "https://example.com/apply",
  "consent_statement": "自动化提交职位申请表，用于个人数据录入。",
  "data": {
    "user": {
      "name": "Zhang Wei",
      "email": "zhangwei@example.com",
      "phone": "+86 138-0000-1234"
    },
    "resume_path": "file:///documents/resume.pdf",
    "target_position": "Software Engineer"
  },
  "steps": [
    {
      "action": "wait",
      "selector": "form#application",
      "type": "element",
      "timeout_ms": 10000,
      "description": "等待申请表加载完成"
    },
    {
      "action": "fill",
      "selector": "#fullname",
      "value": "{{user.name}}",
      "description": "填写姓名"
    },
    {
      "action": "fill",
      "selector": "input[name='email']",
      "value": "{{user.email}}",
      "description": "填写邮箱"
    },
    {
      "action": "fill",
      "selector": "[placeholder='Phone number']",
      "selector_fallbacks": ["input[type='tel']", "input[name='phone']"],
      "value": "{{user.phone}}",
      "optional": true,
      "on_skip": "log",
      "description": "填写电话（可选字段，带选择器回退）"
    },
    {
      "action": "select",
      "selector": "#position",
      "value": "{{target_position}}",
      "description": "选择目标职位"
    },
    {
      "action": "if",
      "condition": { "selector": "#has_experience", "state": "checked" },
      "then": [
        {
          "action": "fill",
          "selector": "#years_experience",
          "value": "5",
          "description": "填写工作年限"
        }
      ],
      "else": [
        {
          "action": "check",
          "selector": "#fresh_graduate",
          "value": "true",
          "optional": true,
          "description": "标记为应届毕业生"
        }
      ],
      "description": "根据工作经验动态显示不同字段"
    },
    {
      "action": "upload",
      "selector": "input[type='file']",
      "value": "{{resume_path}}",
      "file_name": "{{user.name}}_Resume.pdf",
      "description": "上传简历"
    },
    {
      "action": "check",
      "selector": "#agree-terms",
      "value": "true",
      "description": "同意条款"
    },
    {
      "action": "click",
      "selector": "button[type='submit']",
      "selector_fallbacks": ["input[type='submit']", "[data-testid='submit-btn']"],
      "description": "点击提交（带多重回退选择器）"
    },
    {
      "action": "wait",
      "type": "navigation",
      "timeout_ms": 10000,
      "description": "等待提交后页面跳转"
    },
    {
      "action": "assert",
      "selector": ".error-message",
      "state": "not_exist",
      "on_fail": "abort",
      "description": "验证无错误消息"
    },
    {
      "action": "assert",
      "selector": ".success-message",
      "state": "visible",
      "timeout_ms": 15000,
      "on_fail": "retry",
      "max_retries": 3,
      "description": "确认成功消息出现（最多重试 3 次）"
    }
  ],
  "extract_schema": {
    "fields": [
      {"name": "confirmation_message", "selector": ".success-message", "attribute": "text", "redact": false},
      {"name": "application_id", "selector": ".app-id", "attribute": "text", "redact": false},
      {"name": "user_email_displayed", "selector": ".confirmation-email", "attribute": "text", "redact": true}
    ],
    "screenshot": true
  },
  "options": {
    "headless": false,
    "step_delay_ms": 500,
    "viewport_width": 1280,
    "viewport_height": 900,
    "sandbox": true,
    "redact_pii": true,
    "debug": false
  }
}

此示例完整覆盖了：模板变量 {{user.name}}、选择器 fallback 链、optional 步骤 + on_skip、状态条件分支 if/else、文件上传、多重断言（含 retry 策略）、结构化提取（含逐字段 redact 覆盖）、导航等待。

---

AI Agent 集成要点#

作为 Function-Calling Tool 使用#

本 Skill 对应的完整 JSON Schema 定义在 web_auto_form_tool.json，可直接接入任何兼容 OpenAI/Claude function-calling 的 Agent 管道。

集成方式：

1. 将 web_auto_form_tool.json 的内容注册为 Agent 的 tool definition
2. 将本文档的触发条件部分纳入 Agent 的 system prompt
3. Agent 收到匹配的用户请求后，构造符合 Schema 的 JSON 配置作为 tool call arguments
4. 在 Agent 端执行 web_auto_form run（或 Python API run()），将返回的 JSON 结果传回 Agent 上下文

Python API 快速集成#

python

from web_auto_form import run

# Agent 将 LLM 生成的配置传给引擎
config = {
    "url": "https://example.com/form",
    "consent_statement": "Agent-driven form submission",
    "steps": [
        {"action": "fill", "selector": "#name", "value": "Alice"},
        {"action": "click", "selector": "button[type='submit']"}
    ]
}

result = run(config)
# 将 result 返回给 LLM 上下文，让 Agent 基于提取结果继续对话

---

项目资源#

资源路径JSON Tool Schemaweb_auto_form_tool.jsonSystem Prompt 集成指南SYSTEM_PROMPT.md步骤参考（全部参数）docs/STEPS.md选择器指南docs/SELECTORS.mdPII 脱敏详解docs/PII_REDACTION.mdAI Agent 集成指南docs/AI_AGENT_INTEGRATION.md示例配置examples/在线 Playgroundplayground/