Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b267ca3266 | |||
| 87ef00835b | |||
| c7d7832749 |
2
.github/workflows/release_skill.yaml
vendored
2
.github/workflows/release_skill.yaml
vendored
@@ -5,7 +5,7 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
uses: admin/jiangchang-platform-kit/.github/workflows/reusable-release-skill.yaml@main
|
uses: admin/jiangchang-platform-kit/.github/workflows/reusable-release-skill.yaml@v1.0.14
|
||||||
secrets:
|
secrets:
|
||||||
PYARMOR_REG_B64: ${{ secrets.PYARMOR_REG_B64 }}
|
PYARMOR_REG_B64: ${{ secrets.PYARMOR_REG_B64 }}
|
||||||
with:
|
with:
|
||||||
|
|||||||
8
.gitignore
vendored
8
.gitignore
vendored
@@ -1,4 +1,10 @@
|
|||||||
__pycache__/
|
__pycache__/
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
.env
|
.env
|
||||||
*.env.local
|
*.env.local
|
||||||
|
.pytest_cache/
|
||||||
|
.coverage
|
||||||
|
htmlcov/
|
||||||
|
dist/
|
||||||
|
build/
|
||||||
|
*.egg-info/
|
||||||
136
README.md
136
README.md
@@ -1,80 +1,94 @@
|
|||||||
# 匠厂 技能开发模板(通用业务)
|
---
|
||||||
|
description: "用用户能理解的方式说明这个技能能做什么、适合什么场景,以及如何开始使用。"
|
||||||
|
---
|
||||||
|
|
||||||
这是一个**规范化的新技能模板仓库**,用于复制出新的 skill 项目;它本身**不是业务 skill**。
|
# 【技能名称】
|
||||||
|
|
||||||
## 模板目标
|
> 用一两句话说明这个技能帮助用户完成什么工作。
|
||||||
|
> 这里不要解释技术实现,要从用户的业务目标出发描述价值。
|
||||||
|
|
||||||
- 对齐当前规范 skill 的目录结构:`assets/`、`references/`、`scripts/`、`tests/`、`evals/`
|
---
|
||||||
- 对齐当前规范脚手架分层:`scripts/cli`、`scripts/db`、`scripts/service`、`scripts/util`;公共能力从共享 runtime 的 `jiangchang-platform-kit` 引用
|
|
||||||
- 提供最小可运行入口:`python scripts/main.py health` / `config-path` / `version`,以及通用任务命令骨架 `run` / `logs` / `log-get`
|
|
||||||
- 内置 **配置 bootstrap**:`.env.example` 首次落盘到 `{DATA_ROOT}/{USER_ID}/{slug}/.env`,升级后合并缺失 key(见 `scripts/util/config_bootstrap.py`)
|
|
||||||
- 内置 **隔离测试体系**:`IsolatedDataRoot`、双键环境、`OPENCLAW_TEST_TARGET` 档位与 adapter profile 策略(详见 [`references/TESTING.md`](references/TESTING.md))
|
|
||||||
- 让新技能从一开始就按规范落地,不再沿用旧模板的 `docs/`、`optional/`、`skill_main.py` 结构
|
|
||||||
|
|
||||||
## 新技能使用步骤
|
## 这个技能能帮你做什么
|
||||||
|
|
||||||
1. 复制本目录为新的 skill 仓库。
|
用 3 到 6 条业务能力说明技能价值,例如:
|
||||||
2. 全局替换 `your-skill-slug`、`your-platform-key`、`您的技能显示名称` 等占位内容。
|
|
||||||
3. 修改 `SKILL.md`、`references/` 和 `scripts/util/constants.py`。
|
|
||||||
4. 在 `scripts/service/task_service.py` 中实现真实业务编排与外部系统对接。
|
|
||||||
5. 运行 `python tests/run_tests.py -v`,再执行 `python scripts/main.py health`、`version` 做最小验证。
|
|
||||||
|
|
||||||
如果你的技能在平台里默认是非公开的(`access_scope = 0`),建议在 `SKILL.md` 的 `metadata.openclaw.developer_ids` 中填写开发者用户 ID 列表。这样在正式发布后,平台会为这些开发者补可见权限,避免「技能已上架但开发者自己在市场中看不到」。
|
- 【自动整理/查询/生成/同步/核对/提交】某类业务数据
|
||||||
|
- 帮你减少重复操作,降低人工录入或核对成本
|
||||||
|
- 在任务完成后给出清晰的处理结果、失败原因或后续建议
|
||||||
|
|
||||||
开发教程入口:
|
---
|
||||||
|
|
||||||
- <a href="references/REQUIREMENTS.md" target="_blank" rel="noopener noreferrer">需求文档模板</a>:给技术人员编写和查看研发需求的标准模板
|
## 适合什么场景
|
||||||
- <a href="references/DEVELOPMENT.md" target="_blank" rel="noopener noreferrer">开发教程</a>:给技术人员的完整开发步骤说明
|
|
||||||
- <a href="references/TESTING.md" target="_blank" rel="noopener noreferrer">测试开发指南</a>:默认套件、隔离数据根、档位开关与 FakeAdapter 怎么用
|
|
||||||
|
|
||||||
## 目录说明
|
列出典型使用场景。请使用用户熟悉的业务语言,例如:
|
||||||
|
|
||||||
| 路径 | 用途 |
|
- 每天需要重复处理同一类订单、单据、报表或客户资料
|
||||||
|------|------|
|
- 需要从多个系统中查询信息并汇总结果
|
||||||
| `SKILL.md` | 技能清单与触发说明模板 |
|
- 需要按固定规则检查数据是否完整、是否异常
|
||||||
| `assets/` | 示例输出与轻量 schema |
|
- 需要把处理结果保存为文件、记录或任务报告
|
||||||
| `references/` | 面向用户与编排的文档模板 |
|
|
||||||
| `scripts/` | 规范分层后的代码骨架 |
|
|
||||||
| `tests/` | 单元测试与分层测试范式(默认根目录 unittest) |
|
|
||||||
| `evals/` | 人工/半自动评估材料 |
|
|
||||||
| `requirements.txt` | 本技能 Python 三方依赖声明(由匠厂宿主安装到共享 runtime) |
|
|
||||||
| `.github/workflows/release_skill.yaml` | 标准发布工作流 |
|
|
||||||
| `release.ps1` | 对齐现有 skill 的发布脚本入口 |
|
|
||||||
|
|
||||||
## 最小命令
|
---
|
||||||
|
|
||||||
```bash
|
## 使用前需要准备什么
|
||||||
python scripts/main.py health
|
|
||||||
python scripts/main.py version
|
|
||||||
```
|
|
||||||
|
|
||||||
## 注意
|
说明用户在使用前要准备的东西,例如:
|
||||||
|
|
||||||
- 不要再往模板里引入旧式 `docs/` 或 `optional/` 目录。
|
- 相关账号已登录,且具备查询、导出或提交权限
|
||||||
- 新技能若不需要某些目录,也建议先保留结构,再按实际业务填充内容。
|
- 需要处理的文件、时间范围、订单号、客户名称、项目名称等信息
|
||||||
- `metadata.openclaw.developer_ids` 是发布元数据,不是用户展示文案;用于非公开技能的开发者默认可见授权。
|
- 如果涉及外部系统,请确认网络、账号、验证码或审批流程可正常使用
|
||||||
- **发起 `release.ps1` 之前**,务必确认 `python tests/run_tests.py -v` 已全部通过。
|
|
||||||
|
|
||||||
## Python 依赖(requirements.txt)
|
---
|
||||||
|
|
||||||
- `jiangchang-platform-kit`、`playwright`、config、runtime diagnostics、RPA 公共能力等由**宿主共享 runtime** 提供;`jiangchang_skill_core` **不在技能仓库内复制**。
|
## 你可以这样告诉 Agent
|
||||||
- 新技能**不得 vendored** `scripts/jiangchang_skill_core/`;复制模板后若发现该目录,应删除并改为依赖共享 venv。
|
|
||||||
- 在技能**根目录**维护 `requirements.txt`,**只声明技能特有** Python 三方包;**不要**重复声明 `jiangchang-platform-kit` 或 `playwright`。
|
|
||||||
- `SKILL.md` 的 `metadata.openclaw.platform_kit_min_version`(当前 `1.0.13`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是** pip 依赖声明。`jiangchang-platform-kit>=1.0.13` 是当前 RPA 视频/旁白/背景音乐/前后缓冲等标准能力的最低版本。
|
|
||||||
- 匠厂宿主在**安装或更新**技能后,会将技能 `requirements.txt` 中的依赖安装到共享 Python runtime:
|
|
||||||
`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`(Windows 示例:`D:\jiangchang-data\python-runtime\.venv`)。
|
|
||||||
- **Skill 业务代码不得自动 `pip install`**;缺依赖时应在 `health` / preflight 中给出清晰错误。
|
|
||||||
- **系统级组件**(如 Microsoft Visual C++ Redistributable)**不要**写进 `requirements.txt`;仅在 `health` / preflight 中提示用户自行安装。
|
|
||||||
- 独立本地开发环境若缺少公共包,可手动安装;**生产/宿主运行**由共享 runtime 负责,无需在技能内 `pip install playwright`。
|
|
||||||
|
|
||||||
## 公共能力边界
|
用自然语言示例展示用户可以怎么发起任务,例如:
|
||||||
|
|
||||||
以下能力均由 `jiangchang-platform-kit`(共享 runtime 的 `jiangchang_skill_core`)提供,技能只写业务逻辑与薄封装,**不要**在技能内复制实现:
|
> “帮我查询今天的【业务对象】,整理成表格。”
|
||||||
|
>
|
||||||
|
> “帮我核对这些【数据/单据】是否有异常,并告诉我问题在哪里。”
|
||||||
|
>
|
||||||
|
> “帮我把【时间范围】内的【业务数据】导出并生成处理报告。”
|
||||||
|
>
|
||||||
|
> “帮我根据这个文件里的内容,逐条完成【业务动作】。”
|
||||||
|
|
||||||
- `config` — `.env` 三级优先级读取与首次落盘
|
> 注意:示例应是自然语言,不要写命令行命令。
|
||||||
- `runtime_env` — 数据根、用户 ID、兄弟技能根解析
|
|
||||||
- `unified_logging` — 统一日志与 trace
|
---
|
||||||
- `rpa` — 浏览器/桌面/手机 RPA 共享库
|
|
||||||
- `media_assets` — 共享媒体资源探测与路径解析
|
## 执行后你会得到什么
|
||||||
- `video_session` — RPA 录屏成片(ffmpeg、字幕、背景音乐)
|
|
||||||
- `runtime_diagnostics` — `health` 统一 runtime 诊断
|
说明用户会看到什么结果,例如:
|
||||||
|
|
||||||
|
- 任务是否成功完成
|
||||||
|
- 处理了多少条数据
|
||||||
|
- 哪些内容成功、哪些失败
|
||||||
|
- 失败原因和建议处理方式
|
||||||
|
- 生成的文件、表格、报告或记录
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
用用户能理解的方式说明边界和风险,例如:
|
||||||
|
|
||||||
|
- 请确认输入范围准确,避免处理错数据
|
||||||
|
- 涉及提交、付款、删除、审批等高风险动作时,技能应在执行前请求确认
|
||||||
|
- 如果外部系统登录失效、权限不足或页面变化,任务可能需要用户介入
|
||||||
|
- 不建议在未核对数据的情况下直接执行批量操作
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 常见问题
|
||||||
|
|
||||||
|
### 为什么任务没有查到数据?
|
||||||
|
|
||||||
|
> 可能是时间范围、关键词、账号权限或系统筛选条件不正确。请先确认输入信息是否准确。
|
||||||
|
|
||||||
|
### 为什么任务执行到一半需要我操作?
|
||||||
|
|
||||||
|
> 可能遇到了登录、验证码、权限确认、二次审批或系统异常。请根据 Agent 的提示完成必要操作。
|
||||||
|
|
||||||
|
### 结果文件在哪里查看?
|
||||||
|
|
||||||
|
> 请根据 Agent 返回的结果说明查看生成文件、任务记录或处理报告。
|
||||||
|
|||||||
47
SKILL.md
47
SKILL.md
@@ -1,12 +1,12 @@
|
|||||||
---
|
---
|
||||||
name: 技能开发模板(通用业务版)
|
name: 技能开发模板(通用业务版)
|
||||||
description: "OpenClaw 通用业务技能开发模板,覆盖任务执行、日志记录、外部系统对接、隔离测试等典型能力。复制后请按 references/DEVELOPMENT.md 完成定制。"
|
description: "OpenClaw 通用业务技能开发模板,供复制后定制新业务 skill。定制步骤见 development/DEVELOPMENT.md。"
|
||||||
version: 1.0.14
|
version: 1.0.14
|
||||||
author: 深圳匠厂科技有限公司
|
author: 深圳匠厂科技有限公司
|
||||||
metadata:
|
metadata:
|
||||||
openclaw:
|
openclaw:
|
||||||
slug: your-skill-slug
|
slug: your-skill-slug
|
||||||
platform_kit_min_version: "1.0.13"
|
platform_kit_min_version: "1.0.14"
|
||||||
emoji: "📦"
|
emoji: "📦"
|
||||||
category: "通用"
|
category: "通用"
|
||||||
developer_ids:
|
developer_ids:
|
||||||
@@ -18,19 +18,24 @@ allowed-tools:
|
|||||||
|
|
||||||
# 技能开发模板(skill-template)
|
# 技能开发模板(skill-template)
|
||||||
|
|
||||||
这是一个**用于复制的新技能模板**,不是业务技能本身。新建技能时,应复制本仓库结构,再把占位内容替换成你的真实业务实现。
|
这是一个**用于复制的新技能模板**,不是业务 skill 本身。复制后请替换占位内容,实现你的真实业务逻辑。
|
||||||
|
|
||||||
## 模板使用方式
|
## 文档分工
|
||||||
|
|
||||||
1. 复制目录为你的新 skill 仓库。
|
| 文档 | 读者 | 用途 |
|
||||||
2. 全局替换 `your-skill-slug`、`技能开发模板(通用业务版)` 等占位词。
|
|------|------|------|
|
||||||
3. 按 `references/CLI.md`、`scripts/` 分层与 `README.md` 的说明补业务逻辑。
|
| 根目录 `README.md` | 普通用户 | 技能市场详情页说明(`metadata.readme_md` 主来源) |
|
||||||
|
| `SKILL.md`(本文) | LLM / OpenClaw 平台 | 技能入口、触发与运行契约摘要 |
|
||||||
|
| `references/` | Agent 编排/调用 | 渐进式加载:CLI 契约、字段 schema 等 |
|
||||||
|
| `development/` | 开发者 / AI 编程代理 | 需求、开发教程、测试、技术规范 |
|
||||||
|
|
||||||
## 目录约定
|
## 目录约定
|
||||||
|
|
||||||
- 根目录结构参考现有规范技能:`assets/`、`references/`、`scripts/`、`tests/`、`evals/`。
|
复制后建议保留:
|
||||||
- CLI 入口固定为 `scripts/main.py`。
|
|
||||||
- 业务逻辑按 `cli / db / service / util` 分层;公共能力从 `jiangchang-platform-kit` 提供的 `jiangchang_skill_core` 引用。
|
- `assets/`、`development/`、`evals/`、`references/`、`scripts/`、`tests/`
|
||||||
|
- CLI 入口固定为 `scripts/main.py`
|
||||||
|
- 业务逻辑按 `cli / db / service / util` 分层
|
||||||
|
|
||||||
## 最小命令
|
## 最小命令
|
||||||
|
|
||||||
@@ -45,18 +50,22 @@ python {baseDir}/scripts/main.py version
|
|||||||
## 运行依赖
|
## 运行依赖
|
||||||
|
|
||||||
- Python 运行环境由匠厂宿主注入**共享 runtime**:`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。
|
- Python 运行环境由匠厂宿主注入**共享 runtime**:`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。
|
||||||
- 公共能力来自共享 runtime 安装的 `jiangchang-platform-kit>=1.0.13`(`jiangchang_skill_core` 包);**新技能不得**在仓库内保留 `scripts/jiangchang_skill_core/` 副本。
|
- 公共能力来自共享 runtime 安装的 `jiangchang-platform-kit>=1.0.14`(`jiangchang_skill_core` 包);**不要 vendor** `scripts/jiangchang_skill_core/`,新技能不得在仓库内保留该目录副本。
|
||||||
- config、logging、runtime_env、rpa、media-assets、video_session、runtime_diagnostics 等均从共享 venv 的 `jiangchang_skill_core` import,而非技能目录副本。
|
- config、logging、runtime_env、rpa、media-assets、video_session、runtime_diagnostics 等均从共享 venv 的 `jiangchang_skill_core` import,而非技能目录副本。
|
||||||
- 根目录 `requirements.txt` **只声明技能特有** Python 三方依赖;`jiangchang-platform-kit`、`playwright` 等公共能力由宿主共享 runtime 提供,**不要**写入技能 requirements。宿主安装/更新技能后会将技能 requirements 安装到共享 venv。
|
- 根目录 `requirements.txt` **只声明技能特有** Python 三方依赖;`jiangchang-platform-kit`、`playwright` 等公共能力由宿主共享 runtime 提供,**不要**写入技能 requirements。
|
||||||
- `metadata.openclaw.platform_kit_min_version`(当前 `1.0.13`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是**技能 pip 依赖声明。`jiangchang-platform-kit>=1.0.13` 是当前 RPA 视频/旁白/背景音乐/前后缓冲等标准能力的最低版本。
|
- `metadata.openclaw.platform_kit_min_version`(当前 `1.0.14`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是**技能 pip 依赖声明。
|
||||||
- Skill 代码**不要**自行 `pip install`;系统级依赖(如 VC++ Runtime)仅在 `health` / preflight 中提示用户安装。
|
- Skill 代码**不要**自行 `pip install`;系统级依赖(如 VC++ Runtime)仅在 `health` / preflight 中提示用户安装。
|
||||||
- `health` 使用 `collect_runtime_diagnostics` 输出统一 runtime 诊断(只读,不下载/修复 media-assets)。
|
- `health` 使用 `collect_runtime_diagnostics` 输出统一 runtime 诊断(只读,不下载/修复 media-assets)。
|
||||||
|
|
||||||
## 重要说明
|
## 定制入口
|
||||||
|
|
||||||
- 复制后请同步修改 `scripts/util/constants.py` 中的 `SKILL_SLUG` / `SKILL_VERSION`。
|
1. 复制目录为你的新 skill 仓库,全局替换 `your-skill-slug` 等占位词。
|
||||||
- 如技能无需持久化,可保留 `db/` 目录但不主动调用。
|
2. 按 `development/DEVELOPMENT.md` 完成开发与文档定制。
|
||||||
- `metadata.openclaw.developer_ids` 用于声明技能发布后的默认开发者可见用户 ID 列表。
|
3. 用户市场说明写入根 `README.md`;Agent 调用契约见 `references/CLI.md`、`references/SCHEMA.md`。
|
||||||
- 当技能在平台中 `access_scope = 0`(不公开)时,任务执行流程会把 `developer_ids` 中的用户自动补写到 `skill_user_access`,使这些开发者仍可在技能市场中查看该技能。
|
4. 同步修改 `scripts/util/constants.py` 中的 `SKILL_SLUG` / `SKILL_VERSION`。
|
||||||
|
|
||||||
|
## 平台元数据
|
||||||
|
|
||||||
|
- `metadata.openclaw.developer_ids`:技能发布后的默认开发者可见用户 ID 列表。
|
||||||
|
- 当 `access_scope = 0`(不公开)时,平台会把 `developer_ids` 中的用户自动补写到 `skill_user_access`。
|
||||||
- `developer_ids` 建议写为正整数数组;第一个 ID 会作为主开发者同步到 `skills.developer_id`。
|
- `developer_ids` 建议写为正整数数组;第一个 ID 会作为主开发者同步到 `skills.developer_id`。
|
||||||
- 面向用户与编排的文档写在 `references/`,不要再新增旧式 `docs/` / `optional/` 结构。
|
|
||||||
|
|||||||
@@ -3,4 +3,6 @@
|
|||||||
- `examples/`:CLI 成功输出形状示例(虚构路径与数据)。
|
- `examples/`:CLI 成功输出形状示例(虚构路径与数据)。
|
||||||
- `schemas/`:轻量 JSON Schema 示例(`additionalProperties: true` 允许扩展字段)。
|
- `schemas/`:轻量 JSON Schema 示例(`additionalProperties: true` 允许扩展字段)。
|
||||||
|
|
||||||
面向编排与用户文档见 `references/README.md`、`references/CLI.md`、`RUNTIME.md`、`SCHEMA.md`。
|
- 用户市场说明见根目录 [`README.md`](../README.md)
|
||||||
|
- Agent 调用/编排参考见 [`references/`](../references/)
|
||||||
|
- 开发规范见 [`development/`](../development/)
|
||||||
|
|||||||
@@ -51,7 +51,13 @@ scripts/service/<domain>_adapter/
|
|||||||
real_rpa.py # 真实系统 RPA(占位,谨慎实现)
|
real_rpa.py # 真实系统 RPA(占位,谨慎实现)
|
||||||
```
|
```
|
||||||
|
|
||||||
模板示例:`scripts/service/example_adapter/`(复制改名即用)。
|
模板示例:
|
||||||
|
|
||||||
|
- **四档骨架(占位)**:`scripts/service/example_adapter/` — 复制改名后补齐业务 adapter
|
||||||
|
- **仿真浏览器 RPA 完整案例**:`examples/simulator_browser_rpa/` — mock + simulator_rpa + sandbox 页面 + 测试
|
||||||
|
- **真实浏览器 RPA 完整案例**:`examples/real_browser_rpa/` — 登录/验证码/滚动采集
|
||||||
|
|
||||||
|
> 先判断属于四象限哪一种(`real_browser_rpa` / `real_api` / `simulator_browser_rpa` / `simulator_api`),再读对应 `examples/*/README.md`。示例是**参考架构与边界**,不是业务代码原样复制。
|
||||||
|
|
||||||
## 档位 dispatch
|
## 档位 dispatch
|
||||||
|
|
||||||
@@ -92,15 +98,29 @@ def get_adapter():
|
|||||||
依赖 account-manager 或其他兄弟技能时:
|
依赖 account-manager 或其他兄弟技能时:
|
||||||
|
|
||||||
1. 在 `SKILL.md` 的 `metadata.openclaw.dependencies.required` 声明。
|
1. 在 `SKILL.md` 的 `metadata.openclaw.dependencies.required` 声明。
|
||||||
2. 调用兄弟技能走统一 **`service.sibling_bridge`**(`call_sibling_json`),**不要**在 service 层散落 `subprocess.run`。
|
2. **普通兄弟技能调用**,优先走统一 **`service.sibling_bridge`**(`call_sibling_json`),**不要**在 `task_service.py`、`task_rpa.py` 等业务流程文件中到处散落 `subprocess.run`。
|
||||||
3. **lease 必须 release**(account-manager 租约);进程被 kill 后可能残留 lease,需在运维文档说明排查方式(查 account-manager lease 列表 / 手动释放)。
|
3. **account-manager 账号/租约能力**是例外:可参考 `examples/real_browser_rpa/scripts/service/account_client.py`,封装为**单一** `account_client.py`;允许在该文件内部集中通过 subprocess 调 account-manager CLI。
|
||||||
|
4. **不允许**直接 `import account-manager` 的内部 Python 模块(如 `service/`、`util/`、`db/`)。
|
||||||
|
5. **pick lease 后必须 `finally release lease`**;进程被 kill 后可能残留 lease,需在运维文档说明排查方式(查 account-manager lease 列表 / 手动释放)。
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
# 普通兄弟技能 — 走 sibling_bridge
|
||||||
from service.sibling_bridge import call_sibling_json
|
from service.sibling_bridge import call_sibling_json
|
||||||
|
|
||||||
result = call_sibling_json("account-manager", ["list", "--limit", "10"])
|
result = call_sibling_json("account-manager", ["list", "--limit", "10"])
|
||||||
```
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
# account-manager 账号/租约 — 集中在 account_client.py
|
||||||
|
from service.account_client import pick_web_account, release_lease
|
||||||
|
|
||||||
|
account = pick_web_account(platform="target_platform")
|
||||||
|
try:
|
||||||
|
...
|
||||||
|
finally:
|
||||||
|
release_lease(account.get("lease_token"))
|
||||||
|
```
|
||||||
|
|
||||||
## 相关文档
|
## 相关文档
|
||||||
|
|
||||||
- `RPA.md` — 三端 RPA 技术选型与拟人/反反爬范式
|
- `RPA.md` — 三端 RPA 技术选型与拟人/反反爬范式
|
||||||
@@ -92,6 +92,7 @@
|
|||||||
your-skill/
|
your-skill/
|
||||||
├─ .github/
|
├─ .github/
|
||||||
├─ assets/
|
├─ assets/
|
||||||
|
├─ development/
|
||||||
├─ evals/
|
├─ evals/
|
||||||
├─ references/
|
├─ references/
|
||||||
├─ scripts/
|
├─ scripts/
|
||||||
@@ -110,7 +111,10 @@ your-skill/
|
|||||||
各目录职责如下:
|
各目录职责如下:
|
||||||
|
|
||||||
- `assets/`:放示例输出、schema、静态说明资源
|
- `assets/`:放示例输出、schema、静态说明资源
|
||||||
- `references/`:放研发和编排需要长期维护的文档
|
- `README.md`:面向用户的市场详情页说明
|
||||||
|
- `SKILL.md`:面向 LLM / 平台的技能入口
|
||||||
|
- `references/`:Agent 运行/编排/调用时渐进加载的补充上下文(如 CLI、SCHEMA)
|
||||||
|
- `development/`:面向开发者与 AI 编程代理的开发资料、需求、测试与技术规范
|
||||||
- `scripts/`:放真正的代码
|
- `scripts/`:放真正的代码
|
||||||
- `tests/`:放自动化测试
|
- `tests/`:放自动化测试
|
||||||
- `evals/`:放人工验收材料、评估清单、示例场景
|
- `evals/`:放人工验收材料、评估清单、示例场景
|
||||||
@@ -149,16 +153,25 @@ scripts/
|
|||||||
- `util/`
|
- `util/`
|
||||||
作用:常量、日志、路径、时间工具、通用帮助函数
|
作用:常量、日志、路径、时间工具、通用帮助函数
|
||||||
|
|
||||||
公共能力(config、logging、runtime_env、rpa、media_assets、video_session、runtime_diagnostics)从共享 runtime 的 `jiangchang-platform-kit>=1.0.13` import,**不得**在 `scripts/` 下保留 `jiangchang_skill_core/` 副本。
|
公共能力(config、logging、runtime_env、rpa、media_assets、video_session、runtime_diagnostics)从共享 runtime 的 `jiangchang-platform-kit>=1.0.14` import,**不得**在 `scripts/` 下保留 `jiangchang_skill_core/` 副本。
|
||||||
|
|
||||||
## 3.2 开发 RPA 类 skill
|
## 3.2 开发 RPA 类 skill
|
||||||
|
|
||||||
若 skill 需要浏览器/桌面/手机自动化,按以下顺序落地:
|
若 skill 需要浏览器/桌面/手机自动化,按以下顺序落地:
|
||||||
|
|
||||||
1. **先读三份标准**:`references/RPA.md`(三端范式与反反爬)、`references/CONFIG.md`(`.env` 落盘与读取)、`references/ADAPTER.md`(四档 adapter)。
|
1. **先读三份标准**:`RPA.md`(三端范式与反反爬)、`CONFIG.md`(`.env` 落盘与读取)、`ADAPTER.md`(四档 adapter)。
|
||||||
2. **从模板复制骨架**:
|
2. **从模板复制骨架**:
|
||||||
- `scripts/service/example_adapter/` → 改名为 `scripts/service/<domain>_adapter/`
|
- `scripts/service/example_adapter/` → 改名为 `scripts/service/<domain>_adapter/`(仅 adapter 四档骨架,**不等同于**真实浏览器 RPA 成功案例)
|
||||||
- 参考 `scripts/service/example_browser_rpa.py` 写浏览器会话逻辑
|
- 若是 **真实浏览器 RPA**(真实网站、登录态、验证码、滚动采集),**必须先读** `examples/real_browser_rpa/README.md`,再按需参考:
|
||||||
|
- `examples/real_browser_rpa/scripts/service/browser_session.py`
|
||||||
|
- `examples/real_browser_rpa/scripts/service/human_verification.py`
|
||||||
|
- `examples/real_browser_rpa/scripts/service/task_rpa.py`
|
||||||
|
- `examples/real_browser_rpa/scripts/service/account_client.py`
|
||||||
|
- 若是 **仿真浏览器 RPA**(自有 sandbox、表单批量提交、可控 DOM),**必须先读** `examples/simulator_browser_rpa/README.md`,再按需参考:
|
||||||
|
- `examples/simulator_browser_rpa/scripts/service/browser_session.py`
|
||||||
|
- `examples/simulator_browser_rpa/scripts/service/adapter/`
|
||||||
|
- `examples/simulator_browser_rpa/scripts/service/task_service.py`
|
||||||
|
- `examples/simulator_browser_rpa/sandbox/demo_app.html`
|
||||||
3. **只用共享库,不在 skill 里重写反反爬**:
|
3. **只用共享库,不在 skill 里重写反反爬**:
|
||||||
```python
|
```python
|
||||||
from jiangchang_skill_core import config
|
from jiangchang_skill_core import config
|
||||||
@@ -175,7 +188,7 @@ scripts/
|
|||||||
技能根目录的 `requirements.txt` 是**标准文件**,用于声明本技能**特有** Python 三方依赖。
|
技能根目录的 `requirements.txt` 是**标准文件**,用于声明本技能**特有** Python 三方依赖。
|
||||||
|
|
||||||
- **公共依赖**(`jiangchang-platform-kit`、`playwright`、config、runtime diagnostics、RPA 公共能力等)由**宿主共享 runtime** 提供,**不要**写入技能 `requirements.txt`。
|
- **公共依赖**(`jiangchang-platform-kit`、`playwright`、config、runtime diagnostics、RPA 公共能力等)由**宿主共享 runtime** 提供,**不要**写入技能 `requirements.txt`。
|
||||||
- `SKILL.md` 的 `metadata.openclaw.platform_kit_min_version`(当前 `1.0.13`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是** pip 依赖声明。
|
- `SKILL.md` 的 `metadata.openclaw.platform_kit_min_version`(当前 `1.0.14`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是** pip 依赖声明。
|
||||||
- 匠厂宿主安装/更新技能后,会将技能 `requirements.txt` 安装到共享 venv:`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。
|
- 匠厂宿主安装/更新技能后,会将技能 `requirements.txt` 安装到共享 venv:`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。
|
||||||
- **不要**在业务代码中 `subprocess` / `pip install`;缺依赖由 `health` 报错,由宿主负责安装。
|
- **不要**在业务代码中 `subprocess` / `pip install`;缺依赖由 `health` 报错,由宿主负责安装。
|
||||||
- **版本约束尽量收窄**,降低多技能共享 venv 时的冲突风险。推荐范围写法:
|
- **版本约束尽量收窄**,降低多技能共享 venv 时的冲突风险。推荐范围写法:
|
||||||
@@ -223,9 +236,10 @@ scripts/
|
|||||||
复制后优先改下面这些地方:
|
复制后优先改下面这些地方:
|
||||||
|
|
||||||
1. `SKILL.md`
|
1. `SKILL.md`
|
||||||
2. `scripts/util/constants.py`
|
2. 根目录 `README.md`(用户市场说明)
|
||||||
3. `references/` 下的文案
|
3. `scripts/util/constants.py`
|
||||||
4. `scripts/service/` 下的业务占位实现(优先改 `task_service.py`)
|
4. `references/` 与 `development/` 下的文案
|
||||||
|
5. `scripts/service/` 下的业务占位实现(优先改 `task_service.py`)
|
||||||
|
|
||||||
最先要统一的是:
|
最先要统一的是:
|
||||||
|
|
||||||
@@ -249,47 +263,44 @@ scripts/
|
|||||||
|
|
||||||
如果你的 skill 对外 CLI 需要自定义文案或别名(例如发布类对外仍叫 `publish`),通常还要替换:
|
如果你的 skill 对外 CLI 需要自定义文案或别名(例如发布类对外仍叫 `publish`),通常还要替换:
|
||||||
|
|
||||||
- `run` 命令中的中文提示与别名策略(见 `references/CLI.md`)
|
- `run` 命令中的中文提示与别名策略(见 `../references/CLI.md`)
|
||||||
- `references/CLI.md` 的命令示例
|
- `../references/CLI.md` 的命令示例
|
||||||
- `references/README.md` 的用户话术
|
- `../README.md` 的用户话术
|
||||||
- `references/SCHEMA.md` 的字段映射补充说明
|
- `../references/SCHEMA.md` 的字段映射补充说明
|
||||||
|
|
||||||
如需浏览器自动化,不要在模板里保留空的 `platform_playwright.py`;请按业务新建 `xxx_playwright.py`(命名自定),并在 `task_service.py` 中按需引用。
|
如需浏览器自动化,不要在模板里保留空的 `platform_playwright.py`;请按业务新建 `xxx_playwright.py`(命名自定),并在 `task_service.py` 中按需引用。
|
||||||
|
|
||||||
## 6. `SKILL.md` 应该怎么写
|
## 6. `SKILL.md` 与根 `README.md` 应该怎么写
|
||||||
|
|
||||||
`SKILL.md` 是技能清单,不是设计文档。
|
### `SKILL.md`(LLM / 平台入口)
|
||||||
|
|
||||||
|
`SKILL.md` 是给 LLM 与 OpenClaw 平台看的技能入口,**不是**用户市场详情页。
|
||||||
|
|
||||||
应该重点写:
|
应该重点写:
|
||||||
|
|
||||||
- 技能名称
|
- YAML frontmatter:`name`、`description`、`version`、`metadata.openclaw`(含 `slug`、`platform_kit_min_version`、`developer_ids` 等)
|
||||||
- 技能描述
|
- 何时触发本技能、CLI 入口摘要、运行契约要点
|
||||||
- `slug`
|
- 指向 `references/`(Agent 调用)与 `development/`(开发规范)的分工说明
|
||||||
作用:技能的唯一英文标识,通常用于仓库名、发布包名、运行时目录名、平台主键匹配等
|
|
||||||
示例:`your-skill-slug`、`disburse-payroll-icbc`、`tax-invoice-verify`
|
不要在 `SKILL.md` 里写大量用户市场文案或实现细节。
|
||||||
- `category`
|
|
||||||
作用:技能在平台中的分类,用于市场展示与归类,不是代码内部键
|
### 根 `README.md`(用户市场说明)
|
||||||
示例:`通用`、`内容`、`办公协作`、`物流`、`抖音`、`小红书`
|
|
||||||
- `developer_ids`(如需给非公开技能自动补开发者可见权限)
|
根 `README.md` 是技能市场详情页主来源(`metadata.readme_md`),面向普通用户。
|
||||||
作用:声明发布后默认拥有可见权限的开发者用户 ID 列表
|
|
||||||
- `dependencies`
|
应包含 YAML frontmatter 的 `description`(市场列表简介),正文用用户能理解的语言说明:
|
||||||
作用:声明该技能依赖的兄弟技能或运行前置能力,便于平台或编排层识别依赖关系
|
|
||||||
示例(按业务填写;发布类可能会依赖账号 / 内容技能,其它领域可能完全不同):
|
- 能做什么、适合什么场景、使用前准备什么
|
||||||
```yaml
|
- 如何自然语言告诉 Agent
|
||||||
dependencies:
|
- 执行结果、注意事项、常见问题
|
||||||
required:
|
|
||||||
- some-sibling-skill
|
不要在根 `README.md` 里写开发教程、目录规范、release、requirements 等技术细节。
|
||||||
```
|
|
||||||
- 何时使用本技能
|
|
||||||
- 对用户的引导话术
|
|
||||||
- CLI 使用原则
|
|
||||||
|
|
||||||
不要在 `SKILL.md` 里写大量实现细节。
|
|
||||||
实现细节放在:
|
实现细节放在:
|
||||||
|
|
||||||
- `references/`
|
- `development/`
|
||||||
- 代码注释
|
- `references/`(CLI / SCHEMA)
|
||||||
- `service/` 实现里
|
- 代码注释与 `service/` 实现
|
||||||
|
|
||||||
### 关于 `metadata.openclaw.developer_ids`
|
### 关于 `metadata.openclaw.developer_ids`
|
||||||
|
|
||||||
@@ -318,33 +329,31 @@ metadata:
|
|||||||
- 第一个 ID 会同步到 `skills.developer_id`
|
- 第一个 ID 会同步到 `skills.developer_id`
|
||||||
- 一期只做“补授权”,不会因为你 later 修改数组而自动撤销旧授权
|
- 一期只做“补授权”,不会因为你 later 修改数组而自动撤销旧授权
|
||||||
|
|
||||||
## 7. `references/` 应该放什么
|
## 7. 文档目录分工
|
||||||
|
|
||||||
`references/` 是当前规范 skill 的文档中心,建议至少有这些:
|
当前规范 skill 的文档按读者拆分:
|
||||||
|
|
||||||
- `README.md`
|
**根 `README.md`**
|
||||||
面向内部说明和技能作用介绍
|
|
||||||
|
|
||||||
- `CLI.md`
|
- 用户市场详情页说明(含 frontmatter `description`)
|
||||||
写清楚命令、参数、默认值、兄弟技能调用方式
|
|
||||||
|
|
||||||
- `RUNTIME.md`
|
**`SKILL.md`**
|
||||||
写清楚运行时目录、环境变量、入口约定
|
|
||||||
|
|
||||||
- `SCHEMA.md`
|
- LLM / OpenClaw 平台技能入口
|
||||||
写清楚数据库路径、核心表结构、日志表结构
|
|
||||||
|
|
||||||
- `DEVELOPMENT.md`
|
**`references/`**(Agent 运行/编排/调用时渐进加载)
|
||||||
写给技术人员的开发教程,也就是本文档
|
|
||||||
|
|
||||||
- `TESTING.md`
|
- `README.md` — Agent 参考索引
|
||||||
写给技术人员的测试分层、隔离数据根与档位开关指南(详见 [`references/TESTING.md`](TESTING.md))
|
- `CLI.md` — 命令、参数、默认值、兄弟技能调用方式
|
||||||
|
- `SCHEMA.md` — 数据库路径、核心表结构、日志表结构
|
||||||
|
- 可按需增加 `ERRORS.md`、`INTEGRATION.md` 等编排向补充
|
||||||
|
|
||||||
如果后面某个 skill 需要更细的说明,可以再加:
|
**`development/`**(开发者 / AI 编程代理)
|
||||||
|
|
||||||
- `ERRORS.md`
|
- `REQUIREMENTS.md` — 需求与验收
|
||||||
- `INTEGRATION.md`
|
- `DEVELOPMENT.md` — 开发教程(本文档)
|
||||||
- `PLATFORMS.md`
|
- `TESTING.md` — 测试分层与隔离(详见 [`TESTING.md`](TESTING.md))
|
||||||
|
- `ADAPTER.md`、`RPA.md`、`CONFIG.md`、`RUNTIME.md` — 技术规范
|
||||||
|
|
||||||
## 8. `assets/` 应该放什么
|
## 8. `assets/` 应该放什么
|
||||||
|
|
||||||
@@ -359,7 +368,7 @@ metadata:
|
|||||||
比如日志记录、机读 JSON 的 schema
|
比如日志记录、机读 JSON 的 schema
|
||||||
|
|
||||||
不要把正式研发文档放到 `assets/`。
|
不要把正式研发文档放到 `assets/`。
|
||||||
文档应该进 `references/`。
|
用户说明进根 `README.md`;Agent 编排资料进 `references/`;开发规范进 `development/`。
|
||||||
|
|
||||||
## 9. `cli` 层怎么写
|
## 9. `cli` 层怎么写
|
||||||
|
|
||||||
@@ -516,7 +525,7 @@ python scripts/main.py <your-command>
|
|||||||
3. **写完 service 业务后**:从 `tests/samples/test_service_contract.py.sample` 复制一份做契约测试。
|
3. **写完 service 业务后**:从 `tests/samples/test_service_contract.py.sample` 复制一份做契约测试。
|
||||||
4. **接外部系统时**:写在 `tests/integration/`,并配合 `OPENCLAW_TEST_TARGET` 显式开启。
|
4. **接外部系统时**:写在 `tests/integration/`,并配合 `OPENCLAW_TEST_TARGET` 显式开启。
|
||||||
|
|
||||||
详见 `references/TESTING.md`。
|
详见 `TESTING.md`。
|
||||||
|
|
||||||
## 15. 发布到正式环境验证
|
## 15. 发布到正式环境验证
|
||||||
|
|
||||||
@@ -573,7 +582,7 @@ python scripts/main.py <your-command>
|
|||||||
如果工作流失败,不要继续做平台验证,而应该先回到代码仓库排查,例如:
|
如果工作流失败,不要继续做平台验证,而应该先回到代码仓库排查,例如:
|
||||||
|
|
||||||
- 发布脚本是否正常推送
|
- 发布脚本是否正常推送
|
||||||
- `SKILL.md`、`scripts/`、`references/` 是否齐全
|
- `SKILL.md`、根 `README.md`、`scripts/`、`references/`、`development/` 是否齐全
|
||||||
- 工作流文件是否存在
|
- 工作流文件是否存在
|
||||||
- 发布包结构是否符合模板规范
|
- 发布包结构是否符合模板规范
|
||||||
|
|
||||||
@@ -636,7 +645,7 @@ python scripts/main.py <your-command>
|
|||||||
- [ ] 目录结构符合当前模板
|
- [ ] 目录结构符合当前模板
|
||||||
- [ ] `SKILL.md` 中 slug、名称、描述都已替换
|
- [ ] `SKILL.md` 中 slug、名称、描述都已替换
|
||||||
- [ ] `scripts/util/constants.py` 已修改
|
- [ ] `scripts/util/constants.py` 已修改
|
||||||
- [ ] `references/CLI.md` 示例命令已改成真实命令
|
- [ ] `../references/CLI.md` 示例命令已改成真实命令
|
||||||
- [ ] `service` 下的核心业务文件(如 `task_service.py`)已按领域改名并实现
|
- [ ] `service` 下的核心业务文件(如 `task_service.py`)已按领域改名并实现
|
||||||
- [ ] 没有残留旧平台名
|
- [ ] 没有残留旧平台名
|
||||||
- [ ] `health` / `version` 可运行
|
- [ ] `health` / `version` 可运行
|
||||||
@@ -673,7 +682,7 @@ python scripts/main.py <your-command>
|
|||||||
|
|
||||||
- `task_service.py`
|
- `task_service.py`
|
||||||
- `sibling_bridge.py`
|
- `sibling_bridge.py`
|
||||||
- `references/CLI.md`
|
- `../references/CLI.md`
|
||||||
|
|
||||||
### 错误 3:把业务逻辑写进 CLI
|
### 错误 3:把业务逻辑写进 CLI
|
||||||
|
|
||||||
@@ -698,16 +707,17 @@ python scripts/main.py <your-command>
|
|||||||
现在的新模板原则是:
|
现在的新模板原则是:
|
||||||
|
|
||||||
- 不做旧结构兼容
|
- 不做旧结构兼容
|
||||||
- 统一走 `references/` + `scripts/main.py`
|
- 用户说明在根 `README.md`,Agent 资料在 `references/`,开发规范在 `development/`
|
||||||
|
- 统一走 `scripts/main.py` 作为 CLI 入口
|
||||||
|
|
||||||
## 18. 推荐开发顺序总结
|
## 18. 推荐开发顺序总结
|
||||||
|
|
||||||
如果让一个新人照着做,我建议他按这个顺序:
|
如果让一个新人照着做,我建议他按这个顺序:
|
||||||
|
|
||||||
1. 复制模板并改目录名
|
1. 复制模板并改目录名
|
||||||
2. 改 `SKILL.md`
|
2. 改 `SKILL.md` 与根 `README.md`
|
||||||
3. 改 `scripts/util/constants.py`
|
3. 改 `scripts/util/constants.py`
|
||||||
4. 改 `references/`
|
4. 改 `references/` 与 `development/`
|
||||||
5. 改 `scripts/cli/app.py`
|
5. 改 `scripts/cli/app.py`
|
||||||
6. 改 `scripts/service/`
|
6. 改 `scripts/service/`
|
||||||
7. 跑 `python tests/run_tests.py -v`
|
7. 跑 `python tests/run_tests.py -v`
|
||||||
@@ -721,7 +731,7 @@ python scripts/main.py <your-command>
|
|||||||
|
|
||||||
- 目录结构统一
|
- 目录结构统一
|
||||||
- 入口统一为 `scripts/main.py`
|
- 入口统一为 `scripts/main.py`
|
||||||
- 文档统一放 `references/`
|
- 用户说明在根 `README.md`,Agent 资料在 `references/`,开发规范在 `development/`
|
||||||
- 业务核心逻辑统一放 `scripts/service/`
|
- 业务核心逻辑统一放 `scripts/service/`
|
||||||
- 不再使用旧模板历史结构
|
- 不再使用旧模板历史结构
|
||||||
|
|
||||||
14
development/README.md
Normal file
14
development/README.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# 开发资料入口
|
||||||
|
|
||||||
|
本目录面向**人类开发者**与 **AI 编程代理**。开始定制 skill 前,建议按以下顺序阅读:
|
||||||
|
|
||||||
|
1. [`REQUIREMENTS.md`](REQUIREMENTS.md) — 需求文档模板与验收标准
|
||||||
|
2. [`DEVELOPMENT.md`](DEVELOPMENT.md) — 完整开发步骤与目录规范
|
||||||
|
3. [`TESTING.md`](TESTING.md) — 测试分层、隔离数据根与档位开关
|
||||||
|
4. [`ADAPTER.md`](ADAPTER.md) — 涉及外部系统对接时
|
||||||
|
5. [`RPA.md`](RPA.md) — 涉及浏览器 / 桌面 / 手机自动化时
|
||||||
|
6. [`CONFIG.md`](CONFIG.md) — `.env` 规范与 bootstrap 机制
|
||||||
|
7. [`RUNTIME.md`](RUNTIME.md) — 共享 runtime、数据路径与诊断约定
|
||||||
|
|
||||||
|
Agent 调用契约见 [`../references/CLI.md`](../references/CLI.md)、[`../references/SCHEMA.md`](../references/SCHEMA.md)。
|
||||||
|
用户市场说明见根目录 [`README.md`](../README.md),不要写进本目录。
|
||||||
248
development/REQUIREMENTS.md
Normal file
248
development/REQUIREMENTS.md
Normal file
@@ -0,0 +1,248 @@
|
|||||||
|
# 技能需求文档模板
|
||||||
|
|
||||||
|
这份文档用于给技术人员、产品人员和实施人员统一描述某个 skill 的研发需求。
|
||||||
|
|
||||||
|
建议原则:
|
||||||
|
|
||||||
|
- 一个 skill 对应一份主需求文档
|
||||||
|
- 需求先写清楚,再进入开发
|
||||||
|
- 文档描述“要做什么”和“做到什么程度”,不要在这里堆实现细节
|
||||||
|
- 实现方式、代码结构、发布流程,分别放到 `DEVELOPMENT.md`、`references/`、`development/` 下的技术规范
|
||||||
|
|
||||||
|
如果你是从 `skill-template` 复制新技能,请复制本文件后,把下面所有占位内容替换成你的真实项目内容。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# REQUIREMENTS
|
||||||
|
|
||||||
|
## 1. 文档目标
|
||||||
|
|
||||||
|
说明这份需求文档的作用,以及它解决什么问题。
|
||||||
|
|
||||||
|
模板写法:
|
||||||
|
|
||||||
|
- 本文档用于明确 `your-skill-slug` 的研发范围、交付标准、依赖关系和验收要求。
|
||||||
|
- 技术人员应以本文件作为开发范围依据,以避免实现偏差、范围蔓延或理解不一致。
|
||||||
|
|
||||||
|
## 2. 业务背景
|
||||||
|
|
||||||
|
说明为什么要做这个 skill,它服务什么业务场景,解决什么实际问题。
|
||||||
|
|
||||||
|
模板写法:
|
||||||
|
|
||||||
|
- 当前用户在 `<业务场景>` 中需要反复处理 `<输入数据>`,人工操作耗时且易错。
|
||||||
|
- 现有流程主要依赖人工处理,存在 `<效率低 / 容易出错 / 不可批量 / 不可追踪>` 等问题。
|
||||||
|
- 因此需要开发 `your-skill-slug`,用于自动完成 `<核心动作>`,输出 `<输出结果>`,并写入 `task_logs` 便于追踪。
|
||||||
|
|
||||||
|
填写提示:
|
||||||
|
|
||||||
|
- `<业务场景>`:例如“每日批量导入外部系统结果”“Agent 触发的单次查询”
|
||||||
|
- `<输入数据>`:例如“关键词列表”“批次 ID”“账号标识”
|
||||||
|
- `<核心动作>`:例如“调用 adapter 提交”“采集并入库”“对账摘要生成”
|
||||||
|
- `<输出结果>`:例如“结构化 JSON”“任务摘要”“本地 SQLite 记录”
|
||||||
|
|
||||||
|
## 3. 开发目标
|
||||||
|
|
||||||
|
说明本次开发希望最终交付什么结果。
|
||||||
|
|
||||||
|
模板写法(按 skill 类型勾选/改写):
|
||||||
|
|
||||||
|
- 解析并校验 `<输入数据>` 的关键字段
|
||||||
|
- 通过 adapter 完成 mock / simulator / real 档位下的 `<核心动作>`
|
||||||
|
- 输出结构化结果(stdout JSON 或固定文本 + 机读字段)
|
||||||
|
- 写入 `task_logs`(及必要的业务表,见 `references/SCHEMA.md`)
|
||||||
|
- 支持失败可诊断(稳定错误码、`ERROR:` 前缀、必要截图/日志)
|
||||||
|
- 完成 CLI 入口与 `health` / `version` 最小可运行验证
|
||||||
|
- 完成正式环境发布与安装验证(如适用)
|
||||||
|
|
||||||
|
## 4. 功能范围
|
||||||
|
|
||||||
|
说明这次开发明确要实现哪些功能。
|
||||||
|
|
||||||
|
模板写法:
|
||||||
|
|
||||||
|
- 支持 `<命令1>`(如 `run`)
|
||||||
|
- 支持 `<命令2>`(如 `logs` / `log-get`)
|
||||||
|
- 支持读取 `<数据来源>`(兄弟 skill / 本地 DB / 外部 API)
|
||||||
|
- 支持执行 `<核心业务动作>`
|
||||||
|
- 支持记录 `<日志 / 状态 / 结果>`
|
||||||
|
|
||||||
|
建议将功能拆成“必须实现”和“可后续扩展”。
|
||||||
|
|
||||||
|
### 必须实现
|
||||||
|
|
||||||
|
- 支持 `python scripts/main.py health`
|
||||||
|
- 支持 `python scripts/main.py version`
|
||||||
|
- 支持 `python scripts/main.py <your-main-command>`
|
||||||
|
- 支持核心业务编排(HTTP / 批处理 / 可选 RPA,按四档 adapter 选型)
|
||||||
|
- 支持写入任务日志(`task_logs`)
|
||||||
|
|
||||||
|
### 可后续扩展
|
||||||
|
|
||||||
|
- 支持定时批跑
|
||||||
|
- 支持失败自动重试
|
||||||
|
- 支持多 `<目标系统>` 轮询
|
||||||
|
|
||||||
|
## 5. 非功能要求
|
||||||
|
|
||||||
|
说明除功能外,对稳定性、可维护性、目录规范、日志、编码等方面的要求。
|
||||||
|
|
||||||
|
- 目录结构必须符合当前 `skill-template` 规范
|
||||||
|
- 入口必须统一为 `scripts/main.py`
|
||||||
|
- 用户说明写在根 `README.md`;LLM/运行契约写在 `SKILL.md`;开发规范在 `development/`
|
||||||
|
- 输出格式应尽量机读友好;错误前缀统一为 `ERROR:`
|
||||||
|
- Windows 环境下需保证 UTF-8 输出兼容
|
||||||
|
- 必须具备基本日志能力;敏感字段脱敏
|
||||||
|
- RPA 类 skill:Playwright 由宿主共享 runtime 提供;技能侧不要 `playwright install`;URL 不要放进 `launch_persistent_context` 的 `args`
|
||||||
|
|
||||||
|
## 6. 输入输出要求
|
||||||
|
|
||||||
|
### 输入
|
||||||
|
|
||||||
|
填写本 skill 实际接受的参数与数据来源:
|
||||||
|
|
||||||
|
- `<参数名>`:含义、是否必填、默认值
|
||||||
|
- `<依赖系统>` 返回的结构化数据(如有)
|
||||||
|
- 环境变量 / `.env` 中的关键配置(引用 `CONFIG.md`)
|
||||||
|
|
||||||
|
### 输出
|
||||||
|
|
||||||
|
- 成功结果(stdout / JSON 字段说明)
|
||||||
|
- 错误输出(`ERROR:` 稳定码 + 中文 message)
|
||||||
|
- 数据库记录(表名、关键字段,见 `references/SCHEMA.md`)
|
||||||
|
- 可选:RPA 截图/视频路径(artifacts)
|
||||||
|
|
||||||
|
## 7. 依赖的兄弟技能或外部系统
|
||||||
|
|
||||||
|
### 兄弟技能依赖
|
||||||
|
|
||||||
|
- `<sibling-skill-slug>`:`<用途>`(例如 account-manager 提供 profile_dir / 租约)
|
||||||
|
|
||||||
|
### 外部系统依赖
|
||||||
|
|
||||||
|
- `<目标系统>`:`<用途>`(HTTP API / 仿真 sandbox / 真实网页)
|
||||||
|
- 浏览器(如适用):系统 Chrome/Edge,非 Playwright 内置 Chromium
|
||||||
|
- Gitea / 匠厂客户端:发布与正式环境验证
|
||||||
|
|
||||||
|
### Python 包依赖(requirements.txt)
|
||||||
|
|
||||||
|
- 本技能若需**特有** Python 三方包,写入根目录 `requirements.txt`。
|
||||||
|
- `jiangchang-platform-kit`、`playwright` 等公共能力由宿主共享 runtime 提供,**不要**写入技能 requirements。
|
||||||
|
- `SKILL.md` 的 `platform_kit_min_version` 是运行契约/兼容性声明,**不是** pip 依赖声明。
|
||||||
|
- 版本须尽量收窄(如 `requests>=2.31.0,<3`),避免共享 venv 冲突。
|
||||||
|
- **不要**把系统运行时组件写进 requirements.txt;在 `health` / preflight 中检测并提示。
|
||||||
|
|
||||||
|
## 8. 不在本次范围内的内容
|
||||||
|
|
||||||
|
明确本次“不做什么”,避免范围蔓延:
|
||||||
|
|
||||||
|
- 本次不实现 `<功能A>`
|
||||||
|
- 本次不处理 `<平台B>` / `<档位>`
|
||||||
|
- 本次不做 `<高级能力>`
|
||||||
|
- 本次不兼容旧模板历史结构(`docs/`、`optional/`、`skill_main.py` 等)
|
||||||
|
|
||||||
|
## 9. 验收标准
|
||||||
|
|
||||||
|
什么情况下才算开发完成:
|
||||||
|
|
||||||
|
- 代码结构符合模板规范;`SKILL.md` slug 与 `constants.SKILL_SLUG` 一致
|
||||||
|
- `health`、`version` 命令执行正常
|
||||||
|
- 主命令(如 `run`)在 mock / simulator 档位可重复验证
|
||||||
|
- `python tests/run_tests.py -v` 必跑测试全部通过
|
||||||
|
- `task_logs` 写入和查询符合 `references/SCHEMA.md`
|
||||||
|
- 真实联调(如有)放在 `tests/integration/`,且默认套件不包含真实外联
|
||||||
|
- 发布后 Gitea 工作流成功;匠厂技能市场可见最新版本;安装后可在“新建任务”中调用
|
||||||
|
|
||||||
|
## 10. 开发注意事项
|
||||||
|
|
||||||
|
- 只修改当前 skill 仓库,不要改动无关兄弟项目
|
||||||
|
- 先判断四象限类型(`real_browser_rpa` / `real_api` / `simulator_browser_rpa` / `simulator_api`),再读对应 `examples/*/README.md`
|
||||||
|
- `cli` 只做参数解析;核心逻辑在 `service`;兄弟 skill 调用集中封装(见 `ADAPTER.md`)
|
||||||
|
- 发布前完成本地验证、工作流验证和正式环境安装验证
|
||||||
|
|
||||||
|
## 11. 变更记录
|
||||||
|
|
||||||
|
| 日期 | 版本 | 变更人 | 变更内容 |
|
||||||
|
|------|------|--------|----------|
|
||||||
|
| YYYY-MM-DD | v1.0 | `<姓名>` | 初版需求文档 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 建议使用方式
|
||||||
|
|
||||||
|
1. 先写 `REQUIREMENTS.md`
|
||||||
|
2. 再按 `DEVELOPMENT.md` 进入开发
|
||||||
|
3. 开发过程中补充 `references/CLI.md`、`references/SCHEMA.md` 及 `development/` 技术规范
|
||||||
|
4. 发布前对照第 9 节验收标准逐项检查
|
||||||
|
|
||||||
|
## 最小模板示例
|
||||||
|
|
||||||
|
下面给出一个可直接参考的简化版(复制后替换占位符):
|
||||||
|
|
||||||
|
```md
|
||||||
|
# REQUIREMENTS
|
||||||
|
|
||||||
|
## 1. 文档目标
|
||||||
|
|
||||||
|
本文档用于明确 `your-skill-slug` 的研发需求、范围和验收标准,作为开发与测试的统一依据。
|
||||||
|
|
||||||
|
## 2. 业务背景
|
||||||
|
|
||||||
|
当前用户在 `<业务场景>` 中需要反复处理 `<输入数据>`,人工操作耗时且易错。
|
||||||
|
因此需要开发 `your-skill-slug`,自动完成 `<核心动作>`,输出 `<输出结果>`,并写入 task_logs。
|
||||||
|
|
||||||
|
## 3. 开发目标
|
||||||
|
|
||||||
|
- 解析并校验输入
|
||||||
|
- 通过 adapter 完成 mock / simulator / real 档位动作
|
||||||
|
- 输出结构化结果并写入 task_logs
|
||||||
|
- 支持失败可诊断
|
||||||
|
|
||||||
|
## 4. 功能范围
|
||||||
|
|
||||||
|
- 支持 health / version / run
|
||||||
|
- 支持 logs / log-get
|
||||||
|
|
||||||
|
## 5. 非功能要求
|
||||||
|
|
||||||
|
- 入口统一为 scripts/main.py
|
||||||
|
- 保持 UTF-8 输出;结构符合 skill-template
|
||||||
|
|
||||||
|
## 6. 输入输出要求
|
||||||
|
|
||||||
|
### 输入
|
||||||
|
|
||||||
|
- target_id、input_id(按业务定义)
|
||||||
|
|
||||||
|
### 输出
|
||||||
|
|
||||||
|
- 成功 JSON / 摘要
|
||||||
|
- ERROR: 稳定错误码
|
||||||
|
- task_logs 记录
|
||||||
|
|
||||||
|
## 7. 依赖的兄弟技能或外部系统
|
||||||
|
|
||||||
|
- `<sibling-skill>`(按需)
|
||||||
|
- `<目标系统>` API 或 sandbox
|
||||||
|
|
||||||
|
## 8. 不在本次范围内的内容
|
||||||
|
|
||||||
|
- 不实现自动重试
|
||||||
|
- 不实现 `<本次不做>`
|
||||||
|
|
||||||
|
## 9. 验收标准
|
||||||
|
|
||||||
|
- 命令可运行;tests/run_tests.py -v 通过
|
||||||
|
- task_logs 符合 SCHEMA
|
||||||
|
- 正式环境安装验证通过
|
||||||
|
|
||||||
|
## 10. 开发注意事项
|
||||||
|
|
||||||
|
- 不修改无关项目;不引入旧模板结构
|
||||||
|
|
||||||
|
## 11. 变更记录
|
||||||
|
|
||||||
|
| 日期 | 版本 | 变更人 | 变更内容 |
|
||||||
|
|------|------|--------|----------|
|
||||||
|
| YYYY-MM-DD | v1.0 | 张三 | 初版 |
|
||||||
|
```
|
||||||
@@ -51,7 +51,7 @@
|
|||||||
6. **可以** `ignore_default_args=["--enable-automation"]`(platform-kit `launch_persistent_browser` 已处理)。
|
6. **可以** `ignore_default_args=["--enable-automation"]`(platform-kit `launch_persistent_browser` 已处理)。
|
||||||
7. **强风控平台**:优先真实点击、键盘、鼠标、地址栏、持久 profile;**不要**直接拼接搜索结果 URL 或 DOM 注入。
|
7. **强风控平台**:优先真实点击、键盘、鼠标、地址栏、持久 profile;**不要**直接拼接搜索结果 URL 或 DOM 注入。
|
||||||
|
|
||||||
指纹淡化(stealth)典型项:`navigator.webdriver=undefined`、`chrome.runtime`、`permissions.query`、`plugins`、`languages` 等。共享实现见 `jiangchang_skill_core.rpa`(platform-kit **>= 1.0.13**)。
|
指纹淡化(stealth)典型项:`navigator.webdriver=undefined`、`chrome.runtime`、`permissions.query`、`plugins`、`languages` 等。共享实现见 `jiangchang_skill_core.rpa`(platform-kit **>= 1.0.14**)。
|
||||||
|
|
||||||
**拟人操作**(必做):
|
**拟人操作**(必做):
|
||||||
|
|
||||||
@@ -63,11 +63,26 @@
|
|||||||
|
|
||||||
### 1.2 页面启动标准
|
### 1.2 页面启动标准
|
||||||
|
|
||||||
优先级(高 → 低):
|
**`launch_persistent_context` 的 `args` 只能放 Chrome 启动参数**(例如 `--start-maximized`、`--disable-blink-features=AutomationControlled` 等)。
|
||||||
|
|
||||||
1. **launch args `start_url`**:浏览器启动即打开目标首页(推荐生产路径)。
|
**绝对不要把 `https://...` 这类 URL 放进 `args`。** 否则 Playwright 会报错:
|
||||||
2. **profile preferences**:作为兜底(例如 homepage / startup URLs)。
|
|
||||||
3. **程序化导航 `page.goto`**:仅最后兜底;强风控站点慎用裸 `goto` 深链。
|
```
|
||||||
|
BrowserType.launch_persistent_context: Arguments can not specify page to be opened
|
||||||
|
```
|
||||||
|
|
||||||
|
**正确做法(生产路径):**
|
||||||
|
|
||||||
|
1. `launch_persistent_context(user_data_dir=profile_dir, executable_path=chrome, args=chrome_args, ...)`
|
||||||
|
2. `page = await context.new_page()`
|
||||||
|
3. `await page.goto(start_url, wait_until="domcontentloaded", timeout=60000)`
|
||||||
|
|
||||||
|
对强风控站点,如果需要更拟人,可以启动后通过**地址栏输入 / 真实点击进入**目标页,但**仍然不能把 URL 塞进 launch args**。
|
||||||
|
|
||||||
|
完整参考实现见:
|
||||||
|
|
||||||
|
- `examples/real_browser_rpa/README.md`(**开发真实浏览器 RPA 类 skill 时必须先读**)
|
||||||
|
- `examples/real_browser_rpa/scripts/service/browser_session.py`
|
||||||
|
|
||||||
**生产路径不要依赖 CDP 接管现有页面**;CDP 仅用于诊断或桌面宿主已打开浏览器的场景。
|
**生产路径不要依赖 CDP 接管现有页面**;CDP 仅用于诊断或桌面宿主已打开浏览器的场景。
|
||||||
|
|
||||||
@@ -78,7 +93,11 @@
|
|||||||
- 检测到风控页(URL/DOM 特征)→ 抛 `ERROR:CAPTCHA_NEED_HUMAN`,轮询等待或超时,**不要强行绕过平台安全机制**。
|
- 检测到风控页(URL/DOM 特征)→ 抛 `ERROR:CAPTCHA_NEED_HUMAN`,轮询等待或超时,**不要强行绕过平台安全机制**。
|
||||||
- **不要自动操作滑块**。
|
- **不要自动操作滑块**。
|
||||||
|
|
||||||
> 共享库:`jiangchang_skill_core.rpa.wait_for_captcha_pass`;参考 `scripts/service/example_browser_rpa.py`。
|
> 共享库:`jiangchang_skill_core.rpa.wait_for_captcha_pass`;**真实浏览器 RPA 成功案例**见 `examples/real_browser_rpa/`:
|
||||||
|
>
|
||||||
|
> - 先读 `examples/real_browser_rpa/README.md`
|
||||||
|
> - 再参考 `examples/real_browser_rpa/scripts/service/human_verification.py`
|
||||||
|
> - 再参考 `examples/real_browser_rpa/scripts/service/task_rpa.py`
|
||||||
|
|
||||||
### 1.4 安装
|
### 1.4 安装
|
||||||
|
|
||||||
@@ -105,10 +124,34 @@ from jiangchang_skill_core.rpa import (
|
|||||||
from jiangchang_skill_core.rpa.stealth import stealth_enabled, STEALTH_INIT_SCRIPT
|
from jiangchang_skill_core.rpa.stealth import stealth_enabled, STEALTH_INIT_SCRIPT
|
||||||
```
|
```
|
||||||
|
|
||||||
- `RpaVideoSession` 来自 platform-kit **>= 1.0.13**;ffmpeg、背景音乐、media-assets 由 platform-kit 统一解析;已提供前置/后置缓冲、字幕、TTS 旁白、背景音乐循环、结尾淡出。
|
- `RpaVideoSession` 来自 platform-kit **>= 1.0.14**;ffmpeg、背景音乐、media-assets 由 platform-kit 统一解析;已提供前置/后置缓冲、字幕、TTS 旁白、背景音乐循环、结尾淡出。
|
||||||
- `health` 对上述资源做只读诊断,不下载、不修复。
|
- `health` 对上述资源做只读诊断,不下载、不修复。
|
||||||
|
|
||||||
完整示例见 `scripts/service/example_browser_rpa.py` 与 `scripts/service/example_adapter/sim_rpa.py`。
|
### 1.5 真实浏览器 RPA 示例(必读)
|
||||||
|
|
||||||
|
开发**真实网站 + 浏览器操作 + 登录态/验证码/滚动采集**类 skill 时:
|
||||||
|
|
||||||
|
1. **必须先阅读** `examples/real_browser_rpa/README.md`
|
||||||
|
2. 再参考以下代码:
|
||||||
|
- `examples/real_browser_rpa/scripts/service/browser_session.py` — persistent context 启动
|
||||||
|
- `examples/real_browser_rpa/scripts/service/human_verification.py` — 人工验证等待
|
||||||
|
- `examples/real_browser_rpa/scripts/service/task_rpa.py` — RPA 主流程
|
||||||
|
- `examples/real_browser_rpa/scripts/service/account_client.py` — account-manager CLI 封装
|
||||||
|
|
||||||
|
模板内 adapter 仿真示例(`scripts/service/example_adapter/sim_rpa.py`)仅用于 **adapter 四档骨架**,不能替代真实浏览器 RPA 规范。
|
||||||
|
|
||||||
|
### 1.6 仿真浏览器 RPA 示例(必读)
|
||||||
|
|
||||||
|
开发**自有仿真页面 / sandbox / 可控 DOM 的浏览器 RPA**(表单填写、批量提交、弹窗确认)时:
|
||||||
|
|
||||||
|
1. **必须先阅读** `examples/simulator_browser_rpa/README.md`
|
||||||
|
2. 再参考:
|
||||||
|
- `examples/simulator_browser_rpa/scripts/service/browser_session.py`
|
||||||
|
- `examples/simulator_browser_rpa/scripts/service/adapter/`(base / mock / simulator_rpa / dispatch)
|
||||||
|
- `examples/simulator_browser_rpa/scripts/service/task_service.py`
|
||||||
|
- `examples/simulator_browser_rpa/sandbox/demo_app.html`
|
||||||
|
|
||||||
|
> **先选类型再写代码**:真实第三方网站 → `real_browser_rpa`;自有 sandbox → `simulator_browser_rpa`。不要跨类型照抄 selector 或业务流程。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## 共享 Python Runtime
|
## 共享 Python Runtime
|
||||||
|
|
||||||
**skill-template** 及复制出的新技能,公共能力均来自宿主匠厂安装的共享 Python Runtime(`jiangchang-platform-kit>=1.0.13` 及其传递依赖,含 `playwright`)。`jiangchang_skill_core` **不得**在技能仓库内 vendored,应由共享 venv 的 site-packages 提供。
|
**skill-template** 及复制出的新技能,公共能力均来自宿主匠厂安装的共享 Python Runtime(`jiangchang-platform-kit>=1.0.14` 及其传递依赖,含 `playwright`)。`jiangchang_skill_core` **不得**在技能仓库内 vendored,应由共享 venv 的 site-packages 提供。
|
||||||
|
|
||||||
技能根目录 `requirements.txt` **只声明技能特有依赖**;**不要**重复声明 `jiangchang-platform-kit` 或 `playwright`。`SKILL.md` 的 `platform_kit_min_version` 是运行契约,**不是** pip 依赖声明。
|
技能根目录 `requirements.txt` **只声明技能特有依赖**;**不要**重复声明 `jiangchang-platform-kit` 或 `playwright`。`SKILL.md` 的 `platform_kit_min_version` 是运行契约,**不是** pip 依赖声明。
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ Windows:
|
|||||||
|
|
||||||
`<shared-python>` 通常位于 `{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。数据根由宿主注入;开发模式下也可能通过 `CLAW_DATA_ROOT` 解析(见 `jiangchang_skill_core.runtime_env`)。
|
`<shared-python>` 通常位于 `{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。数据根由宿主注入;开发模式下也可能通过 `CLAW_DATA_ROOT` 解析(见 `jiangchang_skill_core.runtime_env`)。
|
||||||
|
|
||||||
## Runtime 诊断(platform-kit 1.0.13+)
|
## Runtime 诊断(platform-kit 1.0.14+)
|
||||||
|
|
||||||
`health` 命令通过 **`jiangchang_skill_core.collect_runtime_diagnostics`** 输出共享 runtime 诊断,**不在技能内重复实现**。典型字段:
|
`health` 命令通过 **`jiangchang_skill_core.collect_runtime_diagnostics`** 输出共享 runtime 诊断,**不在技能内重复实现**。典型字段:
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ Windows:
|
|||||||
- 用户实际 `.env`:`{CLAW_DATA_ROOT}/{CLAW_USER_ID}/{skill_slug}/.env`。
|
- 用户实际 `.env`:`{CLAW_DATA_ROOT}/{CLAW_USER_ID}/{skill_slug}/.env`。
|
||||||
- `scripts/main.py` 与 `cli.app.main()` 启动时调用 `util.config_bootstrap.bootstrap_skill_config()`。
|
- `scripts/main.py` 与 `cli.app.main()` 启动时调用 `util.config_bootstrap.bootstrap_skill_config()`。
|
||||||
- 配置优先级:**进程环境变量** > **用户 `.env`** > **`.env.example` 默认值**。
|
- 配置优先级:**进程环境变量** > **用户 `.env`** > **`.env.example` 默认值**。
|
||||||
- 公共 `config` / `merge_missing_env_keys` 来自共享 runtime 的 `jiangchang-platform-kit>=1.0.13`,**不得** vendored `scripts/jiangchang_skill_core/`。
|
- 公共 `config` / `merge_missing_env_keys` 来自共享 runtime 的 `jiangchang-platform-kit>=1.0.14`,**不得** vendored `scripts/jiangchang_skill_core/`。
|
||||||
|
|
||||||
## media-assets / ffmpeg / 背景音乐
|
## media-assets / ffmpeg / 背景音乐
|
||||||
|
|
||||||
@@ -61,6 +61,7 @@ RPA 录屏成片(`RpaVideoSession`)、ffmpeg 路径、背景音乐探测均
|
|||||||
新技能建议采用以下根目录结构:
|
新技能建议采用以下根目录结构:
|
||||||
|
|
||||||
- `assets/`
|
- `assets/`
|
||||||
|
- `development/`
|
||||||
- `references/`
|
- `references/`
|
||||||
- `scripts/`
|
- `scripts/`
|
||||||
- `tests/`
|
- `tests/`
|
||||||
@@ -103,7 +104,7 @@ RPA 录屏成片(`RpaVideoSession`)、ffmpeg 路径、背景音乐探测均
|
|||||||
|
|
||||||
退出时四个变量恢复,临时目录删除。所有 DB / 文件写入都被限制在临时目录内,不污染本机。
|
退出时四个变量恢复,临时目录删除。所有 DB / 文件写入都被限制在临时目录内,不污染本机。
|
||||||
|
|
||||||
详见 `references/TESTING.md` 第 3 节。
|
详见 `TESTING.md` 第 3 节。
|
||||||
|
|
||||||
## 编码与输出
|
## 编码与输出
|
||||||
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# 测试开发指南
|
# 测试开发指南
|
||||||
|
|
||||||
面向复制 `skill-template` 后的新业务 skill:**如何把自动化测试当作一等公民**,而不是等业务写完再补文档级别的空话。本文串起模板自带的 unittest 入口、`tests/` 目录分层与安全档位约定;**更细的开关取值、表格字段与环境变量组合仍以 [`tests/README.md`](../tests/README.md) 为权威来源**。建议你随手开一个编辑器分页:`references/TESTING.md`(本篇)、[`references/DEVELOPMENT.md`](DEVELOPMENT.md)(整体节奏)、[`tests/README.md`](../tests/README.md)(落地细则)。
|
面向复制 `skill-template` 后的新业务 skill:**如何把自动化测试当作一等公民**,而不是等业务写完再补文档级别的空话。本文串起模板自带的 unittest 入口、`tests/` 目录分层与安全档位约定;**更细的开关取值、表格字段与环境变量组合仍以 [`tests/README.md`](../tests/README.md) 为权威来源**。建议你随手开一个编辑器分页:`TESTING.md`(本篇)、[`DEVELOPMENT.md`](DEVELOPMENT.md)(整体节奏)、[`tests/README.md`](../tests/README.md)(落地细则)。
|
||||||
|
|
||||||
默认心智模型可以用一句话概括:**根目录 `test_*.py` = CI / 本地每次提交都应能通过的无外联套件**;`*integration*`、`*.sample`、`desktop/` = 只在人被明确要求时才启用的高风险或重量级路径。
|
默认心智模型可以用一句话概括:**根目录 `test_*.py` = CI / 本地每次提交都应能通过的无外联套件**;`*integration*`、`*.sample`、`desktop/` = 只在人被明确要求时才启用的高风险或重量级路径。
|
||||||
|
|
||||||
@@ -23,7 +23,7 @@
|
|||||||
必跑套件要像一个紧张的守门员:**快、确定、离线**。典型覆盖:
|
必跑套件要像一个紧张的守门员:**快、确定、离线**。典型覆盖:
|
||||||
|
|
||||||
- CLI:导入 [`cli.app`](../scripts/cli/app.py) 走解析链路、`health`(runtime diagnostics)/ `version` / `logs` / `log-get` 冒烟;
|
- CLI:导入 [`cli.app`](../scripts/cli/app.py) 走解析链路、`health`(runtime diagnostics)/ `version` / `logs` / `log-get` 冒烟;
|
||||||
- 架构守护:无 `scripts/jiangchang_skill_core/`、`platform-kit>=1.0.13` 导入来源、文档/runtime 标准(见 `test_platform_import.py` 等);
|
- 架构守护:无 `scripts/jiangchang_skill_core/`、`platform-kit>=1.0.14` 导入来源、文档/runtime 标准(见 `test_platform_import.py` 等);
|
||||||
- **真实 subprocess**:[`tests/test_entrypoint_subprocess.py`](../tests/test_entrypoint_subprocess.py) 再调用一遍 `python scripts/main.py`,防路径漂移;
|
- **真实 subprocess**:[`tests/test_entrypoint_subprocess.py`](../tests/test_entrypoint_subprocess.py) 再调用一遍 `python scripts/main.py`,防路径漂移;
|
||||||
- 运行时:`runtime_paths` 与 **`CLAW_*` / `JIANGCHANG_*` 并发兜底;
|
- 运行时:`runtime_paths` 与 **`CLAW_*` / `JIANGCHANG_*` 并发兜底;
|
||||||
- `SKILL.md` YAML slug vs [`constants.SKILL_SLUG`](../scripts/util/constants.py);
|
- `SKILL.md` YAML slug vs [`constants.SKILL_SLUG`](../scripts/util/constants.py);
|
||||||
@@ -218,7 +218,7 @@ Golden fixture 流程同理([`tests/samples/test_golden_cases.py.sample`](../t
|
|||||||
|
|
||||||
- [ ] `requirements.txt` **不含** `jiangchang-platform-kit` / `playwright`
|
- [ ] `requirements.txt` **不含** `jiangchang-platform-kit` / `playwright`
|
||||||
- [ ] 无 `scripts/jiangchang_skill_core/` vendored 副本
|
- [ ] 无 `scripts/jiangchang_skill_core/` vendored 副本
|
||||||
- [ ] `platform_kit_min_version` **>= 1.0.13**(`SKILL.md` + `constants.py`)
|
- [ ] `platform_kit_min_version` **>= 1.0.14**(`SKILL.md` + `constants.py`)
|
||||||
- [ ] `health` 能输出 `platform_kit_version_ok`(或等价诊断行)
|
- [ ] `health` 能输出 `platform_kit_version_ok`(或等价诊断行)
|
||||||
- [ ] `config-path` 可输出用户 `.env` 路径 JSON
|
- [ ] `config-path` 可输出用户 `.env` 路径 JSON
|
||||||
- [ ] `pytest.ini` 存在且 `python_files` 只收集 `test_*.py` / `*_test.py`
|
- [ ] `pytest.ini` 存在且 `python_files` 只收集 `test_*.py` / `*_test.py`
|
||||||
@@ -228,5 +228,5 @@ Golden fixture 流程同理([`tests/samples/test_golden_cases.py.sample`](../t
|
|||||||
---
|
---
|
||||||
|
|
||||||
- [`tests/README.md`](../tests/README.md) — 表格、变量与目录细则
|
- [`tests/README.md`](../tests/README.md) — 表格、变量与目录细则
|
||||||
- [`references/DEVELOPMENT.md`](DEVELOPMENT.md) §14.5 — 测试驱动的开发顺序
|
- [`DEVELOPMENT.md`](DEVELOPMENT.md) §14.5 — 测试驱动的开发顺序
|
||||||
- [`tests/integration/README.md`](../tests/integration/README.md) — 高风险用法
|
- [`tests/integration/README.md`](../tests/integration/README.md) — 高风险用法
|
||||||
36
examples/README.md
Normal file
36
examples/README.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# Skill Template Examples
|
||||||
|
|
||||||
|
四类 adapter 示例(先选类型,再写代码;**不要跨类型照抄**):
|
||||||
|
|
||||||
|
| 目录 | 类型 | 状态 | 适用场景 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| real_browser_rpa | 真实浏览器 RPA | **已有案例** | 真实第三方网站、登录态、人工验证、滚动采集 |
|
||||||
|
| simulator_browser_rpa | 仿真浏览器 RPA | **已有案例** | 自有 sandbox、可控页面、表单 RPA、端到端教学/回归 |
|
||||||
|
| real_api | 真实 API | 占位,后续补案例 | 真实系统接口、token、权限、限流 |
|
||||||
|
| simulator_api | 仿真 API | 占位,后续补案例 | mock/sandbox API、无需浏览器 |
|
||||||
|
|
||||||
|
## 两类浏览器 RPA 的区别
|
||||||
|
|
||||||
|
| | real_browser_rpa | simulator_browser_rpa |
|
||||||
|
|---|---|---|
|
||||||
|
| 目标 | 真实第三方网页 | 自有仿真页面 / sandbox |
|
||||||
|
| 风控 | 高(验证码、登录态、反爬) | 低(DOM 可控) |
|
||||||
|
| 账号 | 通常需 account-manager + profile | 示例可用 env / demo 账号 |
|
||||||
|
| 用途 | 生产级真实采集/操作参考 | adapter 分层 + 表单 RPA 教学 |
|
||||||
|
|
||||||
|
## 当前状态
|
||||||
|
|
||||||
|
- **real_browser_rpa**:已有可参考代码 → 先读 `real_browser_rpa/README.md`
|
||||||
|
- **simulator_browser_rpa**:已有完整示例(含 `sandbox/demo_app.html`)→ 先读 `simulator_browser_rpa/README.md`
|
||||||
|
- **real_api** / **simulator_api**:目录占位,后续补案例
|
||||||
|
|
||||||
|
## 如何选择示例
|
||||||
|
|
||||||
|
| 你的场景 | 参考目录 |
|
||||||
|
|---|---|
|
||||||
|
| 真实网站 + 浏览器 + 登录/验证码/滚动 | **real_browser_rpa** |
|
||||||
|
| 仿真页面 + 浏览器 + 表单/批量提交 | **simulator_browser_rpa** |
|
||||||
|
| 真实系统 API | 后续 **real_api** |
|
||||||
|
| mock / sandbox API(无浏览器) | 后续 **simulator_api** |
|
||||||
|
|
||||||
|
> 示例提供的是**参考架构与边界**,不是业务代码原样复制。复制前先读对应 README 的「复制边界 / 禁止照抄」章节。
|
||||||
15
examples/real_api/README.md
Normal file
15
examples/real_api/README.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Real API Example
|
||||||
|
|
||||||
|
这个目录用于沉淀“真实系统 API”类 skill 的可复制成功案例。
|
||||||
|
|
||||||
|
## 适用场景
|
||||||
|
|
||||||
|
- 目标系统提供真实 API
|
||||||
|
- 需要 token / secret / credential
|
||||||
|
- 需要请求重试、权限校验、限流处理、schema 校验和幂等写库
|
||||||
|
|
||||||
|
## 当前状态
|
||||||
|
|
||||||
|
- 本目录暂时只保留结构占位。
|
||||||
|
- 示例业务尚未确定。
|
||||||
|
- 本轮不包含示例代码。
|
||||||
0
examples/real_api/scripts/service/.gitkeep
Normal file
0
examples/real_api/scripts/service/.gitkeep
Normal file
0
examples/real_api/scripts/util/.gitkeep
Normal file
0
examples/real_api/scripts/util/.gitkeep
Normal file
0
examples/real_api/tests/.gitkeep
Normal file
0
examples/real_api/tests/.gitkeep
Normal file
171
examples/real_browser_rpa/README.md
Normal file
171
examples/real_browser_rpa/README.md
Normal file
@@ -0,0 +1,171 @@
|
|||||||
|
# Real Browser RPA Example
|
||||||
|
|
||||||
|
这是一个真实网站浏览器 RPA skill 的可复制参考实现,适用于需要登录、人工验证、搜索、滚动加载、采集和入库的场景。
|
||||||
|
|
||||||
|
**说明:**
|
||||||
|
|
||||||
|
- 本示例是通用模板,不绑定具体平台。
|
||||||
|
- 示例抽象自已跑通的真实浏览器 RPA skill(抖音视频链接采集),但代码已改成中性示例命名。
|
||||||
|
- 新 skill 开发时可以复制本目录,再替换目标站点、选择器、解析逻辑和业务字段。
|
||||||
|
|
||||||
|
## 适用场景
|
||||||
|
|
||||||
|
- 真实网站操作(非 sandbox / mock)
|
||||||
|
- 需要登录态与 persistent Chrome/Edge profile
|
||||||
|
- 需要通过 account-manager 管理账号和 `profile_dir`
|
||||||
|
- 需要处理人工登录、滑块验证码、短信验证码
|
||||||
|
- 需要关键词搜索、滚动加载、采集可见条目
|
||||||
|
- 需要结构化日志、用户友好的停止原因、失败留痕(截图/视频)
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
real_browser_rpa/
|
||||||
|
├── README.md
|
||||||
|
├── scripts/
|
||||||
|
│ ├── service/
|
||||||
|
│ │ ├── account_client.py # subprocess 调用 account-manager
|
||||||
|
│ │ ├── browser_session.py # 系统 Chrome + persistent context
|
||||||
|
│ │ ├── human_verification.py # 滑块/短信/保存登录弹窗检测(不依赖 task_rpa 错误类型)
|
||||||
|
│ │ ├── task_rpa.py # RPA 主流程
|
||||||
|
│ │ └── task_service.py # 轻量编排(示例无 DB)
|
||||||
|
│ └── util/
|
||||||
|
│ ├── constants.py # 平台常量、selector 占位
|
||||||
|
│ └── logging.py # 结构化日志与脱敏
|
||||||
|
└── tests/
|
||||||
|
├── test_human_verification.py # 验证码误判防护
|
||||||
|
└── test_stop_reason.py # 停止原因文案
|
||||||
|
```
|
||||||
|
|
||||||
|
## 核心流程
|
||||||
|
|
||||||
|
1. **pick account** — 通过 `account_client.pick_web_account()` 获取 `profile_dir` 与租约
|
||||||
|
2. **启动浏览器** — `launch_persistent_context` + `new_page()` + `page.goto(start_url)`
|
||||||
|
3. **人工验证(启动后)** — 检测滑块/短信,等待用户完成
|
||||||
|
4. **等待登录** — 检测登录按钮消失 / 登录态 marker 出现
|
||||||
|
5. **保存登录弹窗** — 等待“是否保存登录信息”倒计时消失
|
||||||
|
6. **人工验证(登录后)** — 再次检测
|
||||||
|
7. **搜索** — 定位搜索框 → 输入关键词 → 点击搜索
|
||||||
|
8. **等待结果容器** — `#search-result-container`(示例 selector)
|
||||||
|
9. **滚动采集循环** — 采集可见条目 → 判断 stop_reason → 滚动加载
|
||||||
|
10. **返回结果** — `ScrapeRunResult` + `format_stop_reason_for_user()`
|
||||||
|
11. **释放租约** — `finally` 中 `release_lease()`
|
||||||
|
|
||||||
|
## 开发新 skill 时如何复制
|
||||||
|
|
||||||
|
1. **先阅读** `examples/real_browser_rpa/README.md`(本节及下方「复制边界」)
|
||||||
|
2. 复制整个 `examples/real_browser_rpa/` 到新 skill 的 `scripts/` 结构(或作为起点合并)
|
||||||
|
3. 修改 `util/constants.py` 中的 `TARGET_PLATFORM`、`DEFAULT_START_URL`、selector 常量
|
||||||
|
4. 替换 `task_rpa.py` 中的登录态 marker、搜索框/结果解析逻辑(**必须 F12 实测**)
|
||||||
|
5. 替换 `human_verification.py` 中的验证码 selector(若目标站点 DOM 不同)
|
||||||
|
6. 在 `task_service.py` 中接入真实 DB、任务日志、RpaVideoSession
|
||||||
|
7. 添加 CLI 入口(`scripts/main.py`),并补齐 `SKILL.md` 的 LLM/运行契约说明与根 `README.md` 的用户市场说明
|
||||||
|
|
||||||
|
## 复制边界:哪些能复制,哪些必须替换
|
||||||
|
|
||||||
|
### 可以直接参考/复制的
|
||||||
|
|
||||||
|
- `browser_session.py` 的启动结构:**persistent context → new_page → goto**
|
||||||
|
- `human_verification.py` 的人工验证等待模式(容器级检测 + 等待人工,不自动破解)
|
||||||
|
- `task_rpa.py` 的流程分层、结构化日志点、`stop_reason` 设计
|
||||||
|
- `account_client.py` 的 account-manager CLI **集中封装**方式(subprocess 仅限此文件)
|
||||||
|
- `tests/test_human_verification.py` 的误判防护测试思路
|
||||||
|
|
||||||
|
### 必须替换的
|
||||||
|
|
||||||
|
- `SKILL_SLUG`
|
||||||
|
- `TARGET_PLATFORM`
|
||||||
|
- `LEASE_HOLDER`
|
||||||
|
- `DEFAULT_START_URL`
|
||||||
|
- `SEARCH_INPUT_SELECTORS` / `SEARCH_BUTTON_SELECTOR`
|
||||||
|
- `RESULT_CONTAINER_SELECTOR` / `RESULT_ITEM_SELECTOR`
|
||||||
|
- `SCROLL_CONTAINER_SELECTORS`
|
||||||
|
- `RESULT_END_TEXT`
|
||||||
|
- `LOGGED_IN_SELECTORS` / `LOGGED_OUT_SELECTOR`(见下方说明)
|
||||||
|
- `_parse_item_locator()` 业务字段解析
|
||||||
|
- 用户可见中文文案
|
||||||
|
- 数据库写入逻辑
|
||||||
|
- 任务日志逻辑
|
||||||
|
- 录屏/截图业务标题
|
||||||
|
|
||||||
|
### 禁止照抄的
|
||||||
|
|
||||||
|
- 不要照抄目标站点 selector(示例 selector 不等于真实 DOM)
|
||||||
|
- 不要照抄平台名、slug、logger 名
|
||||||
|
- 不要依赖 `D:\OpenClaw\client-commons\account-manager\scripts\main.py` 等开发机绝对路径作为生产依赖
|
||||||
|
- 不要把示例里的 result selector 当成真实站点 selector
|
||||||
|
- 不要把示例代码原样发布为业务 skill
|
||||||
|
- 不要把真实账号、手机号、cookie、token 写入代码或 README
|
||||||
|
|
||||||
|
### 登录 selector 说明
|
||||||
|
|
||||||
|
`task_rpa.py` 中的 `LOGGED_IN_SELECTORS` 与 `LOGGED_OUT_SELECTOR` **只是示例**,偏中文「登录」按钮和常见站点结构。复制到新 skill 后:
|
||||||
|
|
||||||
|
- **必须**用目标站点 F12 / DOM 实测后替换
|
||||||
|
- **不允许**凭经验猜 selector
|
||||||
|
- **不允许**因为示例在本机曾跑通就直接照搬到其他平台
|
||||||
|
|
||||||
|
### account-manager 路径解析说明
|
||||||
|
|
||||||
|
`account_client.py` 末尾的 `D:\OpenClaw\client-commons\account-manager\scripts\main.py` 是**开发环境兜底路径**,仅用于模板/本机调试。复制到真实 skill 后:
|
||||||
|
|
||||||
|
- **优先**通过 `ACCOUNT_MANAGER_ROOT`、`CLAW_SKILLS_ROOT`、`JIANGCHANG_SKILLS_ROOT` 或宿主运行环境解析 account-manager
|
||||||
|
- **不要**把个人机器路径作为生产依赖
|
||||||
|
|
||||||
|
## 必须保留的安全原则
|
||||||
|
|
||||||
|
- **不 import account-manager 内部模块** — 只通过 CLI/subprocess 调用
|
||||||
|
- **不自动破解验证码** — 滑块/短信只检测 + 等待人工完成
|
||||||
|
- **日志脱敏** — 不输出完整手机号/账号
|
||||||
|
- **租约释放** — `pick-web --lease` 后必须在 `finally` 释放
|
||||||
|
- **失败留痕** — 真实 skill 应在关键失败点截图(示例中已留注释位)
|
||||||
|
|
||||||
|
## 常见坑
|
||||||
|
|
||||||
|
| 坑 | 正确做法 |
|
||||||
|
|---|---|
|
||||||
|
| 直接 `import account_manager.service...` | 通过 `subprocess` 调用 `account-manager/scripts/main.py` |
|
||||||
|
| 把 URL 放进 `launch_persistent_context(args=[url])` | `args` 只放 Chrome 参数;URL 用 `page.goto(start_url)` |
|
||||||
|
| 启动后直接操作 DOM | 先 `context.new_page()` 再 `page.goto()` |
|
||||||
|
| 用整页 `body.inner_text()` 判断验证码 | 限定在 `[role='dialog']`、`.vc-captcha-verify` 等容器 |
|
||||||
|
| 搜索结果含“验证码教程”文字就误判 | 单元测试覆盖:无验证 DOM 时不应 `present=True` |
|
||||||
|
| 无结构化日志 | 关键节点打 `rpa_start` / `browser_ready` / `collect_round` 等 |
|
||||||
|
| 把 CLI 参数暴露给普通用户 | 用户说明放根 `README.md`;运行契约与触发规则放 `SKILL.md`(LLM/平台入口) |
|
||||||
|
|
||||||
|
## 需要替换的内容清单
|
||||||
|
|
||||||
|
| 文件 | 替换项 |
|
||||||
|
|---|---|
|
||||||
|
| `util/constants.py` | `SKILL_SLUG`、`TARGET_PLATFORM`、`DEFAULT_START_URL`、所有 selector |
|
||||||
|
| `browser_session.py` | `get_start_url()` 配置来源、stealth 脚本(可选) |
|
||||||
|
| `human_verification.py` | `SLIDER_SELECTORS`、`SMS_SELECTORS`、`DIALOG_TEXT_CONTAINERS` |
|
||||||
|
| `task_rpa.py` | `LOGGED_IN_SELECTORS`、`LOGGED_OUT_SELECTOR`、`_parse_item_locator()` |
|
||||||
|
| `account_client.py` | `PLACEHOLDER_PLATFORM`、`LEASE_HOLDER`、账号 setup 文案 |
|
||||||
|
| `task_service.py` | 接入 DB、任务日志、entitlement、视频留痕 |
|
||||||
|
|
||||||
|
## 依赖说明
|
||||||
|
|
||||||
|
本目录是 **示例**,不影响 skill-template 根目录运行。真实 skill 需要:
|
||||||
|
|
||||||
|
- Python 3.10+
|
||||||
|
- Python 包 `playwright`:属于**宿主共享 runtime** 的通用能力;技能侧**不要**在 `requirements.txt` 中重复声明,也**不要**在代码或脚本中执行 `pip install playwright`
|
||||||
|
- 真实 skill **默认使用系统 Chrome/Edge**,**不使用** Playwright 下载的内置 Chromium
|
||||||
|
- 技能侧**不要**执行 `playwright install`、`playwright install chromium` 或类似命令
|
||||||
|
- 若本地独立开发环境缺少 Playwright Python 包,只能作为开发机临时环境补装;**生产/宿主运行**由共享 runtime 解决
|
||||||
|
- `jiangchang_skill_core`(如 `find_chrome_executable` 等,由 platform-kit 提供)
|
||||||
|
- 兄弟 skill `account-manager`
|
||||||
|
|
||||||
|
## 运行测试
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd examples/real_browser_rpa
|
||||||
|
python -m pytest tests/ -v
|
||||||
|
```
|
||||||
|
|
||||||
|
测试为纯函数/Mock DOM,**不需要启动真实浏览器**。
|
||||||
|
|
||||||
|
## 当前状态
|
||||||
|
|
||||||
|
- 示例代码已就绪,可直接作为新 skill 复制起点。
|
||||||
|
- 未绑定具体平台业务字段;selector 为占位示例。
|
||||||
|
- 未接入真实数据库与 CLI 入口。
|
||||||
199
examples/real_browser_rpa/scripts/service/account_client.py
Normal file
199
examples/real_browser_rpa/scripts/service/account_client.py
Normal file
@@ -0,0 +1,199 @@
|
|||||||
|
"""account-manager CLI 集成(仅 subprocess,不 import 兄弟 skill 内部模块)。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
from typing import Any, Dict, List, Optional
|
||||||
|
|
||||||
|
from util.constants import LEASE_HOLDER, LEASE_TTL_SEC, TARGET_PLATFORM
|
||||||
|
from util.logging import mask_text
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
PLACEHOLDER_PLATFORM = TARGET_PLATFORM
|
||||||
|
|
||||||
|
ACCOUNT_SETUP_MESSAGE = (
|
||||||
|
f"未找到可用的 {PLACEHOLDER_PLATFORM} 账号,所以还没有打开浏览器。"
|
||||||
|
f"请先在 account-manager 中添加 platform={PLACEHOLDER_PLATFORM}、"
|
||||||
|
"status=active、带 profile_dir 的账号后重新运行。"
|
||||||
|
)
|
||||||
|
|
||||||
|
LEASE_BUSY_MESSAGE = "目标平台账号当前被其他任务占用,请等待释放租约后重试。"
|
||||||
|
|
||||||
|
|
||||||
|
class AccountManagerError(Exception):
|
||||||
|
def __init__(self, code: str, message: str) -> None:
|
||||||
|
super().__init__(message)
|
||||||
|
self.code = code
|
||||||
|
self.message = message
|
||||||
|
|
||||||
|
|
||||||
|
def mask_login_id(login_id: str) -> str:
|
||||||
|
return mask_text(login_id)
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_account_manager_main() -> str:
|
||||||
|
"""解析 account-manager CLI 入口路径。
|
||||||
|
|
||||||
|
优先级:ACCOUNT_MANAGER_ROOT → CLAW_SKILLS_ROOT / JIANGCHANG_SKILLS_ROOT → 开发机兜底。
|
||||||
|
末尾 dev 路径仅用于模板/本机调试,复制到真实 skill 后不要依赖个人机器绝对路径。
|
||||||
|
"""
|
||||||
|
env_root = (os.getenv("ACCOUNT_MANAGER_ROOT") or "").strip()
|
||||||
|
if env_root and os.path.isfile(os.path.join(env_root, "scripts", "main.py")):
|
||||||
|
return os.path.join(os.path.abspath(env_root), "scripts", "main.py")
|
||||||
|
|
||||||
|
skills_root = (os.getenv("CLAW_SKILLS_ROOT") or os.getenv("JIANGCHANG_SKILLS_ROOT") or "").strip()
|
||||||
|
if skills_root:
|
||||||
|
candidate = os.path.join(os.path.abspath(skills_root), "account-manager", "scripts", "main.py")
|
||||||
|
if os.path.isfile(candidate):
|
||||||
|
return candidate
|
||||||
|
|
||||||
|
# 开发环境兜底:仅模板/本机调试;生产依赖宿主注入的路径变量,勿硬编码个人目录
|
||||||
|
dev = r"D:\OpenClaw\client-commons\account-manager\scripts\main.py"
|
||||||
|
if os.path.isfile(dev):
|
||||||
|
return dev
|
||||||
|
|
||||||
|
raise AccountManagerError(
|
||||||
|
"ACCOUNT_NOT_FOUND",
|
||||||
|
"未找到 account-manager,请配置 ACCOUNT_MANAGER_ROOT 或安装 account-manager 技能。",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_last_json(stdout: str) -> Any:
|
||||||
|
lines = [ln.strip() for ln in (stdout or "").splitlines() if ln.strip()]
|
||||||
|
for raw in reversed(lines):
|
||||||
|
if raw.startswith("ERROR:"):
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
return json.loads(raw)
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
continue
|
||||||
|
raise AccountManagerError("UNKNOWN_ERROR", "stdout 中没有可解析的 JSON。")
|
||||||
|
|
||||||
|
|
||||||
|
def _run_argv(argv_suffix: List[str]) -> subprocess.CompletedProcess[str]:
|
||||||
|
main_py = _resolve_account_manager_main()
|
||||||
|
env = os.environ.copy()
|
||||||
|
return subprocess.run(
|
||||||
|
[sys.executable, main_py, *argv_suffix],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
encoding="utf-8",
|
||||||
|
errors="replace",
|
||||||
|
env=env,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _normalize_error_code(raw: str) -> str:
|
||||||
|
code = (raw or "").strip()
|
||||||
|
if code.startswith("ERROR:"):
|
||||||
|
code = code[6:]
|
||||||
|
return code
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_pick_payload(payload: dict[str, Any]) -> dict[str, Any]:
|
||||||
|
if payload.get("success") is False:
|
||||||
|
err = payload.get("error") if isinstance(payload.get("error"), dict) else {}
|
||||||
|
code = _normalize_error_code(str(err.get("code") or ""))
|
||||||
|
message = str(err.get("message") or "")
|
||||||
|
if code == "LEASE_CONFLICT" or "LEASE_CONFLICT" in code:
|
||||||
|
raise AccountManagerError("LEASE_CONFLICT", LEASE_BUSY_MESSAGE)
|
||||||
|
if code in ("NO_ACCOUNT", "ACCOUNT_NOT_FOUND") or "NO_ACCOUNT" in code:
|
||||||
|
raise AccountManagerError("NO_ACCOUNT", message or "没有可用账号。")
|
||||||
|
raise AccountManagerError(code or "PICK_WEB_FAILED", message or "pick-web 失败。")
|
||||||
|
|
||||||
|
if not isinstance(payload, dict):
|
||||||
|
raise AccountManagerError("ACCOUNT_NOT_FOUND", "pick-web 返回格式异常。")
|
||||||
|
if not payload.get("profile_dir"):
|
||||||
|
raise AccountManagerError("ACCOUNT_NOT_FOUND", "pick-web 返回的账号缺少 profile_dir。")
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def _pick_web_with_lease(platform: str) -> Dict[str, Any]:
|
||||||
|
proc = _run_argv(
|
||||||
|
[
|
||||||
|
"account",
|
||||||
|
"pick-web",
|
||||||
|
"--platform",
|
||||||
|
platform,
|
||||||
|
"--lease",
|
||||||
|
"--holder",
|
||||||
|
LEASE_HOLDER,
|
||||||
|
"--ttl-sec",
|
||||||
|
LEASE_TTL_SEC,
|
||||||
|
]
|
||||||
|
)
|
||||||
|
out = proc.stdout or ""
|
||||||
|
if proc.returncode != 0 and not out.strip():
|
||||||
|
raise AccountManagerError(
|
||||||
|
"PICK_WEB_FAILED",
|
||||||
|
(proc.stderr or "").strip() or "pick-web 子进程失败",
|
||||||
|
)
|
||||||
|
payload = _parse_last_json(out)
|
||||||
|
if isinstance(payload, dict) and payload.get("success") is False:
|
||||||
|
return _validate_pick_payload(payload)
|
||||||
|
if not isinstance(payload, dict):
|
||||||
|
raise AccountManagerError("ACCOUNT_NOT_FOUND", "pick-web 返回格式异常。")
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def _pick_by_id(platform: str, account_id: int) -> Dict[str, Any]:
|
||||||
|
proc = _run_argv(["account", "get", str(account_id)])
|
||||||
|
out = proc.stdout or ""
|
||||||
|
if proc.returncode != 0 or out.startswith("ERROR:"):
|
||||||
|
raise AccountManagerError("ACCOUNT_NOT_FOUND", f"指定账号 {account_id} 不存在或获取失败。")
|
||||||
|
raw = _parse_last_json(out)
|
||||||
|
if isinstance(raw, dict) and "data" in raw and isinstance(raw["data"], dict):
|
||||||
|
data = raw["data"]
|
||||||
|
elif isinstance(raw, dict):
|
||||||
|
data = raw
|
||||||
|
else:
|
||||||
|
raise AccountManagerError("ACCOUNT_NOT_FOUND", "account get 返回非对象 JSON。")
|
||||||
|
|
||||||
|
platform_key = str(data.get("platform_key") or "").lower()
|
||||||
|
if platform_key != platform.lower():
|
||||||
|
raise AccountManagerError(
|
||||||
|
"ACCOUNT_NOT_FOUND",
|
||||||
|
f"账号 {account_id} 不是 {platform} 平台账号。",
|
||||||
|
)
|
||||||
|
profile_dir = str(data.get("profile_dir") or "").strip()
|
||||||
|
if not profile_dir:
|
||||||
|
raise AccountManagerError("ACCOUNT_NOT_FOUND", f"账号 {account_id} 缺少 profile_dir。")
|
||||||
|
data["profile_dir"] = profile_dir
|
||||||
|
data["lease_token"] = ""
|
||||||
|
return data
|
||||||
|
|
||||||
|
|
||||||
|
def pick_web_account(platform: str, account_id: Optional[str] = None) -> dict:
|
||||||
|
"""获取网页账号(profile_dir + lease_token)。"""
|
||||||
|
platform_key = (platform or PLACEHOLDER_PLATFORM).strip() or PLACEHOLDER_PLATFORM
|
||||||
|
|
||||||
|
if account_id:
|
||||||
|
try:
|
||||||
|
aid = int(account_id)
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
raise AccountManagerError("ACCOUNT_NOT_FOUND", f"账号 ID 无效:{account_id}")
|
||||||
|
return _pick_by_id(platform_key, aid)
|
||||||
|
|
||||||
|
try:
|
||||||
|
return _pick_web_with_lease(platform_key)
|
||||||
|
except AccountManagerError as exc:
|
||||||
|
if exc.code in ("NO_ACCOUNT", "ACCOUNT_NOT_FOUND") or "NO_ACCOUNT" in exc.code:
|
||||||
|
raise AccountManagerError("ACCOUNT_SETUP_REQUIRED", ACCOUNT_SETUP_MESSAGE) from exc
|
||||||
|
raise
|
||||||
|
|
||||||
|
|
||||||
|
def release_lease(lease_token: Optional[str]) -> None:
|
||||||
|
token = (lease_token or "").strip()
|
||||||
|
if not token:
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
proc = _run_argv(["lease", "release", token])
|
||||||
|
if proc.returncode != 0:
|
||||||
|
logger.warning("lease_release_failed stdout=%s", (proc.stdout or "").strip())
|
||||||
|
except Exception:
|
||||||
|
logger.warning("lease_release_exception", exc_info=True)
|
||||||
135
examples/real_browser_rpa/scripts/service/browser_session.py
Normal file
135
examples/real_browser_rpa/scripts/service/browser_session.py
Normal file
@@ -0,0 +1,135 @@
|
|||||||
|
"""浏览器会话启动(系统 Chrome/Edge + Playwright persistent context)。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
from typing import Any, Optional, Tuple
|
||||||
|
|
||||||
|
from util.constants import DEFAULT_START_URL
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
DEFAULT_PAGE_TIMEOUT_MS = 15_000
|
||||||
|
GOTO_TIMEOUT_MS = 60_000
|
||||||
|
|
||||||
|
STEALTH_INIT_SCRIPT = """
|
||||||
|
(() => {
|
||||||
|
try { Object.defineProperty(navigator, 'webdriver', { get: () => undefined }); } catch (e) {}
|
||||||
|
})();
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def get_start_url() -> str:
|
||||||
|
return (os.getenv("TARGET_START_URL") or DEFAULT_START_URL).strip() or DEFAULT_START_URL
|
||||||
|
|
||||||
|
|
||||||
|
def _headless_from_env() -> bool:
|
||||||
|
v = (os.getenv("OPENCLAW_BROWSER_HEADLESS") or "0").strip().lower()
|
||||||
|
return v in ("1", "true", "yes", "on")
|
||||||
|
|
||||||
|
|
||||||
|
def _find_chrome_executable() -> str | None:
|
||||||
|
try:
|
||||||
|
from jiangchang_skill_core.runtime_env import find_chrome_executable
|
||||||
|
|
||||||
|
chrome = find_chrome_executable()
|
||||||
|
if chrome and os.path.isfile(chrome):
|
||||||
|
return chrome
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
candidates = [
|
||||||
|
os.path.expandvars(r"%ProgramFiles%\Google\Chrome\Application\chrome.exe"),
|
||||||
|
os.path.expandvars(r"%ProgramFiles(x86)%\Google\Chrome\Application\chrome.exe"),
|
||||||
|
os.path.expandvars(r"%ProgramFiles%\Microsoft\Edge\Application\msedge.exe"),
|
||||||
|
os.path.expandvars(r"%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe"),
|
||||||
|
]
|
||||||
|
for path in candidates:
|
||||||
|
if path and os.path.isfile(path):
|
||||||
|
return path
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
async def start_browser_session(
|
||||||
|
profile_dir: str,
|
||||||
|
*,
|
||||||
|
headless: Optional[bool] = None,
|
||||||
|
) -> Tuple[Any, Any, Any]:
|
||||||
|
"""
|
||||||
|
启动持久化 Chrome profile,new_page + goto 入口页,返回 (playwright, context, page)。
|
||||||
|
|
||||||
|
真实 skill 需要安装 playwright 与 jiangchang_skill_core。
|
||||||
|
"""
|
||||||
|
from playwright.async_api import async_playwright
|
||||||
|
|
||||||
|
hl = headless if headless is not None else _headless_from_env()
|
||||||
|
start_url = get_start_url()
|
||||||
|
chrome = _find_chrome_executable()
|
||||||
|
if not chrome:
|
||||||
|
raise RuntimeError(
|
||||||
|
"ERROR:MISSING_BROWSER 未检测到 Chrome 或 Edge 浏览器,请先安装系统浏览器后重试。"
|
||||||
|
)
|
||||||
|
|
||||||
|
launch_args = ["--start-maximized", "--disable-blink-features=AutomationControlled"]
|
||||||
|
logger.info(
|
||||||
|
"browser_launch chrome=%s profile_dir=%s start_url=%s args=%s headless=%s",
|
||||||
|
chrome,
|
||||||
|
profile_dir,
|
||||||
|
start_url,
|
||||||
|
launch_args,
|
||||||
|
hl,
|
||||||
|
)
|
||||||
|
print(f"[浏览器] 系统 Chrome: {chrome}")
|
||||||
|
print(f"[浏览器] profile_dir: [{profile_dir}]")
|
||||||
|
print(f"[浏览器] startup_url={start_url}")
|
||||||
|
print(f"[浏览器] args={launch_args}")
|
||||||
|
|
||||||
|
pw = await async_playwright().start()
|
||||||
|
context = None
|
||||||
|
try:
|
||||||
|
context = await pw.chromium.launch_persistent_context(
|
||||||
|
user_data_dir=profile_dir,
|
||||||
|
headless=hl,
|
||||||
|
executable_path=chrome,
|
||||||
|
locale="zh-CN",
|
||||||
|
no_viewport=True,
|
||||||
|
args=launch_args,
|
||||||
|
ignore_default_args=["--enable-automation"],
|
||||||
|
)
|
||||||
|
await context.add_init_script(STEALTH_INIT_SCRIPT)
|
||||||
|
|
||||||
|
page = await context.new_page()
|
||||||
|
page.set_default_timeout(DEFAULT_PAGE_TIMEOUT_MS)
|
||||||
|
|
||||||
|
try:
|
||||||
|
await page.goto(start_url, wait_until="domcontentloaded", timeout=GOTO_TIMEOUT_MS)
|
||||||
|
except Exception as exc:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"浏览器已启动,但未能打开目标首页 {start_url}。"
|
||||||
|
"请检查网络、Chrome profile、代理或页面访问状态。"
|
||||||
|
f"({exc})"
|
||||||
|
) from exc
|
||||||
|
|
||||||
|
return pw, context, page
|
||||||
|
except Exception:
|
||||||
|
if context is not None:
|
||||||
|
try:
|
||||||
|
await context.close()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
await pw.stop()
|
||||||
|
raise
|
||||||
|
|
||||||
|
|
||||||
|
async def close_browser_context(pw, context) -> None:
|
||||||
|
try:
|
||||||
|
if context is not None:
|
||||||
|
await context.close()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
try:
|
||||||
|
if pw is not None:
|
||||||
|
await pw.stop()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
450
examples/real_browser_rpa/scripts/service/human_verification.py
Normal file
450
examples/real_browser_rpa/scripts/service/human_verification.py
Normal file
@@ -0,0 +1,450 @@
|
|||||||
|
"""人工验证等待:保存登录倒计时、滑块、短信验证码等(不自动破解)。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import logging
|
||||||
|
import random
|
||||||
|
import re
|
||||||
|
import time
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Optional
|
||||||
|
|
||||||
|
from util.constants import LOG_LOGGER_NAME
|
||||||
|
|
||||||
|
logger = logging.getLogger(LOG_LOGGER_NAME)
|
||||||
|
|
||||||
|
TEXT_EXCERPT_MAX = 120
|
||||||
|
|
||||||
|
SAVE_LOGIN_STRONG_MARKERS = (
|
||||||
|
"是否保存登录信息",
|
||||||
|
"下次登录更便捷",
|
||||||
|
"保存登录信息",
|
||||||
|
)
|
||||||
|
|
||||||
|
SAVE_LOGIN_CONTAINER_SELECTORS = (
|
||||||
|
"[role=\"dialog\"]",
|
||||||
|
".semi-modal",
|
||||||
|
".semi-modal-content",
|
||||||
|
)
|
||||||
|
|
||||||
|
SLIDER_SELECTORS = [
|
||||||
|
".vc-captcha-verify.slide",
|
||||||
|
".captcha_verify_bar--title",
|
||||||
|
".captcha-slider-tips",
|
||||||
|
"#captcha_verify_image",
|
||||||
|
".captcha-slider-btn",
|
||||||
|
]
|
||||||
|
|
||||||
|
SMS_SELECTORS = [
|
||||||
|
".second-verify-panel",
|
||||||
|
".uc-ui-verify_sms-input",
|
||||||
|
".uc-ui-verify-new_header-title",
|
||||||
|
"input[placeholder='手机号']",
|
||||||
|
"input[placeholder='请输入验证码']",
|
||||||
|
]
|
||||||
|
|
||||||
|
DIALOG_TEXT_CONTAINERS = [
|
||||||
|
"[role='dialog']",
|
||||||
|
".semi-modal",
|
||||||
|
".semi-modal-content",
|
||||||
|
".vc-captcha-verify",
|
||||||
|
".second-verify-panel",
|
||||||
|
]
|
||||||
|
|
||||||
|
RISK_MARKERS = (
|
||||||
|
"操作频繁",
|
||||||
|
"访问过于频繁",
|
||||||
|
"风险验证",
|
||||||
|
"安全验证",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class HumanVerificationState:
|
||||||
|
present: bool
|
||||||
|
kind: str
|
||||||
|
message: str
|
||||||
|
selector: str = ""
|
||||||
|
text_excerpt: str = ""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class HumanVerificationWaitResult:
|
||||||
|
timed_out: bool
|
||||||
|
kind: str = ""
|
||||||
|
code: str = ""
|
||||||
|
message: str = ""
|
||||||
|
stage: str = ""
|
||||||
|
|
||||||
|
|
||||||
|
def _text_excerpt(text: str) -> str:
|
||||||
|
cleaned = re.sub(r"\s+", " ", (text or "").strip())
|
||||||
|
if len(cleaned) <= TEXT_EXCERPT_MAX:
|
||||||
|
return cleaned
|
||||||
|
return cleaned[:TEXT_EXCERPT_MAX] + "..."
|
||||||
|
|
||||||
|
|
||||||
|
def _contains_any(text: str, markers: tuple[str, ...]) -> bool:
|
||||||
|
return any(m in text for m in markers)
|
||||||
|
|
||||||
|
|
||||||
|
async def _selector_visible(page, selector: str) -> bool:
|
||||||
|
try:
|
||||||
|
loc = page.locator(selector).first
|
||||||
|
return await loc.is_visible(timeout=500)
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
async def _selector_inner_text(page, selector: str) -> str:
|
||||||
|
try:
|
||||||
|
return await page.locator(selector).first.inner_text(timeout=1000)
|
||||||
|
except Exception:
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
async def _visible_text_from_first_visible(page, selectors: tuple[str, ...] | list[str]) -> tuple[str, str]:
|
||||||
|
for sel in selectors:
|
||||||
|
try:
|
||||||
|
loc = page.locator(sel).first
|
||||||
|
if await loc.is_visible(timeout=500):
|
||||||
|
text = await loc.inner_text(timeout=1000)
|
||||||
|
return sel, text or ""
|
||||||
|
except Exception:
|
||||||
|
continue
|
||||||
|
return "", ""
|
||||||
|
|
||||||
|
|
||||||
|
def _save_login_popup_from_text(text: str) -> bool:
|
||||||
|
if not text:
|
||||||
|
return False
|
||||||
|
if _contains_any(text, SAVE_LOGIN_STRONG_MARKERS):
|
||||||
|
return True
|
||||||
|
if "保存" in text and "取消" in text and ("登录" in text or "登录信息" in text):
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
async def detect_save_login_popup(page) -> bool:
|
||||||
|
sel, text = await _visible_text_from_first_visible(page, SAVE_LOGIN_CONTAINER_SELECTORS)
|
||||||
|
if sel and _save_login_popup_from_text(text):
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
async def wait_save_login_countdown_if_present(page, timeout_sec: int = 8) -> bool:
|
||||||
|
"""若出现“保存登录信息”倒计时弹窗则等待其消失;未出现则立即返回 False。"""
|
||||||
|
if not await detect_save_login_popup(page):
|
||||||
|
return False
|
||||||
|
|
||||||
|
logger.info("save_login_popup_detected")
|
||||||
|
print("[登录] 检测到“保存登录信息”倒计时弹窗,等待其自动关闭...")
|
||||||
|
start = time.monotonic()
|
||||||
|
deadline = start + timeout_sec
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
if not await detect_save_login_popup(page):
|
||||||
|
elapsed = round(time.monotonic() - start, 2)
|
||||||
|
logger.info("save_login_popup_gone elapsed_sec=%s", elapsed)
|
||||||
|
return True
|
||||||
|
await asyncio.sleep(0.5)
|
||||||
|
|
||||||
|
elapsed = round(time.monotonic() - start, 2)
|
||||||
|
logger.warning(
|
||||||
|
"save_login_popup_still_visible elapsed_sec=%s timeout_sec=%s",
|
||||||
|
elapsed,
|
||||||
|
timeout_sec,
|
||||||
|
)
|
||||||
|
print(
|
||||||
|
f"[登录] 警告:保存登录信息弹窗超过 {timeout_sec} 秒仍未消失,"
|
||||||
|
"将继续后续流程(您可能已手工点击保存/取消)。"
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
async def detect_slider_verification(page) -> Optional[HumanVerificationState]:
|
||||||
|
sel_slide = ".vc-captcha-verify.slide"
|
||||||
|
if await _selector_visible(page, sel_slide):
|
||||||
|
text = await _selector_inner_text(page, sel_slide)
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="slider",
|
||||||
|
message="滑块验证码",
|
||||||
|
selector=sel_slide,
|
||||||
|
text_excerpt=_text_excerpt(text),
|
||||||
|
)
|
||||||
|
|
||||||
|
sel_title = ".captcha_verify_bar--title"
|
||||||
|
if await _selector_visible(page, sel_title):
|
||||||
|
title_text = await _selector_inner_text(page, sel_title)
|
||||||
|
if "请完成下列验证后继续" in title_text:
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="slider",
|
||||||
|
message="滑块验证码",
|
||||||
|
selector=sel_title,
|
||||||
|
text_excerpt=_text_excerpt(title_text),
|
||||||
|
)
|
||||||
|
|
||||||
|
sel_tips = ".captcha-slider-tips"
|
||||||
|
if await _selector_visible(page, sel_tips):
|
||||||
|
tips_text = await _selector_inner_text(page, sel_tips)
|
||||||
|
if "拖动完成上方拼图" in tips_text:
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="slider",
|
||||||
|
message="滑块验证码",
|
||||||
|
selector=sel_tips,
|
||||||
|
text_excerpt=_text_excerpt(tips_text),
|
||||||
|
)
|
||||||
|
|
||||||
|
if await _selector_visible(page, "#captcha_verify_image"):
|
||||||
|
for btn_sel in (".captcha-slider-btn", ".captcha_verify_slide--button", ".captcha-slider"):
|
||||||
|
if await _selector_visible(page, btn_sel):
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="slider",
|
||||||
|
message="滑块验证码",
|
||||||
|
selector=f"#captcha_verify_image+{btn_sel}",
|
||||||
|
text_excerpt="",
|
||||||
|
)
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
async def detect_sms_verification(page) -> Optional[HumanVerificationState]:
|
||||||
|
sel_panel = ".second-verify-panel"
|
||||||
|
if await _selector_visible(page, sel_panel):
|
||||||
|
text = await _selector_inner_text(page, sel_panel)
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="sms",
|
||||||
|
message="短信验证码",
|
||||||
|
selector=sel_panel,
|
||||||
|
text_excerpt=_text_excerpt(text),
|
||||||
|
)
|
||||||
|
|
||||||
|
sel_sms = ".uc-ui-verify_sms-input"
|
||||||
|
if await _selector_visible(page, sel_sms):
|
||||||
|
text = await _selector_inner_text(page, sel_sms)
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="sms",
|
||||||
|
message="短信验证码",
|
||||||
|
selector=sel_sms,
|
||||||
|
text_excerpt=_text_excerpt(text),
|
||||||
|
)
|
||||||
|
|
||||||
|
sel_hdr = ".uc-ui-verify-new_header-title"
|
||||||
|
if await _selector_visible(page, sel_hdr):
|
||||||
|
hdr_text = await _selector_inner_text(page, sel_hdr)
|
||||||
|
if "短信验证" in hdr_text:
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="sms",
|
||||||
|
message="短信验证码",
|
||||||
|
selector=sel_hdr,
|
||||||
|
text_excerpt=_text_excerpt(hdr_text),
|
||||||
|
)
|
||||||
|
|
||||||
|
phone_visible = await _selector_visible(
|
||||||
|
page,
|
||||||
|
".second-verify-panel input[placeholder='手机号'], .uc-ui-verify_sms-input input[placeholder='手机号']",
|
||||||
|
)
|
||||||
|
code_visible = await _selector_visible(
|
||||||
|
page,
|
||||||
|
".second-verify-panel input[placeholder='请输入验证码'], .uc-ui-verify_sms-input input[placeholder='请输入验证码']",
|
||||||
|
)
|
||||||
|
if phone_visible and code_visible:
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="sms",
|
||||||
|
message="短信验证码",
|
||||||
|
selector="sms-phone-and-code-inputs",
|
||||||
|
text_excerpt="手机号+请输入验证码",
|
||||||
|
)
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
async def detect_human_verification_from_containers(page) -> Optional[HumanVerificationState]:
|
||||||
|
sel, text = await _visible_text_from_first_visible(page, DIALOG_TEXT_CONTAINERS)
|
||||||
|
if not sel or not text:
|
||||||
|
return None
|
||||||
|
|
||||||
|
if _contains_any(text, RISK_MARKERS):
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="risk",
|
||||||
|
message="安全/频控验证",
|
||||||
|
selector=sel,
|
||||||
|
text_excerpt=_text_excerpt(text),
|
||||||
|
)
|
||||||
|
|
||||||
|
if sel in (".vc-captcha-verify", ".vc-captcha-verify-visibility"):
|
||||||
|
if "请完成下列验证后继续" in text or "拖动完成上方拼图" in text:
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="slider",
|
||||||
|
message="滑块验证码",
|
||||||
|
selector=sel,
|
||||||
|
text_excerpt=_text_excerpt(text),
|
||||||
|
)
|
||||||
|
|
||||||
|
if sel in (".second-verify-panel", ".uc-ui-verify_sms-input"):
|
||||||
|
if "短信验证" in text or "获取验证码" in text:
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="sms",
|
||||||
|
message="短信验证码",
|
||||||
|
selector=sel,
|
||||||
|
text_excerpt=_text_excerpt(text),
|
||||||
|
)
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
async def detect_human_verification(page) -> HumanVerificationState:
|
||||||
|
"""主检测入口:仅在验证码/弹窗容器级检测,不扫整页 body。"""
|
||||||
|
state = await detect_slider_verification(page)
|
||||||
|
if state is not None:
|
||||||
|
return state
|
||||||
|
state = await detect_sms_verification(page)
|
||||||
|
if state is not None:
|
||||||
|
return state
|
||||||
|
state = await detect_human_verification_from_containers(page)
|
||||||
|
if state is not None:
|
||||||
|
return state
|
||||||
|
return HumanVerificationState(present=False, kind="", message="", selector="", text_excerpt="")
|
||||||
|
|
||||||
|
|
||||||
|
def detect_human_verification_from_text(text: str) -> HumanVerificationState:
|
||||||
|
"""
|
||||||
|
根据 HTML/容器文本判断验证弹窗(单元测试辅助,不能作为真实页面主检测入口)。
|
||||||
|
只检查验证容器 DOM 标记,不根据正文关键词误判。
|
||||||
|
"""
|
||||||
|
html_lower = (text or "").lower()
|
||||||
|
has_slider_dom = (
|
||||||
|
"vc-captcha-verify" in html_lower
|
||||||
|
and "slide" in html_lower
|
||||||
|
and (
|
||||||
|
"captcha-slider-tips" in html_lower
|
||||||
|
or "captcha_verify_bar--title" in html_lower
|
||||||
|
or "captcha_verify_image" in html_lower
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if has_slider_dom:
|
||||||
|
selector = ".vc-captcha-verify.slide"
|
||||||
|
if "captcha-slider-tips" in html_lower:
|
||||||
|
selector = ".captcha-slider-tips"
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="slider",
|
||||||
|
message="滑块验证码",
|
||||||
|
selector=selector,
|
||||||
|
text_excerpt="",
|
||||||
|
)
|
||||||
|
|
||||||
|
has_sms_dom = "second-verify-panel" in html_lower or "uc-ui-verify_sms-input" in html_lower
|
||||||
|
if has_sms_dom:
|
||||||
|
selector = ".second-verify-panel" if "second-verify-panel" in html_lower else ".uc-ui-verify_sms-input"
|
||||||
|
return HumanVerificationState(
|
||||||
|
present=True,
|
||||||
|
kind="sms",
|
||||||
|
message="短信验证码",
|
||||||
|
selector=selector,
|
||||||
|
text_excerpt="",
|
||||||
|
)
|
||||||
|
|
||||||
|
return HumanVerificationState(present=False, kind="", message="", selector="", text_excerpt="")
|
||||||
|
|
||||||
|
|
||||||
|
def _wait_log_message(state: HumanVerificationState, wait_sec: int) -> str:
|
||||||
|
if state.kind == "slider":
|
||||||
|
return f"[人工验证] 检测到滑块验证码,请在浏览器中手工完成,最多等待 {wait_sec} 秒..."
|
||||||
|
if state.kind == "sms":
|
||||||
|
return f"[人工验证] 检测到短信验证码,请在浏览器中手工完成,最多等待 {wait_sec} 秒..."
|
||||||
|
return f"[人工验证] 检测到安全验证,请在浏览器中手工处理,最多等待 {wait_sec} 秒..."
|
||||||
|
|
||||||
|
|
||||||
|
def _timeout_error_code(kind: str) -> str:
|
||||||
|
if kind == "slider":
|
||||||
|
return "SLIDER_VERIFICATION_TIMEOUT"
|
||||||
|
if kind == "sms":
|
||||||
|
return "SMS_VERIFICATION_TIMEOUT"
|
||||||
|
return "HUMAN_VERIFICATION_TIMEOUT"
|
||||||
|
|
||||||
|
|
||||||
|
def _timeout_error_message(kind: str, wait_sec: int) -> str:
|
||||||
|
if kind == "slider":
|
||||||
|
return (
|
||||||
|
f"滑块验证码未在 {wait_sec} 秒内完成,任务已停止。"
|
||||||
|
"请重新运行任务并及时在浏览器中完成验证。"
|
||||||
|
)
|
||||||
|
if kind == "sms":
|
||||||
|
return (
|
||||||
|
f"短信验证码未在 {wait_sec} 秒内完成,任务已停止。"
|
||||||
|
"请重新运行任务并及时完成短信验证。"
|
||||||
|
)
|
||||||
|
return (
|
||||||
|
f"安全验证未在 {wait_sec} 秒内完成,任务已停止。"
|
||||||
|
"请重新运行任务并及时在浏览器中完成验证。"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def wait_human_verification_if_present(
|
||||||
|
page,
|
||||||
|
*,
|
||||||
|
wait_sec: int = 180,
|
||||||
|
stage: str = "unknown",
|
||||||
|
) -> Optional[HumanVerificationWaitResult]:
|
||||||
|
"""
|
||||||
|
若存在人工验证则等待用户完成;无验证或已完成返回 None;超时返回 HumanVerificationWaitResult。
|
||||||
|
不自动拖动滑块、不自动填写短信验证码。
|
||||||
|
"""
|
||||||
|
state = await detect_human_verification(page)
|
||||||
|
if not state.present:
|
||||||
|
return None
|
||||||
|
|
||||||
|
logger.warning(
|
||||||
|
"human_verification_detected stage=%s kind=%s selector=%s text=%s",
|
||||||
|
stage,
|
||||||
|
state.kind,
|
||||||
|
state.selector,
|
||||||
|
state.text_excerpt,
|
||||||
|
)
|
||||||
|
print(_wait_log_message(state, wait_sec))
|
||||||
|
|
||||||
|
last_state = state
|
||||||
|
start = time.monotonic()
|
||||||
|
deadline = start + wait_sec
|
||||||
|
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
state = await detect_human_verification(page)
|
||||||
|
if not state.present:
|
||||||
|
elapsed = round(time.monotonic() - start, 2)
|
||||||
|
logger.info(
|
||||||
|
"human_verification_passed stage=%s kind=%s elapsed_sec=%s",
|
||||||
|
stage,
|
||||||
|
last_state.kind,
|
||||||
|
elapsed,
|
||||||
|
)
|
||||||
|
await asyncio.sleep(random.uniform(1.0, 2.0))
|
||||||
|
return None
|
||||||
|
last_state = state
|
||||||
|
await asyncio.sleep(2.0)
|
||||||
|
|
||||||
|
logger.warning(
|
||||||
|
"human_verification_timeout stage=%s kind=%s wait_sec=%s selector=%s",
|
||||||
|
stage,
|
||||||
|
last_state.kind,
|
||||||
|
wait_sec,
|
||||||
|
last_state.selector,
|
||||||
|
)
|
||||||
|
return HumanVerificationWaitResult(
|
||||||
|
timed_out=True,
|
||||||
|
kind=last_state.kind,
|
||||||
|
code=_timeout_error_code(last_state.kind),
|
||||||
|
message=_timeout_error_message(last_state.kind, wait_sec),
|
||||||
|
stage=stage,
|
||||||
|
)
|
||||||
641
examples/real_browser_rpa/scripts/service/task_rpa.py
Normal file
641
examples/real_browser_rpa/scripts/service/task_rpa.py
Normal file
@@ -0,0 +1,641 @@
|
|||||||
|
"""真实网站关键词搜索 RPA 示例(async Playwright)。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import random
|
||||||
|
import re
|
||||||
|
import time
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
from typing import Any, Callable, Dict, List, Optional, Tuple
|
||||||
|
|
||||||
|
from service.browser_session import close_browser_context, get_start_url, start_browser_session
|
||||||
|
from service.human_verification import (
|
||||||
|
HumanVerificationWaitResult,
|
||||||
|
wait_human_verification_if_present,
|
||||||
|
wait_save_login_countdown_if_present,
|
||||||
|
)
|
||||||
|
from util.constants import (
|
||||||
|
DEFAULT_MAX_ITEMS,
|
||||||
|
DEFAULT_MAX_SCROLLS,
|
||||||
|
DEFAULT_NO_NEW_ROUNDS_LIMIT,
|
||||||
|
HUMAN_WAIT_TIMEOUT,
|
||||||
|
LOG_LOGGER_NAME,
|
||||||
|
RESULT_CONTAINER_SELECTOR,
|
||||||
|
RESULT_END_TEXT,
|
||||||
|
RESULT_ITEM_SELECTOR,
|
||||||
|
SCROLL_CONTAINER_SELECTORS,
|
||||||
|
SEARCH_BUTTON_SELECTOR,
|
||||||
|
SEARCH_INPUT_SELECTORS,
|
||||||
|
)
|
||||||
|
from util.logging import mask_text, safe_log_value
|
||||||
|
|
||||||
|
logger = logging.getLogger(LOG_LOGGER_NAME)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class ScrapeError:
|
||||||
|
code: str
|
||||||
|
message: str
|
||||||
|
browser_started: bool = False
|
||||||
|
stage: Optional[str] = None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class ScrapeRunResult:
|
||||||
|
success: bool
|
||||||
|
items: List[Dict[str, Any]] = field(default_factory=list)
|
||||||
|
stop_reason: Optional[str] = None
|
||||||
|
error: Optional[ScrapeError] = None
|
||||||
|
|
||||||
|
|
||||||
|
StepCallback = Callable[[str], None]
|
||||||
|
|
||||||
|
# 示例登录态 selector — 复制到新 skill 后必须用目标站点 F12/DOM 实测替换,禁止凭经验猜测或跨平台照抄
|
||||||
|
LOGGED_IN_SELECTORS = (
|
||||||
|
"a[href*='/user/self']",
|
||||||
|
"[data-user-avatar]",
|
||||||
|
".user-avatar",
|
||||||
|
)
|
||||||
|
LOGGED_OUT_SELECTOR = "button:has-text('登录')"
|
||||||
|
|
||||||
|
|
||||||
|
def format_stop_reason_for_user(stop_reason: str | None, collected_count: int) -> str:
|
||||||
|
"""将内部 stop_reason 枚举翻译为用户可理解的中文说明。"""
|
||||||
|
if stop_reason == "max_items":
|
||||||
|
return (
|
||||||
|
f"已达到本次默认采集规模({collected_count} 条)。"
|
||||||
|
"如需更多,可以继续说「继续采集更多」或「尽量多采集」。"
|
||||||
|
)
|
||||||
|
if stop_reason == "end_marker":
|
||||||
|
return "页面提示没有更多结果,本次采集已完成。"
|
||||||
|
if stop_reason == "no_new_rounds":
|
||||||
|
return "连续多次加载没有发现新结果,本次采集已完成。"
|
||||||
|
if stop_reason == "max_scrolls":
|
||||||
|
return (
|
||||||
|
"已达到本次页面加载保护范围,本次采集已完成。"
|
||||||
|
"如需更深度采集,可以说明「尽量多采集」。"
|
||||||
|
)
|
||||||
|
if stop_reason == "human_verification_timeout":
|
||||||
|
return "人工验证未在规定时间内完成,任务已停止。"
|
||||||
|
return "本次采集已完成。"
|
||||||
|
|
||||||
|
|
||||||
|
def _mask_account_ref(account: Dict[str, Any]) -> str:
|
||||||
|
for key in ("login_id", "phone", "mobile"):
|
||||||
|
raw = str(account.get(key) or "").strip()
|
||||||
|
if raw:
|
||||||
|
return mask_text(raw)
|
||||||
|
aid = account.get("id") or account.get("account_id")
|
||||||
|
if aid is not None:
|
||||||
|
return f"id:{aid}"
|
||||||
|
return "unknown"
|
||||||
|
|
||||||
|
|
||||||
|
def _step_cb(cb: Optional[StepCallback], text: str) -> None:
|
||||||
|
if cb:
|
||||||
|
cb(text)
|
||||||
|
|
||||||
|
|
||||||
|
async def _random_delay() -> None:
|
||||||
|
lo = int(os.getenv("RPA_STEP_DELAY_MIN_MS") or "900")
|
||||||
|
hi = int(os.getenv("RPA_STEP_DELAY_MAX_MS") or "2600")
|
||||||
|
await asyncio.sleep(random.uniform(lo / 1000.0, hi / 1000.0))
|
||||||
|
|
||||||
|
|
||||||
|
async def _scroll_wait() -> None:
|
||||||
|
await asyncio.sleep(random.uniform(1.2, 3.5))
|
||||||
|
|
||||||
|
|
||||||
|
def _headless() -> bool:
|
||||||
|
v = (os.getenv("OPENCLAW_BROWSER_HEADLESS") or "0").strip().lower()
|
||||||
|
return v in ("1", "true", "yes", "on")
|
||||||
|
|
||||||
|
|
||||||
|
def _no_new_limit() -> int:
|
||||||
|
try:
|
||||||
|
return int(os.getenv("RPA_NO_NEW_ROUNDS_LIMIT") or str(DEFAULT_NO_NEW_ROUNDS_LIMIT))
|
||||||
|
except ValueError:
|
||||||
|
return DEFAULT_NO_NEW_ROUNDS_LIMIT
|
||||||
|
|
||||||
|
|
||||||
|
async def _visible(locator) -> bool:
|
||||||
|
try:
|
||||||
|
return await locator.count() > 0 and await locator.is_visible(timeout=500)
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
async def _is_logged_out(page) -> bool:
|
||||||
|
try:
|
||||||
|
btn = page.locator(LOGGED_OUT_SELECTOR).first
|
||||||
|
return await _visible(btn)
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
async def _is_logged_in(page) -> bool:
|
||||||
|
if await _is_logged_out(page):
|
||||||
|
return False
|
||||||
|
for sel in LOGGED_IN_SELECTORS:
|
||||||
|
try:
|
||||||
|
loc = page.locator(sel).first
|
||||||
|
if await _visible(loc):
|
||||||
|
return True
|
||||||
|
except Exception:
|
||||||
|
continue
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
async def _open_login_panel_if_needed(page) -> None:
|
||||||
|
if not await _is_logged_out(page):
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
btn = page.locator(LOGGED_OUT_SELECTOR).first
|
||||||
|
if await _visible(btn):
|
||||||
|
await btn.click()
|
||||||
|
await asyncio.sleep(random.uniform(1.0, 3.0))
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
async def _ensure_logged_in(page, *, wait_sec: int) -> None:
|
||||||
|
if await _is_logged_in(page):
|
||||||
|
return
|
||||||
|
|
||||||
|
await _open_login_panel_if_needed(page)
|
||||||
|
if await _is_logged_in(page):
|
||||||
|
return
|
||||||
|
|
||||||
|
print(f"[登录] 请在浏览器中完成登录,最多等待 {wait_sec} 秒...")
|
||||||
|
deadline = time.monotonic() + wait_sec
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
if await _is_logged_in(page):
|
||||||
|
print("[登录] 检测到登录成功")
|
||||||
|
return
|
||||||
|
await asyncio.sleep(2.0)
|
||||||
|
|
||||||
|
raise RuntimeError(
|
||||||
|
f"ERROR:LOGIN_TIMEOUT 浏览器已打开,但未完成登录。"
|
||||||
|
f"请重新运行任务并在浏览器打开后及时完成登录。"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def _find_search_input(page) -> Tuple[Optional[Any], str]:
|
||||||
|
for sel in SEARCH_INPUT_SELECTORS:
|
||||||
|
try:
|
||||||
|
loc = page.locator(sel).first
|
||||||
|
if await _visible(loc):
|
||||||
|
return loc, sel
|
||||||
|
except Exception:
|
||||||
|
continue
|
||||||
|
|
||||||
|
candidates: List[Tuple[int, Any, str]] = []
|
||||||
|
try:
|
||||||
|
inputs = await page.locator("input").all()
|
||||||
|
except Exception:
|
||||||
|
inputs = []
|
||||||
|
for inp in inputs:
|
||||||
|
try:
|
||||||
|
if not await inp.is_visible():
|
||||||
|
continue
|
||||||
|
box = await inp.bounding_box()
|
||||||
|
if not box or box.get("width", 0) < 120:
|
||||||
|
continue
|
||||||
|
placeholder = await inp.get_attribute("placeholder") or ""
|
||||||
|
score = box.get("width", 0)
|
||||||
|
if "搜索" in placeholder:
|
||||||
|
score += 500
|
||||||
|
if box.get("y", 9999) < 200:
|
||||||
|
score += 200
|
||||||
|
candidates.append((score, inp, f"input placeholder={placeholder!r}"))
|
||||||
|
except Exception:
|
||||||
|
continue
|
||||||
|
if candidates:
|
||||||
|
candidates.sort(key=lambda x: x[0], reverse=True)
|
||||||
|
_, inp, sel = candidates[0]
|
||||||
|
return inp, sel
|
||||||
|
|
||||||
|
try:
|
||||||
|
ph = page.get_by_placeholder(re.compile("搜索"))
|
||||||
|
if await ph.count() > 0 and await ph.first.is_visible():
|
||||||
|
return ph.first, "placeholder=搜索"
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
return None, ""
|
||||||
|
|
||||||
|
|
||||||
|
async def _find_search_button(page):
|
||||||
|
try:
|
||||||
|
btn = page.get_by_role("button", name="搜索")
|
||||||
|
if await btn.count() > 0 and await btn.first.is_visible():
|
||||||
|
return btn.first
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
try:
|
||||||
|
btn = page.locator(SEARCH_BUTTON_SELECTOR).first
|
||||||
|
if await btn.count() > 0 and await btn.is_visible():
|
||||||
|
return btn
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
async def _wait_search_results(page, timeout_sec: float = 45.0) -> bool:
|
||||||
|
deadline = time.monotonic() + timeout_sec
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
try:
|
||||||
|
url = page.url or ""
|
||||||
|
if "/search" in url or "search" in url.lower():
|
||||||
|
if await page.locator(RESULT_CONTAINER_SELECTOR).count() > 0:
|
||||||
|
return True
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
await asyncio.sleep(0.8)
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
async def _has_end_marker(page) -> bool:
|
||||||
|
try:
|
||||||
|
container = page.locator(RESULT_CONTAINER_SELECTOR).first
|
||||||
|
if await container.count() > 0:
|
||||||
|
text = await container.inner_text(timeout=2000)
|
||||||
|
if RESULT_END_TEXT in text or "暂时没有更多了" in text:
|
||||||
|
return True
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
try:
|
||||||
|
if await page.locator(f"text={RESULT_END_TEXT}").count() > 0:
|
||||||
|
return True
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
async def _mouse_wheel_scroll(page) -> Tuple[str, int]:
|
||||||
|
wheel_delta = random.randint(650, 1200)
|
||||||
|
for sel in SCROLL_CONTAINER_SELECTORS:
|
||||||
|
loc = page.locator(sel)
|
||||||
|
try:
|
||||||
|
if await loc.count() > 0 and await loc.first.is_visible():
|
||||||
|
await loc.first.hover()
|
||||||
|
await _random_delay()
|
||||||
|
await page.mouse.wheel(0, wheel_delta)
|
||||||
|
return sel, wheel_delta
|
||||||
|
except Exception:
|
||||||
|
continue
|
||||||
|
await page.mouse.wheel(0, wheel_delta)
|
||||||
|
return "page", wheel_delta
|
||||||
|
|
||||||
|
|
||||||
|
async def _parse_item_locator(item) -> Dict[str, Any]:
|
||||||
|
item_id = await item.get_attribute("data-item-id") or await item.get_attribute("id") or ""
|
||||||
|
title = ""
|
||||||
|
try:
|
||||||
|
title = (await item.inner_text(timeout=1000)).strip()[:200]
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
return {
|
||||||
|
"item_id": item_id or title[:32] or str(id(item)),
|
||||||
|
"title": title,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async def _collect_visible_items(page, seen_ids: set[str]) -> List[Dict[str, Any]]:
|
||||||
|
new_items: List[Dict[str, Any]] = []
|
||||||
|
try:
|
||||||
|
items = await page.locator(RESULT_ITEM_SELECTOR).all()
|
||||||
|
except Exception:
|
||||||
|
items = []
|
||||||
|
for item in items:
|
||||||
|
try:
|
||||||
|
parsed = await _parse_item_locator(item)
|
||||||
|
item_id = parsed.get("item_id")
|
||||||
|
if not item_id or item_id in seen_ids:
|
||||||
|
continue
|
||||||
|
seen_ids.add(str(item_id))
|
||||||
|
new_items.append(parsed)
|
||||||
|
except Exception:
|
||||||
|
continue
|
||||||
|
return new_items
|
||||||
|
|
||||||
|
|
||||||
|
async def _count_visible_items(page) -> int:
|
||||||
|
try:
|
||||||
|
return await page.locator(RESULT_ITEM_SELECTOR).count()
|
||||||
|
except Exception:
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def _fail_result(error: ScrapeError, *, collected: int = 0) -> ScrapeRunResult:
|
||||||
|
logger.warning(
|
||||||
|
"rpa_failed code=%s stage=%s message=%s collected=%s",
|
||||||
|
error.code,
|
||||||
|
error.stage,
|
||||||
|
error.message,
|
||||||
|
collected,
|
||||||
|
)
|
||||||
|
return ScrapeRunResult(success=False, error=error)
|
||||||
|
|
||||||
|
|
||||||
|
def _fail_on_verification_timeout(
|
||||||
|
verification_timeout: HumanVerificationWaitResult,
|
||||||
|
*,
|
||||||
|
collected: int = 0,
|
||||||
|
) -> ScrapeRunResult:
|
||||||
|
return _fail_result(
|
||||||
|
ScrapeError(
|
||||||
|
code=verification_timeout.code,
|
||||||
|
message=verification_timeout.message,
|
||||||
|
browser_started=True,
|
||||||
|
stage=verification_timeout.stage or "unknown",
|
||||||
|
),
|
||||||
|
collected=collected,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def run_keyword_search_async(
|
||||||
|
account: Dict[str, Any],
|
||||||
|
keyword: str,
|
||||||
|
*,
|
||||||
|
max_items: int = DEFAULT_MAX_ITEMS,
|
||||||
|
max_scrolls: int = DEFAULT_MAX_SCROLLS,
|
||||||
|
data_dir: str = "",
|
||||||
|
batch_id: str = "",
|
||||||
|
step_callback: Optional[StepCallback] = None,
|
||||||
|
) -> ScrapeRunResult:
|
||||||
|
profile_dir = account.get("profile_dir") or ""
|
||||||
|
account_ref = _mask_account_ref(account)
|
||||||
|
wait_sec = int(os.getenv("HUMAN_WAIT_TIMEOUT") or str(HUMAN_WAIT_TIMEOUT))
|
||||||
|
no_new_limit = _no_new_limit()
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
"rpa_start keyword=%s max_items=%s max_scrolls=%s wait_sec=%s batch_id=%s account_ref=%s",
|
||||||
|
safe_log_value(keyword),
|
||||||
|
max_items,
|
||||||
|
max_scrolls,
|
||||||
|
wait_sec,
|
||||||
|
batch_id,
|
||||||
|
account_ref,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not profile_dir:
|
||||||
|
err = ScrapeError(
|
||||||
|
"ACCOUNT_NOT_FOUND",
|
||||||
|
"账号缺少 profile_dir。",
|
||||||
|
browser_started=False,
|
||||||
|
stage="account_prepare",
|
||||||
|
)
|
||||||
|
return _fail_result(err)
|
||||||
|
|
||||||
|
pw = None
|
||||||
|
context = None
|
||||||
|
page = None
|
||||||
|
browser_started = False
|
||||||
|
collected_count = 0
|
||||||
|
|
||||||
|
try:
|
||||||
|
_step_cb(step_callback, "启动关键词搜索采集任务")
|
||||||
|
try:
|
||||||
|
pw, context, page = await start_browser_session(profile_dir, headless=_headless())
|
||||||
|
except RuntimeError as exc:
|
||||||
|
msg = str(exc)
|
||||||
|
err = ScrapeError(
|
||||||
|
"MISSING_BROWSER" if "MISSING_BROWSER" in msg else "UNKNOWN_ERROR",
|
||||||
|
msg.replace("ERROR:MISSING_BROWSER ", "").replace("ERROR:", ""),
|
||||||
|
browser_started="未能打开目标首页" in msg,
|
||||||
|
stage="browser_start" if "未能打开目标首页" in msg else "account_prepare",
|
||||||
|
)
|
||||||
|
return _fail_result(err)
|
||||||
|
browser_started = True
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
"browser_ready start_url=%s current_url=%s profile_dir_exists=%s",
|
||||||
|
get_start_url(),
|
||||||
|
page.url,
|
||||||
|
os.path.isdir(profile_dir),
|
||||||
|
)
|
||||||
|
|
||||||
|
_step_cb(step_callback, "打开目标站点首页")
|
||||||
|
await _random_delay()
|
||||||
|
|
||||||
|
verification_timeout = await wait_human_verification_if_present(
|
||||||
|
page, wait_sec=wait_sec, stage="browser_start"
|
||||||
|
)
|
||||||
|
if verification_timeout:
|
||||||
|
return _fail_on_verification_timeout(verification_timeout)
|
||||||
|
|
||||||
|
_step_cb(step_callback, "检查账号登录状态")
|
||||||
|
logger.info("login_check_start current_url=%s", page.url)
|
||||||
|
try:
|
||||||
|
await _ensure_logged_in(page, wait_sec=wait_sec)
|
||||||
|
except RuntimeError as exc:
|
||||||
|
msg = str(exc)
|
||||||
|
code = "LOGIN_TIMEOUT" if "LOGIN_TIMEOUT" in msg else "REQUIRE_LOGIN"
|
||||||
|
err = ScrapeError(
|
||||||
|
code,
|
||||||
|
msg.replace("ERROR:LOGIN_TIMEOUT ", "").replace("ERROR:", ""),
|
||||||
|
browser_started=True,
|
||||||
|
stage="login_check",
|
||||||
|
)
|
||||||
|
return _fail_result(err)
|
||||||
|
logger.info("login_check_done current_url=%s", page.url)
|
||||||
|
|
||||||
|
await wait_save_login_countdown_if_present(page)
|
||||||
|
|
||||||
|
verification_timeout = await wait_human_verification_if_present(
|
||||||
|
page, wait_sec=wait_sec, stage="login_check"
|
||||||
|
)
|
||||||
|
if verification_timeout:
|
||||||
|
return _fail_on_verification_timeout(verification_timeout)
|
||||||
|
|
||||||
|
_step_cb(step_callback, "定位搜索框")
|
||||||
|
search_input, input_selector = await _find_search_input(page)
|
||||||
|
if search_input is None:
|
||||||
|
err = ScrapeError(
|
||||||
|
"SEARCH_INPUT_NOT_FOUND",
|
||||||
|
"未找到搜索输入框。",
|
||||||
|
browser_started=True,
|
||||||
|
stage="search",
|
||||||
|
)
|
||||||
|
return _fail_result(err)
|
||||||
|
logger.info("search_input_found selector=%s", input_selector)
|
||||||
|
|
||||||
|
_step_cb(step_callback, f"输入关键词:{keyword}")
|
||||||
|
await search_input.click()
|
||||||
|
await _random_delay()
|
||||||
|
await page.keyboard.press("Control+A")
|
||||||
|
await page.keyboard.type(keyword, delay=random.randint(90, 240))
|
||||||
|
await _random_delay()
|
||||||
|
|
||||||
|
_step_cb(step_callback, "点击搜索")
|
||||||
|
search_btn = await _find_search_button(page)
|
||||||
|
search_method = "button"
|
||||||
|
if search_btn is not None:
|
||||||
|
await search_btn.click()
|
||||||
|
else:
|
||||||
|
search_method = "enter"
|
||||||
|
await page.keyboard.press("Enter")
|
||||||
|
logger.info(
|
||||||
|
"search_submitted keyword=%s method=%s current_url=%s",
|
||||||
|
safe_log_value(keyword),
|
||||||
|
search_method,
|
||||||
|
page.url,
|
||||||
|
)
|
||||||
|
await _random_delay()
|
||||||
|
|
||||||
|
verification_timeout = await wait_human_verification_if_present(
|
||||||
|
page, wait_sec=wait_sec, stage="search_verification"
|
||||||
|
)
|
||||||
|
if verification_timeout:
|
||||||
|
return _fail_on_verification_timeout(verification_timeout)
|
||||||
|
|
||||||
|
_step_cb(step_callback, "等待搜索结果")
|
||||||
|
if not await _wait_search_results(page):
|
||||||
|
verification_timeout = await wait_human_verification_if_present(
|
||||||
|
page, wait_sec=wait_sec, stage="search_results"
|
||||||
|
)
|
||||||
|
if verification_timeout:
|
||||||
|
return _fail_on_verification_timeout(verification_timeout)
|
||||||
|
|
||||||
|
if not await _wait_search_results(page, timeout_sec=10.0):
|
||||||
|
err = ScrapeError(
|
||||||
|
"RESULT_CONTAINER_NOT_FOUND",
|
||||||
|
"搜索结果未出现,且未检测到需要人工处理的验证码,请检查关键词或页面状态。",
|
||||||
|
browser_started=True,
|
||||||
|
stage="search",
|
||||||
|
)
|
||||||
|
return _fail_result(err)
|
||||||
|
|
||||||
|
container_count = await page.locator(RESULT_CONTAINER_SELECTOR).count()
|
||||||
|
logger.info(
|
||||||
|
"search_results_ready current_url=%s container_count=%s",
|
||||||
|
page.url,
|
||||||
|
container_count,
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
await page.locator(RESULT_CONTAINER_SELECTOR).first.wait_for(state="visible", timeout=15_000)
|
||||||
|
except Exception:
|
||||||
|
err = ScrapeError(
|
||||||
|
"RESULT_CONTAINER_NOT_FOUND",
|
||||||
|
"搜索结果容器未出现。",
|
||||||
|
browser_started=True,
|
||||||
|
stage="search",
|
||||||
|
)
|
||||||
|
return _fail_result(err)
|
||||||
|
|
||||||
|
seen_ids: set[str] = set()
|
||||||
|
collected: List[Dict[str, Any]] = []
|
||||||
|
no_new_rounds = 0
|
||||||
|
stop_reason = "max_scrolls"
|
||||||
|
rounds_executed = 0
|
||||||
|
|
||||||
|
for scroll_round in range(max_scrolls + 1):
|
||||||
|
rounds_executed = scroll_round
|
||||||
|
_step_cb(step_callback, "读取当前结果列表")
|
||||||
|
visible_count = await _count_visible_items(page)
|
||||||
|
batch = await _collect_visible_items(page, seen_ids)
|
||||||
|
new_count = len(batch)
|
||||||
|
if batch:
|
||||||
|
collected.extend(batch)
|
||||||
|
no_new_rounds = 0
|
||||||
|
else:
|
||||||
|
no_new_rounds += 1
|
||||||
|
|
||||||
|
collected_count = len(collected)
|
||||||
|
end_marker = await _has_end_marker(page)
|
||||||
|
logger.info(
|
||||||
|
"collect_round round=%s max_scrolls=%s visible_count=%s new_count=%s "
|
||||||
|
"collected=%s no_new_rounds=%s no_new_limit=%s end_marker=%s current_url=%s",
|
||||||
|
scroll_round,
|
||||||
|
max_scrolls,
|
||||||
|
visible_count,
|
||||||
|
new_count,
|
||||||
|
collected_count,
|
||||||
|
no_new_rounds,
|
||||||
|
no_new_limit,
|
||||||
|
end_marker,
|
||||||
|
page.url,
|
||||||
|
)
|
||||||
|
|
||||||
|
if len(collected) >= max_items:
|
||||||
|
collected = collected[:max_items]
|
||||||
|
stop_reason = "max_items"
|
||||||
|
break
|
||||||
|
|
||||||
|
if end_marker:
|
||||||
|
stop_reason = "end_marker"
|
||||||
|
_step_cb(step_callback, "发现结果到底或达到采集数量")
|
||||||
|
break
|
||||||
|
|
||||||
|
if no_new_rounds >= no_new_limit:
|
||||||
|
stop_reason = "no_new_rounds"
|
||||||
|
logger.info(
|
||||||
|
"collect_no_new_stop round=%s no_new_rounds=%s no_new_limit=%s collected=%s",
|
||||||
|
scroll_round,
|
||||||
|
no_new_rounds,
|
||||||
|
no_new_limit,
|
||||||
|
collected_count,
|
||||||
|
)
|
||||||
|
break
|
||||||
|
|
||||||
|
if scroll_round >= max_scrolls:
|
||||||
|
break
|
||||||
|
|
||||||
|
_step_cb(step_callback, "滚动加载更多结果")
|
||||||
|
scroll_target, wheel_delta = await _mouse_wheel_scroll(page)
|
||||||
|
logger.info(
|
||||||
|
"scroll round=%s target=%s wheel_delta=%s",
|
||||||
|
scroll_round,
|
||||||
|
scroll_target,
|
||||||
|
wheel_delta,
|
||||||
|
)
|
||||||
|
await _scroll_wait()
|
||||||
|
|
||||||
|
verification_timeout = await wait_human_verification_if_present(
|
||||||
|
page, wait_sec=wait_sec, stage="collect"
|
||||||
|
)
|
||||||
|
if verification_timeout:
|
||||||
|
return _fail_on_verification_timeout(
|
||||||
|
verification_timeout,
|
||||||
|
collected=collected_count,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
"collect_stop reason=%s collected=%s rounds=%s no_new_rounds=%s",
|
||||||
|
stop_reason,
|
||||||
|
collected_count,
|
||||||
|
rounds_executed,
|
||||||
|
no_new_rounds,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not collected:
|
||||||
|
err = ScrapeError(
|
||||||
|
"NO_RESULTS",
|
||||||
|
"未采集到任何结果。",
|
||||||
|
browser_started=True,
|
||||||
|
stage="collect",
|
||||||
|
)
|
||||||
|
return _fail_result(err, collected=0)
|
||||||
|
|
||||||
|
_step_cb(step_callback, "采集完成")
|
||||||
|
logger.info(
|
||||||
|
"rpa_success collected=%s stop_reason=%s",
|
||||||
|
len(collected[:max_items]),
|
||||||
|
stop_reason,
|
||||||
|
)
|
||||||
|
return ScrapeRunResult(success=True, items=collected[:max_items], stop_reason=stop_reason)
|
||||||
|
|
||||||
|
except Exception as exc:
|
||||||
|
err = ScrapeError(
|
||||||
|
"UNKNOWN_ERROR",
|
||||||
|
str(exc),
|
||||||
|
browser_started=browser_started,
|
||||||
|
stage="rpa",
|
||||||
|
)
|
||||||
|
return _fail_result(err, collected=collected_count)
|
||||||
|
finally:
|
||||||
|
await close_browser_context(pw, context)
|
||||||
137
examples/real_browser_rpa/scripts/service/task_service.py
Normal file
137
examples/real_browser_rpa/scripts/service/task_service.py
Normal file
@@ -0,0 +1,137 @@
|
|||||||
|
"""轻量任务编排示例(无真实数据库依赖)。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import uuid
|
||||||
|
from typing import Any, Optional
|
||||||
|
|
||||||
|
from service.account_client import AccountManagerError, pick_web_account, release_lease
|
||||||
|
from service.task_rpa import (
|
||||||
|
ScrapeRunResult,
|
||||||
|
format_stop_reason_for_user,
|
||||||
|
run_keyword_search_async,
|
||||||
|
)
|
||||||
|
from util.constants import (
|
||||||
|
DEFAULT_MAX_ITEMS,
|
||||||
|
DEFAULT_MAX_SCROLLS,
|
||||||
|
SKILL_SLUG,
|
||||||
|
TARGET_PLATFORM,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _error_payload(
|
||||||
|
code: str,
|
||||||
|
message: str,
|
||||||
|
*,
|
||||||
|
browser_started: Optional[bool] = None,
|
||||||
|
stage: Optional[str] = None,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
payload: dict[str, Any] = {
|
||||||
|
"success": False,
|
||||||
|
"error": {"code": code, "message": message},
|
||||||
|
}
|
||||||
|
if browser_started is not None:
|
||||||
|
payload["browser_started"] = browser_started
|
||||||
|
if stage:
|
||||||
|
payload["stage"] = stage
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def _success_payload(
|
||||||
|
*,
|
||||||
|
keyword: str,
|
||||||
|
collected_count: int,
|
||||||
|
items: list[dict[str, Any]],
|
||||||
|
stop_reason: Optional[str],
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"success": True,
|
||||||
|
"skill": SKILL_SLUG,
|
||||||
|
"keyword": keyword,
|
||||||
|
"collected_count": collected_count,
|
||||||
|
"items": items,
|
||||||
|
"stop_reason": stop_reason,
|
||||||
|
"stop_reason_message": format_stop_reason_for_user(stop_reason, collected_count),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async def run_keyword_search_task(
|
||||||
|
keyword: str,
|
||||||
|
*,
|
||||||
|
max_items: int = DEFAULT_MAX_ITEMS,
|
||||||
|
max_scrolls: int = DEFAULT_MAX_SCROLLS,
|
||||||
|
account_id: Optional[str] = None,
|
||||||
|
platform: str = TARGET_PLATFORM,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""
|
||||||
|
编排一次关键词搜索采集。
|
||||||
|
|
||||||
|
真实 skill 中还应:
|
||||||
|
- 写 SQLite 入库(items 表)
|
||||||
|
- 写 scrape_tasks / task_logs 任务日志
|
||||||
|
- 使用 RpaVideoSession 录制步骤留痕
|
||||||
|
- 失败时 capture_failure 截图
|
||||||
|
"""
|
||||||
|
batch_id = uuid.uuid4().hex[:12]
|
||||||
|
data_dir = "" # 示例占位;真实 skill 使用 get_skill_data_dir()
|
||||||
|
lease_token: Optional[str] = None
|
||||||
|
account: Optional[dict[str, Any]] = None
|
||||||
|
|
||||||
|
try:
|
||||||
|
account = pick_web_account(platform, account_id)
|
||||||
|
lease_token = account.get("lease_token")
|
||||||
|
|
||||||
|
scrape_result: ScrapeRunResult = await run_keyword_search_async(
|
||||||
|
account,
|
||||||
|
keyword,
|
||||||
|
max_items=max_items,
|
||||||
|
max_scrolls=max_scrolls,
|
||||||
|
data_dir=data_dir,
|
||||||
|
batch_id=batch_id,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not scrape_result.success:
|
||||||
|
err = scrape_result.error
|
||||||
|
return _error_payload(
|
||||||
|
err.code if err else "UNKNOWN_ERROR",
|
||||||
|
err.message if err else "未知错误",
|
||||||
|
browser_started=err.browser_started if err else True,
|
||||||
|
stage=err.stage if err else "rpa",
|
||||||
|
)
|
||||||
|
|
||||||
|
collected_count = len(scrape_result.items)
|
||||||
|
return _success_payload(
|
||||||
|
keyword=keyword,
|
||||||
|
collected_count=collected_count,
|
||||||
|
items=scrape_result.items[:10],
|
||||||
|
stop_reason=scrape_result.stop_reason,
|
||||||
|
)
|
||||||
|
except AccountManagerError as exc:
|
||||||
|
return _error_payload(
|
||||||
|
exc.code,
|
||||||
|
exc.message,
|
||||||
|
browser_started=False,
|
||||||
|
stage="account_prepare",
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
release_lease(lease_token)
|
||||||
|
|
||||||
|
|
||||||
|
def run_keyword_search_task_sync(
|
||||||
|
keyword: str,
|
||||||
|
*,
|
||||||
|
max_items: int = DEFAULT_MAX_ITEMS,
|
||||||
|
max_scrolls: int = DEFAULT_MAX_SCROLLS,
|
||||||
|
account_id: Optional[str] = None,
|
||||||
|
platform: str = TARGET_PLATFORM,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
return asyncio.run(
|
||||||
|
run_keyword_search_task(
|
||||||
|
keyword,
|
||||||
|
max_items=max_items,
|
||||||
|
max_scrolls=max_scrolls,
|
||||||
|
account_id=account_id,
|
||||||
|
platform=platform,
|
||||||
|
)
|
||||||
|
)
|
||||||
31
examples/real_browser_rpa/scripts/util/constants.py
Normal file
31
examples/real_browser_rpa/scripts/util/constants.py
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
"""示例常量(复制到新 skill 时请替换为目标站点与业务字段)。"""
|
||||||
|
|
||||||
|
SKILL_SLUG = "example-real-browser-rpa"
|
||||||
|
LOG_LOGGER_NAME = "openclaw.skill.example_real_browser_rpa"
|
||||||
|
|
||||||
|
TARGET_PLATFORM = "target_platform"
|
||||||
|
LEASE_HOLDER = "example-real-browser-rpa"
|
||||||
|
LEASE_TTL_SEC = "1800"
|
||||||
|
|
||||||
|
DEFAULT_START_URL = "https://example.com"
|
||||||
|
DEFAULT_MAX_ITEMS = 100
|
||||||
|
DEFAULT_MAX_SCROLLS = 40
|
||||||
|
DEFAULT_NO_NEW_ROUNDS_LIMIT = 5
|
||||||
|
HUMAN_WAIT_TIMEOUT = 180
|
||||||
|
|
||||||
|
RESULT_END_TEXT = "没有更多结果了"
|
||||||
|
|
||||||
|
# 示例 selector — 复制到新 skill 时按目标站点 DOM 替换
|
||||||
|
SEARCH_INPUT_SELECTORS = (
|
||||||
|
'input[type="search"]',
|
||||||
|
'input[name="q"]',
|
||||||
|
'input[placeholder*="搜索"]',
|
||||||
|
)
|
||||||
|
SEARCH_BUTTON_SELECTOR = 'button:has-text("搜索")'
|
||||||
|
RESULT_CONTAINER_SELECTOR = "#search-result-container"
|
||||||
|
RESULT_ITEM_SELECTOR = "[data-result-item]"
|
||||||
|
SCROLL_CONTAINER_SELECTORS = (
|
||||||
|
"#search-result-container",
|
||||||
|
".search-result-scroll",
|
||||||
|
".route-scroll-container",
|
||||||
|
)
|
||||||
34
examples/real_browser_rpa/scripts/util/logging.py
Normal file
34
examples/real_browser_rpa/scripts/util/logging.py
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
"""示例结构化日志工具。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import re
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from util.constants import LOG_LOGGER_NAME
|
||||||
|
|
||||||
|
|
||||||
|
def get_logger(name: str | None = None) -> logging.Logger:
|
||||||
|
return logging.getLogger(name or LOG_LOGGER_NAME)
|
||||||
|
|
||||||
|
|
||||||
|
def mask_text(value: str, *, keep_start: int = 2, keep_end: int = 2) -> str:
|
||||||
|
s = (value or "").strip()
|
||||||
|
if len(s) >= 11 and s.isdigit():
|
||||||
|
return s[:3] + "****" + s[-4:]
|
||||||
|
if len(s) > keep_start + keep_end:
|
||||||
|
return s[:keep_start] + "****" + s[-keep_end:]
|
||||||
|
return "****"
|
||||||
|
|
||||||
|
|
||||||
|
def safe_log_value(value: Any) -> str:
|
||||||
|
if value is None:
|
||||||
|
return ""
|
||||||
|
text = str(value)
|
||||||
|
if re.fullmatch(r"\d{7,}", text):
|
||||||
|
return mask_text(text)
|
||||||
|
if "@" in text and len(text) > 6:
|
||||||
|
local, _, domain = text.partition("@")
|
||||||
|
return f"{mask_text(local, keep_start=1, keep_end=1)}@{domain}"
|
||||||
|
return text
|
||||||
10
examples/real_browser_rpa/tests/conftest.py
Normal file
10
examples/real_browser_rpa/tests/conftest.py
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
"""pytest 路径配置:将 examples/real_browser_rpa/scripts 加入 import 路径。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
SCRIPTS = Path(__file__).resolve().parents[1] / "scripts"
|
||||||
|
if str(SCRIPTS) not in sys.path:
|
||||||
|
sys.path.insert(0, str(SCRIPTS))
|
||||||
170
examples/real_browser_rpa/tests/test_human_verification.py
Normal file
170
examples/real_browser_rpa/tests/test_human_verification.py
Normal file
@@ -0,0 +1,170 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""人工验证检测单元测试(DOM 精准检测,不依赖真实浏览器)。"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import time
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
from service.human_verification import (
|
||||||
|
HumanVerificationWaitResult,
|
||||||
|
detect_human_verification,
|
||||||
|
detect_human_verification_from_text,
|
||||||
|
wait_human_verification_if_present,
|
||||||
|
wait_save_login_countdown_if_present,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
SLIDER_HTML = """
|
||||||
|
<div class="vc-captcha-verify slide">
|
||||||
|
<div class="captcha_verify_bar--title">请完成下列验证后继续</div>
|
||||||
|
<div class="captcha-slider-tips">按住左边按钮拖动完成上方拼图</div>
|
||||||
|
</div>
|
||||||
|
"""
|
||||||
|
|
||||||
|
SMS_HTML = """
|
||||||
|
<div class="second-verify-panel">
|
||||||
|
<div class="uc-ui-verify_sms-input">
|
||||||
|
<div class="uc-ui-verify-new_header-title">短信验证</div>
|
||||||
|
<input placeholder="手机号" />
|
||||||
|
<input placeholder="请输入验证码" />
|
||||||
|
<button>获取验证码</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
"""
|
||||||
|
|
||||||
|
SEARCH_RESULTS_HTML = """
|
||||||
|
<div id="search-result-container">
|
||||||
|
<div data-result-item="1">RPA 滑块验证码识别教程</div>
|
||||||
|
<div data-result-item="2">短信验证码自动化</div>
|
||||||
|
</div>
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class MockLocator:
|
||||||
|
def __init__(self, selector: str, visible: set[str], texts: dict[str, str]) -> None:
|
||||||
|
self._selector = selector
|
||||||
|
self._visible = visible
|
||||||
|
self._texts = texts
|
||||||
|
|
||||||
|
@property
|
||||||
|
def first(self) -> MockLocator:
|
||||||
|
return self
|
||||||
|
|
||||||
|
async def is_visible(self, timeout: int = 500) -> bool:
|
||||||
|
return self._selector in self._visible
|
||||||
|
|
||||||
|
async def inner_text(self, timeout: int = 1000) -> str:
|
||||||
|
return self._texts.get(self._selector, "")
|
||||||
|
|
||||||
|
async def count(self) -> int:
|
||||||
|
return 1 if self._selector in self._visible else 0
|
||||||
|
|
||||||
|
|
||||||
|
class MockPage:
|
||||||
|
def __init__(self, visible: set[str], texts: dict[str, str] | None = None) -> None:
|
||||||
|
self._visible = visible
|
||||||
|
self._texts = texts or {}
|
||||||
|
|
||||||
|
def locator(self, selector: str) -> MockLocator:
|
||||||
|
return MockLocator(selector, self._visible, self._texts)
|
||||||
|
|
||||||
|
|
||||||
|
class TestHumanVerificationFromText(unittest.TestCase):
|
||||||
|
def test_slider_dom_detect(self) -> None:
|
||||||
|
state = detect_human_verification_from_text(SLIDER_HTML)
|
||||||
|
self.assertTrue(state.present)
|
||||||
|
self.assertEqual(state.kind, "slider")
|
||||||
|
self.assertTrue(state.selector)
|
||||||
|
|
||||||
|
def test_sms_dom_detect(self) -> None:
|
||||||
|
state = detect_human_verification_from_text(SMS_HTML)
|
||||||
|
self.assertTrue(state.present)
|
||||||
|
self.assertEqual(state.kind, "sms")
|
||||||
|
self.assertTrue(state.selector)
|
||||||
|
|
||||||
|
def test_search_results_not_misclassified(self) -> None:
|
||||||
|
state = detect_human_verification_from_text(SEARCH_RESULTS_HTML)
|
||||||
|
self.assertFalse(state.present)
|
||||||
|
|
||||||
|
def test_body_keywords_without_dom_not_misclassified(self) -> None:
|
||||||
|
text = "RPA 滑块验证码识别教程\n短信验证码自动化"
|
||||||
|
state = detect_human_verification_from_text(text)
|
||||||
|
self.assertFalse(state.present)
|
||||||
|
|
||||||
|
|
||||||
|
class TestHumanVerificationDomDetect(unittest.TestCase):
|
||||||
|
def test_slider_dom_visible(self) -> None:
|
||||||
|
page = MockPage(
|
||||||
|
{".vc-captcha-verify.slide"},
|
||||||
|
{".vc-captcha-verify.slide": "请完成下列验证后继续"},
|
||||||
|
)
|
||||||
|
state = asyncio.run(detect_human_verification(page))
|
||||||
|
self.assertTrue(state.present)
|
||||||
|
self.assertEqual(state.kind, "slider")
|
||||||
|
self.assertEqual(state.selector, ".vc-captcha-verify.slide")
|
||||||
|
|
||||||
|
def test_sms_dom_visible(self) -> None:
|
||||||
|
page = MockPage(
|
||||||
|
{".second-verify-panel"},
|
||||||
|
{".second-verify-panel": "短信验证 获取验证码"},
|
||||||
|
)
|
||||||
|
state = asyncio.run(detect_human_verification(page))
|
||||||
|
self.assertTrue(state.present)
|
||||||
|
self.assertEqual(state.kind, "sms")
|
||||||
|
|
||||||
|
def test_no_verification_when_empty(self) -> None:
|
||||||
|
page = MockPage(set())
|
||||||
|
state = asyncio.run(detect_human_verification(page))
|
||||||
|
self.assertFalse(state.present)
|
||||||
|
|
||||||
|
|
||||||
|
class TestSaveLoginCountdown(unittest.TestCase):
|
||||||
|
def test_wait_not_present_no_delay(self) -> None:
|
||||||
|
page = MockPage(set())
|
||||||
|
start = time.monotonic()
|
||||||
|
result = asyncio.run(wait_save_login_countdown_if_present(page, timeout_sec=8))
|
||||||
|
elapsed = time.monotonic() - start
|
||||||
|
self.assertFalse(result)
|
||||||
|
self.assertLess(elapsed, 1.0)
|
||||||
|
|
||||||
|
|
||||||
|
class TestHumanVerificationWait(unittest.TestCase):
|
||||||
|
def test_wait_timeout_slider_dom(self) -> None:
|
||||||
|
page = MockPage(
|
||||||
|
{".vc-captcha-verify.slide"},
|
||||||
|
{".vc-captcha-verify.slide": "请完成下列验证后继续"},
|
||||||
|
)
|
||||||
|
result = asyncio.run(
|
||||||
|
wait_human_verification_if_present(page, wait_sec=1, stage="search_verification")
|
||||||
|
)
|
||||||
|
self.assertIsInstance(result, HumanVerificationWaitResult)
|
||||||
|
self.assertTrue(result.timed_out)
|
||||||
|
self.assertEqual(result.code, "SLIDER_VERIFICATION_TIMEOUT")
|
||||||
|
self.assertIn("滑块验证码未在 1 秒内完成", result.message)
|
||||||
|
self.assertEqual(result.stage, "search_verification")
|
||||||
|
|
||||||
|
def test_wait_timeout_sms_dom(self) -> None:
|
||||||
|
page = MockPage(
|
||||||
|
{".second-verify-panel"},
|
||||||
|
{".second-verify-panel": "短信验证 获取验证码"},
|
||||||
|
)
|
||||||
|
result = asyncio.run(
|
||||||
|
wait_human_verification_if_present(page, wait_sec=1, stage="login_check")
|
||||||
|
)
|
||||||
|
self.assertIsInstance(result, HumanVerificationWaitResult)
|
||||||
|
self.assertTrue(result.timed_out)
|
||||||
|
self.assertEqual(result.code, "SMS_VERIFICATION_TIMEOUT")
|
||||||
|
self.assertEqual(result.stage, "login_check")
|
||||||
|
|
||||||
|
def test_collect_no_verification_immediate_none(self) -> None:
|
||||||
|
page = MockPage(set())
|
||||||
|
start = time.monotonic()
|
||||||
|
err = asyncio.run(wait_human_verification_if_present(page, wait_sec=180, stage="collect"))
|
||||||
|
elapsed = time.monotonic() - start
|
||||||
|
self.assertIsNone(err)
|
||||||
|
self.assertLess(elapsed, 1.0)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
34
examples/real_browser_rpa/tests/test_stop_reason.py
Normal file
34
examples/real_browser_rpa/tests/test_stop_reason.py
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""stop_reason 用户友好文案单元测试。"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
from service.task_rpa import format_stop_reason_for_user
|
||||||
|
|
||||||
|
|
||||||
|
class TestFormatStopReasonForUser(unittest.TestCase):
|
||||||
|
def test_max_items(self) -> None:
|
||||||
|
msg = format_stop_reason_for_user("max_items", 100)
|
||||||
|
self.assertIn("默认采集规模", msg)
|
||||||
|
self.assertIn("100", msg)
|
||||||
|
|
||||||
|
def test_end_marker(self) -> None:
|
||||||
|
msg = format_stop_reason_for_user("end_marker", 42)
|
||||||
|
self.assertIn("没有更多结果", msg)
|
||||||
|
|
||||||
|
def test_no_new_rounds(self) -> None:
|
||||||
|
msg = format_stop_reason_for_user("no_new_rounds", 30)
|
||||||
|
self.assertIn("连续多次加载没有发现新结果", msg)
|
||||||
|
|
||||||
|
def test_max_scrolls(self) -> None:
|
||||||
|
msg = format_stop_reason_for_user("max_scrolls", 80)
|
||||||
|
self.assertIn("页面加载保护范围", msg)
|
||||||
|
|
||||||
|
def test_none_or_unknown(self) -> None:
|
||||||
|
self.assertEqual(format_stop_reason_for_user(None, 10), "本次采集已完成。")
|
||||||
|
self.assertEqual(format_stop_reason_for_user("unknown", 10), "本次采集已完成。")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
15
examples/simulator_api/README.md
Normal file
15
examples/simulator_api/README.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Simulator API Example
|
||||||
|
|
||||||
|
这个目录用于沉淀“仿真环境 / API”类 skill 的可复制成功案例。
|
||||||
|
|
||||||
|
## 适用场景
|
||||||
|
|
||||||
|
- 使用 mock / sandbox / simulator API
|
||||||
|
- 不需要启动浏览器
|
||||||
|
- 适合演示输入校验、API 调用、结果入库、日志、错误契约和测试
|
||||||
|
|
||||||
|
## 当前状态
|
||||||
|
|
||||||
|
- 本目录暂时只保留结构占位。
|
||||||
|
- 示例业务尚未确定。
|
||||||
|
- 本轮不包含示例代码。
|
||||||
0
examples/simulator_api/scripts/service/.gitkeep
Normal file
0
examples/simulator_api/scripts/service/.gitkeep
Normal file
0
examples/simulator_api/scripts/util/.gitkeep
Normal file
0
examples/simulator_api/scripts/util/.gitkeep
Normal file
0
examples/simulator_api/tests/.gitkeep
Normal file
0
examples/simulator_api/tests/.gitkeep
Normal file
125
examples/simulator_browser_rpa/README.md
Normal file
125
examples/simulator_browser_rpa/README.md
Normal file
@@ -0,0 +1,125 @@
|
|||||||
|
# Simulator Browser RPA Example
|
||||||
|
|
||||||
|
这是一个**仿真浏览器 RPA** 的可复制参考实现:在可控 sandbox 页面上,通过 Playwright 完成登录、表单填写、弹窗确认、结果解析。
|
||||||
|
|
||||||
|
本示例抽象自已跑通的「批量提交类」浏览器自动化 skill,但已去业务化,不包含真实银行/真实资金语义。
|
||||||
|
|
||||||
|
## 适合什么场景
|
||||||
|
|
||||||
|
- 自有 **仿真系统 / sandbox / training 页面**
|
||||||
|
- 需要 **浏览器 RPA** 做端到端演示或回归
|
||||||
|
- 表单较复杂:多步登录、Tab 切换、动态增行、PIN 弹窗、成功页解析
|
||||||
|
- 需要 **adapter 分层**:mock(CI)与 simulator_rpa(半集成)可切换
|
||||||
|
|
||||||
|
## 不适合什么场景
|
||||||
|
|
||||||
|
- **真实第三方网站 + 高风控 + 人工验证码** → 优先看 [`../real_browser_rpa/README.md`](../real_browser_rpa/README.md)
|
||||||
|
- 目标系统有稳定 **官方 API** → 不要硬写浏览器 RPA,后续参考 `real_api`
|
||||||
|
- **不要把本示例的业务字段、selector、sandbox URL 原样复制**到你的 skill
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
simulator_browser_rpa/
|
||||||
|
├── README.md
|
||||||
|
├── sandbox/
|
||||||
|
│ └── demo_app.html # 本地仿真页面(稳定 data-testid / name)
|
||||||
|
├── scripts/
|
||||||
|
│ ├── service/
|
||||||
|
│ │ ├── browser_session.py # 浏览器启动(URL 仅 page.goto)
|
||||||
|
│ │ ├── account_client.py # 账号来源集中封装
|
||||||
|
│ │ ├── task_service.py # 编排层
|
||||||
|
│ │ └── adapter/
|
||||||
|
│ │ ├── base.py # BatchItem / BatchSubmitResult 契约
|
||||||
|
│ │ ├── mock.py # mock/unit 档
|
||||||
|
│ │ ├── simulator_rpa.py
|
||||||
|
│ │ └── __init__.py # select_adapter
|
||||||
|
│ └── util/
|
||||||
|
│ ├── constants.py
|
||||||
|
│ └── logging.py
|
||||||
|
└── tests/
|
||||||
|
├── test_adapter_dispatch.py
|
||||||
|
├── test_simulator_rpa_unit.py
|
||||||
|
└── test_stop_reason.py
|
||||||
|
```
|
||||||
|
|
||||||
|
## 文件职责
|
||||||
|
|
||||||
|
| 文件 | 职责 |
|
||||||
|
|---|---|
|
||||||
|
| `browser_session.py` | 系统 Chrome/Edge + launch args 规范;支持 profile / 无 profile |
|
||||||
|
| `account_client.py` | 示例从环境变量读账号;真实 skill 可在此集中对接 account-manager |
|
||||||
|
| `adapter/base.py` | 数据契约与 `BatchAdapterBase` |
|
||||||
|
| `adapter/mock.py` | 不启浏览器,供 unit/mock/CI |
|
||||||
|
| `adapter/simulator_rpa.py` | 仿真 RPA 主流程 |
|
||||||
|
| `task_service.py` | 校验输入 → 选 adapter → 提交 → 返回 summary |
|
||||||
|
| `sandbox/demo_app.html` | 可控 DOM,配合 selector 稳定 |
|
||||||
|
| `tests/` | dispatch、URL 不进 launch args、失败转结果 |
|
||||||
|
|
||||||
|
## 核心流程
|
||||||
|
|
||||||
|
1. `task_service.run_batch_submit(target, items)` 校验参数
|
||||||
|
2. `select_adapter()` 按 `OPENCLAW_TEST_TARGET` 选择 mock 或 simulator RPA
|
||||||
|
3. simulator 档:`pick_simulator_account()` → `set_credentials()` → `submit_batch()`
|
||||||
|
4. RPA:登录两步 → 批量页 → 填表 → 提交 → PIN → 解析 `batch_id`
|
||||||
|
5. 失败截图(有 `artifacts_dir` 时)→ 返回 `BatchSubmitResult`
|
||||||
|
|
||||||
|
## 复制到新 skill 时怎么做
|
||||||
|
|
||||||
|
**保留:**
|
||||||
|
|
||||||
|
- adapter 分层(base / mock / simulator_rpa / `select_adapter`)
|
||||||
|
- `browser_session.py` 启动规范(**URL 不进 launch args**)
|
||||||
|
- `account_client.py` 集中封装模式
|
||||||
|
- 关键节点结构化日志 + 失败截图
|
||||||
|
- 测试:dispatch、launch args、错误转 `BatchSubmitResult`
|
||||||
|
|
||||||
|
**替换:**
|
||||||
|
|
||||||
|
- `BatchItem` 字段与校验规则
|
||||||
|
- `sandbox/demo_app.html` 或 `SIMULATOR_BASE_URL` 指向的页面
|
||||||
|
- 全部 DOM selector(必须 F12 实测)
|
||||||
|
- `task_service.py` 输入输出与 DB/任务日志
|
||||||
|
- mock 返回字段、成功页 `batch_id` 解析逻辑
|
||||||
|
|
||||||
|
## 明确禁止
|
||||||
|
|
||||||
|
- 不要复制 `__pycache__`、`.pytest_cache`、`artifacts/`、`recordings/` 等生成物
|
||||||
|
- **不要在技能侧**执行 `playwright install` / `pip install playwright`(Python 包由宿主共享 runtime 提供)
|
||||||
|
- **不要把 URL 放进** `launch_persistent_context(args=[...])`
|
||||||
|
- **不要在** `task_service.py` / RPA 主流程里散落 account-manager subprocess
|
||||||
|
- **不要把真实生产系统**配置到 `simulator_rpa` 档位
|
||||||
|
- 不要照抄 slug、logger 名、演示账号到生产 skill
|
||||||
|
|
||||||
|
## 依赖说明
|
||||||
|
|
||||||
|
- Python 3.10+
|
||||||
|
- Python 包 `playwright`:由**宿主共享 runtime** 提供;技能侧不要写入 `requirements.txt`,不要 `pip install playwright`
|
||||||
|
- 默认使用**系统 Chrome/Edge**,不使用 Playwright 内置 Chromium
|
||||||
|
- 技能侧不要执行 `playwright install` / `playwright install chromium`
|
||||||
|
- 本地独立开发若缺 Playwright Python 包,仅作开发机临时补装;生产由宿主解决
|
||||||
|
- `jiangchang_skill_core.runtime_env.find_chrome_executable`(可选,用于查找系统浏览器)
|
||||||
|
|
||||||
|
## 环境变量(示例)
|
||||||
|
|
||||||
|
| 变量 | 说明 |
|
||||||
|
|---|---|
|
||||||
|
| `OPENCLAW_TEST_TARGET` | `mock`/`unit` → Mock;默认 → Simulator RPA |
|
||||||
|
| `SIMULATOR_BASE_URL` | 仿真页 URL;默认本地 `sandbox/demo_app.html` 的 file URI |
|
||||||
|
| `SIMULATOR_LOGIN_ID` / `PASSWORD` / `TOKEN_PIN` | 演示账号 |
|
||||||
|
| `SIMULATOR_PROFILE_DIR` | 可选 persistent profile |
|
||||||
|
| `OPENCLAW_BROWSER_HEADLESS` | `0` 默认有头;`1` 无头模式(CI 可用) |
|
||||||
|
|
||||||
|
## 运行测试
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd examples/simulator_browser_rpa
|
||||||
|
python -m pytest tests/ -v
|
||||||
|
```
|
||||||
|
|
||||||
|
测试为 mock/纯函数,**不需要启动真实浏览器**。
|
||||||
|
|
||||||
|
## 当前状态
|
||||||
|
|
||||||
|
- 示例代码与 sandbox 页面已就绪,可作为仿真浏览器 RPA 复制起点。
|
||||||
|
- 未接入完整 CLI、数据库与 entitlement。
|
||||||
141
examples/simulator_browser_rpa/sandbox/demo_app.html
Normal file
141
examples/simulator_browser_rpa/sandbox/demo_app.html
Normal file
@@ -0,0 +1,141 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="zh-CN">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<title>仿真批量提交系统(示例 Sandbox)</title>
|
||||||
|
<style>
|
||||||
|
body { font-family: sans-serif; margin: 24px; max-width: 960px; }
|
||||||
|
section { margin-bottom: 24px; padding: 16px; border: 1px solid #ccc; }
|
||||||
|
.hidden { display: none; }
|
||||||
|
table { border-collapse: collapse; width: 100%; }
|
||||||
|
td, th { border: 1px solid #ddd; padding: 8px; }
|
||||||
|
dialog-like { display: block; border: 2px solid #333; padding: 16px; margin-top: 16px; }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>仿真业务系统 · 批量提交(示例)</h1>
|
||||||
|
|
||||||
|
<section id="login-step1-section">
|
||||||
|
<h2>登录 · 第一步</h2>
|
||||||
|
<form name="simLoginStep1" data-testid="login-step1">
|
||||||
|
<label>账号 <input name="loginId" data-testid="login-id" /></label>
|
||||||
|
<button type="submit">下一步</button>
|
||||||
|
</form>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section id="login-step2-section" class="hidden">
|
||||||
|
<h2>登录 · 第二步</h2>
|
||||||
|
<form name="simLoginStep2" data-testid="login-step2">
|
||||||
|
<label>密码 <input name="password" type="password" data-testid="password" /></label>
|
||||||
|
<label>验证码 <input name="captcha" data-testid="captcha" /></label>
|
||||||
|
<button type="submit">登录</button>
|
||||||
|
</form>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section id="batch-section" class="hidden">
|
||||||
|
<h2>批量提交</h2>
|
||||||
|
<form name="simBatchForm" data-testid="batch-form">
|
||||||
|
<label>来源账户
|
||||||
|
<select name="fromAccountNo" data-testid="from-account">
|
||||||
|
<option value="">请选择</option>
|
||||||
|
<option value="acct-demo-001">演示账户 acct-demo-001</option>
|
||||||
|
<option value="acct-demo-002">演示账户 acct-demo-002</option>
|
||||||
|
</select>
|
||||||
|
</label>
|
||||||
|
<button type="button" id="tab-page-fill" data-testid="tab-page-fill">页面填写</button>
|
||||||
|
<button type="button" id="btn-add-row" data-testid="add-row">新增一行</button>
|
||||||
|
<table id="batch-table" data-testid="batch-table">
|
||||||
|
<thead><tr><th>#</th><th>姓名</th><th>账号</th><th>备注</th><th>金额</th></tr></thead>
|
||||||
|
<tbody id="batch-rows"></tbody>
|
||||||
|
</table>
|
||||||
|
<label>用途 <input name="purpose" data-testid="purpose" /></label>
|
||||||
|
<button type="submit" data-testid="batch-submit">提交批次</button>
|
||||||
|
</form>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section id="success-section" class="hidden">
|
||||||
|
<h2>提交成功</h2>
|
||||||
|
<p data-testid="batch-id" id="batch-id-display"></p>
|
||||||
|
<p data-testid="success-message">批次已受理,等待后续处理。</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<div id="pin-dialog" class="hidden" role="dialog" aria-modal="true" data-testid="pin-dialog">
|
||||||
|
<h3>确认 PIN</h3>
|
||||||
|
<input type="password" inputmode="numeric" data-testid="pin-input" />
|
||||||
|
<button type="button" id="pin-confirm" data-testid="pin-confirm">确认提交</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
const DEMO_CAPTCHA = "0000";
|
||||||
|
let rowCount = 0;
|
||||||
|
|
||||||
|
document.querySelector('form[name="simLoginStep1"]').addEventListener('submit', function (e) {
|
||||||
|
e.preventDefault();
|
||||||
|
document.getElementById('login-step1-section').classList.add('hidden');
|
||||||
|
document.getElementById('login-step2-section').classList.remove('hidden');
|
||||||
|
});
|
||||||
|
|
||||||
|
document.querySelector('form[name="simLoginStep2"]').addEventListener('submit', function (e) {
|
||||||
|
e.preventDefault();
|
||||||
|
const cap = document.querySelector('input[name="captcha"]').value;
|
||||||
|
if (cap !== DEMO_CAPTCHA) {
|
||||||
|
alert('验证码错误(演示值 0000)');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
document.getElementById('login-step2-section').classList.add('hidden');
|
||||||
|
document.getElementById('batch-section').classList.remove('hidden');
|
||||||
|
ensureRow(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
document.getElementById('tab-page-fill').addEventListener('click', function () {
|
||||||
|
document.getElementById('batch-table').scrollIntoView();
|
||||||
|
});
|
||||||
|
|
||||||
|
document.getElementById('btn-add-row').addEventListener('click', function () {
|
||||||
|
rowCount += 1;
|
||||||
|
addRow(rowCount);
|
||||||
|
});
|
||||||
|
|
||||||
|
function ensureRow(index) {
|
||||||
|
if (!document.querySelector('tr[data-row-index="' + index + '"]')) {
|
||||||
|
addRow(index);
|
||||||
|
}
|
||||||
|
rowCount = Math.max(rowCount, index);
|
||||||
|
}
|
||||||
|
|
||||||
|
function addRow(index) {
|
||||||
|
rowCount = Math.max(rowCount, index);
|
||||||
|
const tbody = document.getElementById('batch-rows');
|
||||||
|
const tr = document.createElement('tr');
|
||||||
|
tr.setAttribute('data-row-index', String(index));
|
||||||
|
tr.innerHTML =
|
||||||
|
'<td>' + index + '</td>' +
|
||||||
|
'<td><input name="name" data-testid="row-name-' + index + '" /></td>' +
|
||||||
|
'<td><input name="account" data-testid="row-account-' + index + '" /></td>' +
|
||||||
|
'<td><input name="note" data-testid="row-note-' + index + '" /></td>' +
|
||||||
|
'<td><input name="amount" data-testid="row-amount-' + index + '" /></td>';
|
||||||
|
tbody.appendChild(tr);
|
||||||
|
}
|
||||||
|
|
||||||
|
document.querySelector('form[name="simBatchForm"]').addEventListener('submit', function (e) {
|
||||||
|
e.preventDefault();
|
||||||
|
document.getElementById('pin-dialog').classList.remove('hidden');
|
||||||
|
});
|
||||||
|
|
||||||
|
document.getElementById('pin-confirm').addEventListener('click', function () {
|
||||||
|
const pin = document.querySelector('[data-testid="pin-input"]').value;
|
||||||
|
if (!pin || pin.length < 4) {
|
||||||
|
alert('请输入演示 PIN');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
document.getElementById('pin-dialog').classList.add('hidden');
|
||||||
|
const batchId = 'SIM-' + Date.now();
|
||||||
|
document.getElementById('batch-section').classList.add('hidden');
|
||||||
|
document.getElementById('success-section').classList.remove('hidden');
|
||||||
|
document.getElementById('batch-id-display').textContent = batchId;
|
||||||
|
document.getElementById('batch-id-display').dataset.batchId = batchId;
|
||||||
|
window.location.hash = '#/batch/' + batchId;
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
"""仿真账号来源封装(示例级;真实 skill 可在此集中对接 account-manager)。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Optional
|
||||||
|
|
||||||
|
from util.constants import (
|
||||||
|
DEFAULT_DEMO_LOGIN_ID,
|
||||||
|
DEFAULT_DEMO_PASSWORD,
|
||||||
|
DEFAULT_DEMO_TOKEN_PIN,
|
||||||
|
ENV_SIMULATOR_LOGIN_ID,
|
||||||
|
ENV_SIMULATOR_PASSWORD,
|
||||||
|
ENV_SIMULATOR_PROFILE_DIR,
|
||||||
|
ENV_SIMULATOR_TOKEN_PIN,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class SimulatorAccount:
|
||||||
|
login_id: str
|
||||||
|
password: str
|
||||||
|
token_pin: str
|
||||||
|
profile_dir: str = ""
|
||||||
|
|
||||||
|
|
||||||
|
def pick_simulator_account() -> SimulatorAccount:
|
||||||
|
"""
|
||||||
|
示例账号来源:优先读环境变量,否则返回内置 demo 账号。
|
||||||
|
|
||||||
|
真实 skill 若依赖 account-manager,应把 subprocess / sibling_bridge 调用
|
||||||
|
集中在本模块,不要散落到 task_service 或 RPA 主流程中。
|
||||||
|
"""
|
||||||
|
return SimulatorAccount(
|
||||||
|
login_id=(os.getenv(ENV_SIMULATOR_LOGIN_ID) or DEFAULT_DEMO_LOGIN_ID).strip(),
|
||||||
|
password=(os.getenv(ENV_SIMULATOR_PASSWORD) or DEFAULT_DEMO_PASSWORD).strip(),
|
||||||
|
token_pin=(os.getenv(ENV_SIMULATOR_TOKEN_PIN) or DEFAULT_DEMO_TOKEN_PIN).strip(),
|
||||||
|
profile_dir=(os.getenv(ENV_SIMULATOR_PROFILE_DIR) or "").strip(),
|
||||||
|
)
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
"""adapter 工厂:按 OPENCLAW_TEST_TARGET 选择实现。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
from typing import Optional
|
||||||
|
|
||||||
|
from service.adapter.base import BatchAdapterBase, BatchItem, BatchSubmitResult
|
||||||
|
from service.adapter.mock import MockBatchAdapter
|
||||||
|
from service.adapter.simulator_rpa import SimulatorBrowserRpaAdapter
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"select_adapter",
|
||||||
|
"BatchAdapterBase",
|
||||||
|
"BatchItem",
|
||||||
|
"BatchSubmitResult",
|
||||||
|
"MockBatchAdapter",
|
||||||
|
"SimulatorBrowserRpaAdapter",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def select_adapter(artifacts_dir: Optional[str] = None) -> BatchAdapterBase:
|
||||||
|
target = os.environ.get("OPENCLAW_TEST_TARGET", "").strip().lower()
|
||||||
|
|
||||||
|
if target in ("mock", "unit"):
|
||||||
|
logger.info("target '%s': MockBatchAdapter", target)
|
||||||
|
return MockBatchAdapter()
|
||||||
|
|
||||||
|
if target == "real_rpa":
|
||||||
|
logger.warning("target real_rpa 未实现,回退 MockBatchAdapter")
|
||||||
|
return MockBatchAdapter()
|
||||||
|
|
||||||
|
if target and target != "simulator_rpa":
|
||||||
|
logger.warning("未知 target '%s',回退 simulator_rpa", target)
|
||||||
|
|
||||||
|
logger.info("target '%s': SimulatorBrowserRpaAdapter", target or "(unset=default)")
|
||||||
|
return SimulatorBrowserRpaAdapter(artifacts_dir=artifacts_dir)
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
"""批量提交 adapter 基类与数据契约。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
from typing import Any, Dict, List, Optional
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class BatchItem:
|
||||||
|
row_index: int
|
||||||
|
name: str
|
||||||
|
account: str
|
||||||
|
amount: float
|
||||||
|
note: str = ""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class BatchSubmitResult:
|
||||||
|
ok: bool
|
||||||
|
batch_id: Optional[str]
|
||||||
|
submitted_count: int
|
||||||
|
submitted_amount: float
|
||||||
|
error_msg: Optional[str]
|
||||||
|
artifacts: Dict[str, Any] = field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
|
class BatchAdapterBase:
|
||||||
|
name: str = "base"
|
||||||
|
|
||||||
|
def submit_batch(self, target: str, items: List[BatchItem]) -> BatchSubmitResult:
|
||||||
|
raise NotImplementedError
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
"""mock / unit 档位:不启动浏览器。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import time
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
from service.adapter.base import BatchAdapterBase, BatchItem, BatchSubmitResult
|
||||||
|
|
||||||
|
|
||||||
|
class MockBatchAdapter(BatchAdapterBase):
|
||||||
|
name = "mock"
|
||||||
|
|
||||||
|
def submit_batch(self, target: str, items: List[BatchItem]) -> BatchSubmitResult:
|
||||||
|
del target
|
||||||
|
if not items:
|
||||||
|
return BatchSubmitResult(
|
||||||
|
ok=False,
|
||||||
|
batch_id=None,
|
||||||
|
submitted_count=0,
|
||||||
|
submitted_amount=0.0,
|
||||||
|
error_msg="items 为空",
|
||||||
|
artifacts={"adapter": self.name},
|
||||||
|
)
|
||||||
|
|
||||||
|
time.sleep(0.05)
|
||||||
|
total = sum(it.amount for it in items)
|
||||||
|
fake_batch_id = f"MOCK-{int(time.time())}"
|
||||||
|
return BatchSubmitResult(
|
||||||
|
ok=True,
|
||||||
|
batch_id=fake_batch_id,
|
||||||
|
submitted_count=len(items),
|
||||||
|
submitted_amount=total,
|
||||||
|
error_msg=None,
|
||||||
|
artifacts={"adapter": self.name},
|
||||||
|
)
|
||||||
@@ -0,0 +1,340 @@
|
|||||||
|
"""仿真浏览器 RPA:操作 sandbox/demo_app.html 完成批量提交。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import random
|
||||||
|
import re
|
||||||
|
import time
|
||||||
|
from typing import List, Optional
|
||||||
|
|
||||||
|
from service.adapter.base import BatchAdapterBase, BatchItem, BatchSubmitResult
|
||||||
|
from service.browser_session import browser_session, find_chrome_executable
|
||||||
|
from util.constants import (
|
||||||
|
DEFAULT_DEMO_CAPTCHA,
|
||||||
|
DEFAULT_DEMO_LOGIN_ID,
|
||||||
|
DEFAULT_DEMO_PASSWORD,
|
||||||
|
DEFAULT_DEMO_TOKEN_PIN,
|
||||||
|
DEFAULT_TIMEOUT_MS,
|
||||||
|
LOGIN_NAVIGATE_TIMEOUT_MS,
|
||||||
|
SUBMIT_NAVIGATE_TIMEOUT_MS,
|
||||||
|
resolve_simulator_base_url,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
_PAUSE_MIN_MS = 500
|
||||||
|
_PAUSE_MAX_MS = 2000
|
||||||
|
|
||||||
|
|
||||||
|
class RpaError(Exception):
|
||||||
|
def __init__(self, message: str, screenshot_path: Optional[str] = None):
|
||||||
|
super().__init__(message)
|
||||||
|
self.screenshot_path = screenshot_path
|
||||||
|
|
||||||
|
|
||||||
|
class SimulatorBrowserRpaAdapter(BatchAdapterBase):
|
||||||
|
name = "simulator_browser_rpa"
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
base_url: Optional[str] = None,
|
||||||
|
headless: Optional[bool] = None,
|
||||||
|
artifacts_dir: Optional[str] = None,
|
||||||
|
) -> None:
|
||||||
|
self.base_url = (base_url or resolve_simulator_base_url()).rstrip("/")
|
||||||
|
if headless is None:
|
||||||
|
env = os.environ.get("OPENCLAW_BROWSER_HEADLESS", "").strip().lower()
|
||||||
|
self.headless = env in ("1", "true", "yes")
|
||||||
|
else:
|
||||||
|
self.headless = headless
|
||||||
|
self.artifacts_dir = artifacts_dir
|
||||||
|
|
||||||
|
self._login_id: str = DEFAULT_DEMO_LOGIN_ID
|
||||||
|
self._password: str = DEFAULT_DEMO_PASSWORD
|
||||||
|
self._token_pin: str = DEFAULT_DEMO_TOKEN_PIN
|
||||||
|
self._profile_dir: Optional[str] = None
|
||||||
|
|
||||||
|
def set_credentials(
|
||||||
|
self,
|
||||||
|
login_id: str,
|
||||||
|
password: str,
|
||||||
|
token_pin: str,
|
||||||
|
profile_dir: str,
|
||||||
|
) -> None:
|
||||||
|
self._login_id = login_id
|
||||||
|
self._password = password
|
||||||
|
self._token_pin = token_pin
|
||||||
|
stripped = (profile_dir or "").strip()
|
||||||
|
self._profile_dir = stripped or None
|
||||||
|
|
||||||
|
def submit_batch(self, target: str, items: List[BatchItem]) -> BatchSubmitResult:
|
||||||
|
try:
|
||||||
|
from playwright.sync_api import sync_playwright # noqa: F401
|
||||||
|
except ImportError:
|
||||||
|
return BatchSubmitResult(
|
||||||
|
ok=False,
|
||||||
|
batch_id=None,
|
||||||
|
submitted_count=0,
|
||||||
|
submitted_amount=0.0,
|
||||||
|
error_msg=(
|
||||||
|
"playwright Python 包不可用。"
|
||||||
|
"生产/宿主运行由共享 runtime 提供;技能侧不要 pip install playwright。"
|
||||||
|
),
|
||||||
|
artifacts={"adapter": self.name},
|
||||||
|
)
|
||||||
|
|
||||||
|
if not items:
|
||||||
|
return BatchSubmitResult(
|
||||||
|
ok=False,
|
||||||
|
batch_id=None,
|
||||||
|
submitted_count=0,
|
||||||
|
submitted_amount=0.0,
|
||||||
|
error_msg="items 为空",
|
||||||
|
artifacts={"adapter": self.name},
|
||||||
|
)
|
||||||
|
|
||||||
|
if not find_chrome_executable():
|
||||||
|
return BatchSubmitResult(
|
||||||
|
ok=False,
|
||||||
|
batch_id=None,
|
||||||
|
submitted_count=0,
|
||||||
|
submitted_amount=0.0,
|
||||||
|
error_msg="未检测到 Chrome 或 Edge 浏览器,请安装系统浏览器后重试。",
|
||||||
|
artifacts={"adapter": self.name},
|
||||||
|
)
|
||||||
|
|
||||||
|
start_url = self.base_url
|
||||||
|
try:
|
||||||
|
with browser_session(
|
||||||
|
start_url,
|
||||||
|
profile_dir=self._profile_dir,
|
||||||
|
headless=self.headless,
|
||||||
|
) as page:
|
||||||
|
try:
|
||||||
|
logger.info("rpa_login_start url=%s", start_url)
|
||||||
|
self._login(page)
|
||||||
|
logger.info("rpa_login_done")
|
||||||
|
|
||||||
|
self._goto_batch_page(page)
|
||||||
|
logger.info("rpa_batch_page_ready")
|
||||||
|
|
||||||
|
self._fill_batch_form(page, target, items)
|
||||||
|
logger.info("rpa_batch_form_filled rows=%s", len(items))
|
||||||
|
|
||||||
|
batch_id = self._submit_and_get_batch_id(page)
|
||||||
|
logger.info("rpa_submit_success batch_id=%s", batch_id)
|
||||||
|
|
||||||
|
total = sum(it.amount for it in items)
|
||||||
|
return BatchSubmitResult(
|
||||||
|
ok=True,
|
||||||
|
batch_id=batch_id,
|
||||||
|
submitted_count=len(items),
|
||||||
|
submitted_amount=total,
|
||||||
|
error_msg=None,
|
||||||
|
artifacts={"adapter": self.name},
|
||||||
|
)
|
||||||
|
except RpaError as exc:
|
||||||
|
logger.error("rpa_failed: %s", exc)
|
||||||
|
arts = {"adapter": self.name}
|
||||||
|
if exc.screenshot_path:
|
||||||
|
arts["screenshot"] = exc.screenshot_path
|
||||||
|
return BatchSubmitResult(
|
||||||
|
ok=False,
|
||||||
|
batch_id=None,
|
||||||
|
submitted_count=0,
|
||||||
|
submitted_amount=0.0,
|
||||||
|
error_msg=str(exc),
|
||||||
|
artifacts=arts,
|
||||||
|
)
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "unexpected_error")
|
||||||
|
logger.exception("rpa_unexpected: %s", exc)
|
||||||
|
arts = {"adapter": self.name}
|
||||||
|
if sp:
|
||||||
|
arts["screenshot"] = sp
|
||||||
|
return BatchSubmitResult(
|
||||||
|
ok=False,
|
||||||
|
batch_id=None,
|
||||||
|
submitted_count=0,
|
||||||
|
submitted_amount=0.0,
|
||||||
|
error_msg=f"未预期异常:{type(exc).__name__}: {exc}",
|
||||||
|
artifacts=arts,
|
||||||
|
)
|
||||||
|
except Exception as outer:
|
||||||
|
return BatchSubmitResult(
|
||||||
|
ok=False,
|
||||||
|
batch_id=None,
|
||||||
|
submitted_count=0,
|
||||||
|
submitted_amount=0.0,
|
||||||
|
error_msg=f"启动浏览器失败:{outer}",
|
||||||
|
artifacts={"adapter": self.name},
|
||||||
|
)
|
||||||
|
|
||||||
|
def _pause(self, min_ms: int = _PAUSE_MIN_MS, max_ms: int = _PAUSE_MAX_MS) -> None:
|
||||||
|
time.sleep(random.uniform(min_ms, max_ms) / 1000.0)
|
||||||
|
|
||||||
|
def _login(self, page) -> None:
|
||||||
|
try:
|
||||||
|
page.wait_for_selector('form[name="simLoginStep1"]', timeout=LOGIN_NAVIGATE_TIMEOUT_MS)
|
||||||
|
self._pause()
|
||||||
|
page.fill('form[name="simLoginStep1"] input[name="loginId"]', self._login_id)
|
||||||
|
self._pause()
|
||||||
|
page.click('form[name="simLoginStep1"] button[type="submit"]')
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "login_step1_failed")
|
||||||
|
raise RpaError(f"登录第一步失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
page.wait_for_selector('form[name="simLoginStep2"]', timeout=DEFAULT_TIMEOUT_MS)
|
||||||
|
self._pause()
|
||||||
|
page.fill('form[name="simLoginStep2"] input[name="password"]', self._password)
|
||||||
|
page.fill('form[name="simLoginStep2"] input[name="captcha"]', DEFAULT_DEMO_CAPTCHA)
|
||||||
|
self._pause()
|
||||||
|
page.click('form[name="simLoginStep2"] button[type="submit"]')
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "login_step2_failed")
|
||||||
|
raise RpaError(f"登录第二步失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
page.wait_for_selector('form[name="simBatchForm"]', timeout=LOGIN_NAVIGATE_TIMEOUT_MS)
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "login_navigate_failed")
|
||||||
|
raise RpaError(f"登录后未进入批量提交页:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
def _goto_batch_page(self, page) -> None:
|
||||||
|
try:
|
||||||
|
page.wait_for_selector('form[name="simBatchForm"]', timeout=DEFAULT_TIMEOUT_MS)
|
||||||
|
self._pause()
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "goto_batch_failed")
|
||||||
|
raise RpaError(f"进入批量提交页失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
def _select_target_account(self, page, target: str) -> None:
|
||||||
|
sel = page.locator('select[name="fromAccountNo"]')
|
||||||
|
sel.wait_for(timeout=DEFAULT_TIMEOUT_MS)
|
||||||
|
n = sel.locator("option").count()
|
||||||
|
matched_value: Optional[str] = None
|
||||||
|
first_value: Optional[str] = None
|
||||||
|
for i in range(n):
|
||||||
|
opt = sel.locator("option").nth(i)
|
||||||
|
val = opt.get_attribute("value") or ""
|
||||||
|
if not val.strip():
|
||||||
|
continue
|
||||||
|
label_txt = opt.inner_text()
|
||||||
|
if first_value is None:
|
||||||
|
first_value = val
|
||||||
|
if target.strip() and target.strip() in label_txt:
|
||||||
|
matched_value = val
|
||||||
|
break
|
||||||
|
pick = matched_value or first_value
|
||||||
|
if not pick:
|
||||||
|
raise RpaError("来源账户下拉无可选项")
|
||||||
|
if not matched_value and target.strip():
|
||||||
|
logger.warning("target '%s' 未匹配选项,回退 value=%s", target, pick)
|
||||||
|
sel.select_option(value=pick)
|
||||||
|
self._pause()
|
||||||
|
|
||||||
|
def _fill_batch_form(self, page, target: str, items: List[BatchItem]) -> None:
|
||||||
|
try:
|
||||||
|
page.get_by_role("button", name=re.compile(r"页面填写")).click()
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "tab_switch_failed")
|
||||||
|
raise RpaError(f"切换到页面填写失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
self._select_target_account(page, target)
|
||||||
|
except RpaError:
|
||||||
|
raise
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "select_account_failed")
|
||||||
|
raise RpaError(f"选择来源账户失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
existing = page.locator("tr[data-row-index]").count()
|
||||||
|
need_more = max(0, len(items) - existing)
|
||||||
|
add_btn = page.get_by_role("button", name=re.compile(r"新增一行"))
|
||||||
|
for _ in range(need_more):
|
||||||
|
self._pause(400, 900)
|
||||||
|
add_btn.click()
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "add_rows_failed")
|
||||||
|
raise RpaError(f"新增明细行失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
for it in items:
|
||||||
|
try:
|
||||||
|
row = page.locator(f'tr[data-row-index="{it.row_index}"]')
|
||||||
|
row.wait_for(timeout=DEFAULT_TIMEOUT_MS)
|
||||||
|
self._pause(300, 800)
|
||||||
|
row.locator('input[name="name"]').fill(it.name)
|
||||||
|
row.locator('input[name="account"]').fill(it.account)
|
||||||
|
row.locator('input[name="note"]').fill(it.note or "")
|
||||||
|
row.locator('input[name="amount"]').fill(f"{it.amount}")
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, f"fill_row_{it.row_index}_failed")
|
||||||
|
raise RpaError(f"填第 {it.row_index} 行失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
page.fill('input[name="purpose"]', "仿真批量提交示例")
|
||||||
|
except Exception as exc:
|
||||||
|
logger.warning("填写用途失败(非致命):%s", exc)
|
||||||
|
|
||||||
|
def _submit_and_get_batch_id(self, page) -> str:
|
||||||
|
try:
|
||||||
|
self._pause(800, 1500)
|
||||||
|
page.locator('form[name="simBatchForm"] button[type="submit"]').click()
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "click_submit_failed")
|
||||||
|
raise RpaError(f"点击提交失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
dlg_sel = 'div[role="dialog"][aria-modal="true"]'
|
||||||
|
try:
|
||||||
|
page.wait_for_selector(dlg_sel, timeout=DEFAULT_TIMEOUT_MS)
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "pin_dialog_not_open")
|
||||||
|
raise RpaError(f"PIN 弹窗未出现:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
pin_input = page.locator(f'{dlg_sel} input[type="password"][inputmode="numeric"]')
|
||||||
|
self._pause(500, 1200)
|
||||||
|
pin_input.fill(self._token_pin)
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "fill_pin_failed")
|
||||||
|
raise RpaError(f"填写 PIN 失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
page.locator(dlg_sel).get_by_role("button", name=re.compile(r"确认提交")).click()
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "click_confirm_failed")
|
||||||
|
raise RpaError(f"确认提交失败:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
page.wait_for_selector('[data-testid="batch-id"]', timeout=SUBMIT_NAVIGATE_TIMEOUT_MS)
|
||||||
|
except Exception as exc:
|
||||||
|
sp = self._safe_screenshot(page, "success_area_not_visible")
|
||||||
|
raise RpaError(f"提交后未出现成功区域:{exc}", screenshot_path=sp) from exc
|
||||||
|
|
||||||
|
batch_id = page.locator('[data-testid="batch-id"]').get_attribute("data-batch-id") or ""
|
||||||
|
if not batch_id:
|
||||||
|
batch_id = page.locator('[data-testid="batch-id"]').inner_text().strip()
|
||||||
|
url = page.url
|
||||||
|
if not batch_id and "#/batch/" in url:
|
||||||
|
batch_id = url.split("#/batch/", 1)[1].split("?")[0].split("#")[0].strip("/")
|
||||||
|
if not batch_id:
|
||||||
|
sp = self._safe_screenshot(page, "batch_id_empty")
|
||||||
|
raise RpaError(f"无法解析 batch_id,url={url}", screenshot_path=sp)
|
||||||
|
return batch_id
|
||||||
|
|
||||||
|
def _safe_screenshot(self, page, tag: str) -> Optional[str]:
|
||||||
|
if not self.artifacts_dir:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
os.makedirs(self.artifacts_dir, exist_ok=True)
|
||||||
|
path = os.path.join(self.artifacts_dir, f"{tag}_{int(time.time())}.png")
|
||||||
|
page.screenshot(path=path, full_page=True)
|
||||||
|
logger.info("screenshot_saved path=%s", path)
|
||||||
|
return path
|
||||||
|
except Exception as exc:
|
||||||
|
logger.warning("screenshot_failed tag=%s err=%s", tag, exc)
|
||||||
|
return None
|
||||||
@@ -0,0 +1,138 @@
|
|||||||
|
"""浏览器会话启动(系统 Chrome/Edge;URL 仅通过 page.goto 打开)。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
from contextlib import contextmanager
|
||||||
|
from typing import Any, Generator, Iterator, List, Optional, Tuple
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
DEFAULT_PAGE_TIMEOUT_MS = 15_000
|
||||||
|
GOTO_TIMEOUT_MS = 60_000
|
||||||
|
|
||||||
|
CHROME_LAUNCH_ARGS: List[str] = [
|
||||||
|
"--start-maximized",
|
||||||
|
"--disable-blink-features=AutomationControlled",
|
||||||
|
]
|
||||||
|
|
||||||
|
STEALTH_INIT_SCRIPT = """
|
||||||
|
(() => {
|
||||||
|
try { Object.defineProperty(navigator, 'webdriver', { get: () => undefined }); } catch (e) {}
|
||||||
|
})();
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def chrome_launch_args() -> List[str]:
|
||||||
|
return list(CHROME_LAUNCH_ARGS)
|
||||||
|
|
||||||
|
|
||||||
|
def _headless_from_env() -> bool:
|
||||||
|
v = (os.getenv("OPENCLAW_BROWSER_HEADLESS") or "0").strip().lower()
|
||||||
|
return v in ("1", "true", "yes", "on")
|
||||||
|
|
||||||
|
|
||||||
|
def _find_chrome_executable() -> str | None:
|
||||||
|
try:
|
||||||
|
from jiangchang_skill_core.runtime_env import find_chrome_executable
|
||||||
|
|
||||||
|
chrome = find_chrome_executable()
|
||||||
|
if chrome and os.path.isfile(chrome):
|
||||||
|
return chrome
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
candidates = [
|
||||||
|
os.path.expandvars(r"%ProgramFiles%\Google\Chrome\Application\chrome.exe"),
|
||||||
|
os.path.expandvars(r"%ProgramFiles(x86)%\Google\Chrome\Application\chrome.exe"),
|
||||||
|
os.path.expandvars(r"%ProgramFiles%\Microsoft\Edge\Application\msedge.exe"),
|
||||||
|
os.path.expandvars(r"%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe"),
|
||||||
|
]
|
||||||
|
for path in candidates:
|
||||||
|
if path and os.path.isfile(path):
|
||||||
|
return path
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _clear_node_options() -> None:
|
||||||
|
os.environ.pop("NODE_OPTIONS", None)
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def browser_session(
|
||||||
|
start_url: str,
|
||||||
|
*,
|
||||||
|
profile_dir: Optional[str] = None,
|
||||||
|
headless: Optional[bool] = None,
|
||||||
|
) -> Generator[Any, None, None]:
|
||||||
|
"""
|
||||||
|
同步 Playwright 浏览器会话。
|
||||||
|
|
||||||
|
- Playwright Python 包由宿主共享 runtime 提供;技能侧不要 playwright install。
|
||||||
|
- launch args 仅放 Chrome 参数,不含 URL。
|
||||||
|
- 流程:launch → new_page → goto(start_url)
|
||||||
|
"""
|
||||||
|
from playwright.sync_api import sync_playwright
|
||||||
|
|
||||||
|
_clear_node_options()
|
||||||
|
hl = headless if headless is not None else _headless_from_env()
|
||||||
|
chrome = _find_chrome_executable()
|
||||||
|
if not chrome:
|
||||||
|
raise RuntimeError(
|
||||||
|
"未检测到 Chrome 或 Edge 浏览器,请安装系统浏览器后重试。"
|
||||||
|
)
|
||||||
|
|
||||||
|
args = chrome_launch_args()
|
||||||
|
logger.info(
|
||||||
|
"browser_launch chrome=%s profile_dir=%s start_url=%s args=%s headless=%s",
|
||||||
|
chrome,
|
||||||
|
profile_dir or "",
|
||||||
|
start_url,
|
||||||
|
args,
|
||||||
|
hl,
|
||||||
|
)
|
||||||
|
|
||||||
|
browser_holder = None
|
||||||
|
context = None
|
||||||
|
with sync_playwright() as pw:
|
||||||
|
try:
|
||||||
|
if profile_dir:
|
||||||
|
context = pw.chromium.launch_persistent_context(
|
||||||
|
user_data_dir=profile_dir,
|
||||||
|
headless=hl,
|
||||||
|
executable_path=chrome,
|
||||||
|
locale="zh-CN",
|
||||||
|
no_viewport=True,
|
||||||
|
args=args,
|
||||||
|
ignore_default_args=["--enable-automation"],
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
browser_holder = pw.chromium.launch(
|
||||||
|
headless=hl,
|
||||||
|
executable_path=chrome,
|
||||||
|
args=args,
|
||||||
|
ignore_default_args=["--enable-automation"],
|
||||||
|
)
|
||||||
|
context = browser_holder.new_context(no_viewport=True, locale="zh-CN")
|
||||||
|
|
||||||
|
context.add_init_script(STEALTH_INIT_SCRIPT)
|
||||||
|
page = context.new_page()
|
||||||
|
page.set_default_timeout(DEFAULT_PAGE_TIMEOUT_MS)
|
||||||
|
page.goto(start_url, wait_until="domcontentloaded", timeout=GOTO_TIMEOUT_MS)
|
||||||
|
yield page
|
||||||
|
finally:
|
||||||
|
try:
|
||||||
|
if context is not None:
|
||||||
|
context.close()
|
||||||
|
except Exception as exc:
|
||||||
|
logger.warning("browser_context_close_failed: %s", exc)
|
||||||
|
if browser_holder is not None:
|
||||||
|
try:
|
||||||
|
browser_holder.close()
|
||||||
|
except Exception as exc:
|
||||||
|
logger.warning("browser_close_failed: %s", exc)
|
||||||
|
|
||||||
|
|
||||||
|
def find_chrome_executable() -> str | None:
|
||||||
|
return _find_chrome_executable()
|
||||||
104
examples/simulator_browser_rpa/scripts/service/task_service.py
Normal file
104
examples/simulator_browser_rpa/scripts/service/task_service.py
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
"""轻量任务编排:校验输入 → 选 adapter → 提交批次。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import tempfile
|
||||||
|
import uuid
|
||||||
|
from typing import Any, Dict, List, Optional
|
||||||
|
|
||||||
|
from service.account_client import pick_simulator_account
|
||||||
|
from service.adapter import BatchItem, SimulatorBrowserRpaAdapter, select_adapter
|
||||||
|
from util.logging import get_logger
|
||||||
|
|
||||||
|
logger = get_logger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_items(items: List[Dict[str, Any]]) -> tuple[List[BatchItem], Optional[str]]:
|
||||||
|
if not items:
|
||||||
|
return [], "items 不能为空"
|
||||||
|
parsed: List[BatchItem] = []
|
||||||
|
for idx, raw in enumerate(items, start=1):
|
||||||
|
name = str(raw.get("name") or "").strip()
|
||||||
|
account = str(raw.get("account") or "").strip()
|
||||||
|
note = str(raw.get("note") or "").strip()
|
||||||
|
try:
|
||||||
|
amount = float(raw.get("amount"))
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
return [], f"第 {idx} 行 amount 无效"
|
||||||
|
if amount <= 0:
|
||||||
|
return [], f"第 {idx} 行 amount 必须大于 0"
|
||||||
|
if not name or not account:
|
||||||
|
return [], f"第 {idx} 行 name/account 不能为空"
|
||||||
|
parsed.append(
|
||||||
|
BatchItem(
|
||||||
|
row_index=int(raw.get("row_index") or idx),
|
||||||
|
name=name,
|
||||||
|
account=account,
|
||||||
|
amount=amount,
|
||||||
|
note=note,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return parsed, None
|
||||||
|
|
||||||
|
|
||||||
|
def run_batch_submit(
|
||||||
|
target: str,
|
||||||
|
items: List[Dict[str, Any]],
|
||||||
|
*,
|
||||||
|
force: bool = False,
|
||||||
|
artifacts_dir: Optional[str] = None,
|
||||||
|
) -> Dict[str, Any]:
|
||||||
|
"""
|
||||||
|
最小编排示例。
|
||||||
|
|
||||||
|
真实 skill 中还应:写 task_logs、entitlement、RpaVideoSession 等。
|
||||||
|
"""
|
||||||
|
del force # 示例占位;真实 skill 可用于跳过确认
|
||||||
|
|
||||||
|
target_key = (target or "").strip()
|
||||||
|
if not target_key:
|
||||||
|
return {"success": False, "error": {"code": "INVALID_TARGET", "message": "target 不能为空"}}
|
||||||
|
|
||||||
|
batch_items, err = _validate_items(items)
|
||||||
|
if err:
|
||||||
|
return {"success": False, "error": {"code": "INVALID_ITEMS", "message": err}}
|
||||||
|
|
||||||
|
art_dir = artifacts_dir or os.path.join(
|
||||||
|
tempfile.gettempdir(),
|
||||||
|
"openclaw-simulator-rpa-artifacts",
|
||||||
|
uuid.uuid4().hex[:8],
|
||||||
|
)
|
||||||
|
os.makedirs(art_dir, exist_ok=True)
|
||||||
|
logger.info("batch_submit_start target=%s item_count=%s artifacts_dir=%s", target_key, len(batch_items), art_dir)
|
||||||
|
|
||||||
|
adapter = select_adapter(artifacts_dir=art_dir)
|
||||||
|
if isinstance(adapter, SimulatorBrowserRpaAdapter):
|
||||||
|
account = pick_simulator_account()
|
||||||
|
adapter.set_credentials(
|
||||||
|
account.login_id,
|
||||||
|
account.password,
|
||||||
|
account.token_pin,
|
||||||
|
account.profile_dir,
|
||||||
|
)
|
||||||
|
|
||||||
|
result = adapter.submit_batch(target_key, batch_items)
|
||||||
|
summary: Dict[str, Any] = {
|
||||||
|
"success": result.ok,
|
||||||
|
"target": target_key,
|
||||||
|
"adapter": result.artifacts.get("adapter") or adapter.name,
|
||||||
|
"submitted_count": result.submitted_count,
|
||||||
|
"submitted_amount": result.submitted_amount,
|
||||||
|
"batch_id": result.batch_id,
|
||||||
|
"artifacts": result.artifacts,
|
||||||
|
"artifacts_dir": art_dir,
|
||||||
|
}
|
||||||
|
if not result.ok:
|
||||||
|
summary["error"] = {"code": "BATCH_SUBMIT_FAILED", "message": result.error_msg or "提交失败"}
|
||||||
|
logger.info(
|
||||||
|
"batch_submit_done success=%s batch_id=%s adapter=%s",
|
||||||
|
result.ok,
|
||||||
|
result.batch_id,
|
||||||
|
adapter.name,
|
||||||
|
)
|
||||||
|
return summary
|
||||||
34
examples/simulator_browser_rpa/scripts/util/constants.py
Normal file
34
examples/simulator_browser_rpa/scripts/util/constants.py
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
"""仿真浏览器 RPA 示例常量。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
SKILL_SLUG = "example-simulator-browser-rpa"
|
||||||
|
LOG_LOGGER_NAME = "openclaw.skill.example_simulator_browser_rpa"
|
||||||
|
|
||||||
|
DEFAULT_TIMEOUT_MS = 15_000
|
||||||
|
LOGIN_NAVIGATE_TIMEOUT_MS = 30_000
|
||||||
|
SUBMIT_NAVIGATE_TIMEOUT_MS = 60_000
|
||||||
|
|
||||||
|
DEFAULT_DEMO_LOGIN_ID = "demo001"
|
||||||
|
DEFAULT_DEMO_PASSWORD = "demo-password"
|
||||||
|
DEFAULT_DEMO_CAPTCHA = "0000"
|
||||||
|
DEFAULT_DEMO_TOKEN_PIN = "123456"
|
||||||
|
|
||||||
|
ENV_SIMULATOR_BASE_URL = "SIMULATOR_BASE_URL"
|
||||||
|
ENV_SIMULATOR_LOGIN_ID = "SIMULATOR_LOGIN_ID"
|
||||||
|
ENV_SIMULATOR_PASSWORD = "SIMULATOR_PASSWORD"
|
||||||
|
ENV_SIMULATOR_TOKEN_PIN = "SIMULATOR_TOKEN_PIN"
|
||||||
|
ENV_SIMULATOR_PROFILE_DIR = "SIMULATOR_PROFILE_DIR"
|
||||||
|
|
||||||
|
_EXAMPLE_ROOT = Path(__file__).resolve().parents[2]
|
||||||
|
DEFAULT_DEMO_APP_PATH = _EXAMPLE_ROOT / "sandbox" / "demo_app.html"
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_simulator_base_url() -> str:
|
||||||
|
env = (os.getenv(ENV_SIMULATOR_BASE_URL) or "").strip()
|
||||||
|
if env:
|
||||||
|
return env.rstrip("/")
|
||||||
|
return DEFAULT_DEMO_APP_PATH.as_uri()
|
||||||
15
examples/simulator_browser_rpa/scripts/util/logging.py
Normal file
15
examples/simulator_browser_rpa/scripts/util/logging.py
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
"""示例日志工具。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from util.constants import LOG_LOGGER_NAME
|
||||||
|
|
||||||
|
|
||||||
|
def get_logger(name: str | None = None) -> logging.Logger:
|
||||||
|
return logging.getLogger(name or LOG_LOGGER_NAME)
|
||||||
|
|
||||||
|
|
||||||
|
def configure_logging(level: int = logging.INFO) -> None:
|
||||||
|
logging.basicConfig(level=level, format="%(levelname)s %(name)s %(message)s")
|
||||||
0
examples/simulator_browser_rpa/tests/.gitkeep
Normal file
0
examples/simulator_browser_rpa/tests/.gitkeep
Normal file
10
examples/simulator_browser_rpa/tests/conftest.py
Normal file
10
examples/simulator_browser_rpa/tests/conftest.py
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
"""pytest 路径:将 examples/simulator_browser_rpa/scripts 加入 import 路径。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
SCRIPTS = Path(__file__).resolve().parents[1] / "scripts"
|
||||||
|
if str(SCRIPTS) not in sys.path:
|
||||||
|
sys.path.insert(0, str(SCRIPTS))
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""adapter 工厂 dispatch 单元测试。"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import unittest
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from service.adapter import (
|
||||||
|
BatchItem,
|
||||||
|
MockBatchAdapter,
|
||||||
|
SimulatorBrowserRpaAdapter,
|
||||||
|
select_adapter,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestAdapterDispatch(unittest.TestCase):
|
||||||
|
def test_default_returns_simulator_rpa(self) -> None:
|
||||||
|
with patch.dict(os.environ, {}, clear=False):
|
||||||
|
os.environ.pop("OPENCLAW_TEST_TARGET", None)
|
||||||
|
adapter = select_adapter()
|
||||||
|
self.assertIsInstance(adapter, SimulatorBrowserRpaAdapter)
|
||||||
|
|
||||||
|
def test_unit_returns_mock(self) -> None:
|
||||||
|
with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "unit"}):
|
||||||
|
self.assertIsInstance(select_adapter(), MockBatchAdapter)
|
||||||
|
|
||||||
|
def test_mock_returns_mock(self) -> None:
|
||||||
|
with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "mock"}):
|
||||||
|
self.assertIsInstance(select_adapter(), MockBatchAdapter)
|
||||||
|
|
||||||
|
def test_simulator_rpa_returns_simulator(self) -> None:
|
||||||
|
with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "simulator_rpa"}):
|
||||||
|
self.assertIsInstance(select_adapter(), SimulatorBrowserRpaAdapter)
|
||||||
|
|
||||||
|
def test_real_rpa_falls_back_to_mock(self) -> None:
|
||||||
|
with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "real_rpa"}):
|
||||||
|
self.assertIsInstance(select_adapter(), MockBatchAdapter)
|
||||||
|
|
||||||
|
def test_unknown_target_falls_back_simulator_rpa(self) -> None:
|
||||||
|
with patch.dict(os.environ, {"OPENCLAW_TEST_TARGET": "simulator_api"}):
|
||||||
|
self.assertIsInstance(select_adapter(), SimulatorBrowserRpaAdapter)
|
||||||
|
|
||||||
|
|
||||||
|
class TestMockAdapter(unittest.TestCase):
|
||||||
|
def test_mock_success(self) -> None:
|
||||||
|
items = [
|
||||||
|
BatchItem(row_index=1, name="Alice", account="1001", amount=10.5),
|
||||||
|
BatchItem(row_index=2, name="Bob", account="1002", amount=20.0),
|
||||||
|
]
|
||||||
|
result = MockBatchAdapter().submit_batch("acct-demo-001", items)
|
||||||
|
self.assertTrue(result.ok)
|
||||||
|
self.assertEqual(result.submitted_count, 2)
|
||||||
|
self.assertEqual(result.submitted_amount, 30.5)
|
||||||
|
self.assertTrue((result.batch_id or "").startswith("MOCK-"))
|
||||||
|
|
||||||
|
def test_mock_empty_items(self) -> None:
|
||||||
|
result = MockBatchAdapter().submit_batch("acct-demo-001", [])
|
||||||
|
self.assertFalse(result.ok)
|
||||||
|
self.assertEqual(result.error_msg, "items 为空")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""SimulatorBrowserRpaAdapter 单元测试(不启动真实浏览器)。"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
from service.adapter import BatchItem, SimulatorBrowserRpaAdapter
|
||||||
|
from service.browser_session import CHROME_LAUNCH_ARGS
|
||||||
|
|
||||||
|
|
||||||
|
class TestSimulatorRpaUnit(unittest.TestCase):
|
||||||
|
def test_set_credentials_and_empty_profile_dir(self) -> None:
|
||||||
|
adapter = SimulatorBrowserRpaAdapter()
|
||||||
|
adapter.set_credentials("demo001", "pwd", "pin", " ")
|
||||||
|
self.assertEqual(adapter._login_id, "demo001")
|
||||||
|
self.assertIsNone(adapter._profile_dir)
|
||||||
|
|
||||||
|
def test_submit_batch_empty_items(self) -> None:
|
||||||
|
adapter = SimulatorBrowserRpaAdapter()
|
||||||
|
result = adapter.submit_batch("acct-demo-001", [])
|
||||||
|
self.assertFalse(result.ok)
|
||||||
|
self.assertIn("items", result.error_msg or "")
|
||||||
|
|
||||||
|
@patch("service.adapter.simulator_rpa.find_chrome_executable", return_value=None)
|
||||||
|
def test_no_chrome_returns_error_without_launch(self, _chrome: MagicMock) -> None:
|
||||||
|
adapter = SimulatorBrowserRpaAdapter()
|
||||||
|
items = [BatchItem(row_index=1, name="A", account="1", amount=1.0)]
|
||||||
|
result = adapter.submit_batch("acct-demo-001", items)
|
||||||
|
self.assertFalse(result.ok)
|
||||||
|
msg = result.error_msg or ""
|
||||||
|
self.assertTrue("Chrome" in msg or "Edge" in msg or "浏览器" in msg)
|
||||||
|
|
||||||
|
def test_chrome_launch_args_must_not_contain_url(self) -> None:
|
||||||
|
for arg in CHROME_LAUNCH_ARGS:
|
||||||
|
lowered = arg.lower()
|
||||||
|
self.assertFalse(lowered.startswith("http://"))
|
||||||
|
self.assertFalse(lowered.startswith("https://"))
|
||||||
|
self.assertFalse(lowered.startswith("file://"))
|
||||||
|
|
||||||
|
@patch("service.adapter.simulator_rpa.browser_session")
|
||||||
|
@patch("service.adapter.simulator_rpa.find_chrome_executable", return_value="C:/Chrome/chrome.exe")
|
||||||
|
def test_start_url_opened_via_goto_not_launch_args(
|
||||||
|
self,
|
||||||
|
_chrome: MagicMock,
|
||||||
|
mock_session: MagicMock,
|
||||||
|
) -> None:
|
||||||
|
from service.adapter.simulator_rpa import RpaError
|
||||||
|
|
||||||
|
adapter = SimulatorBrowserRpaAdapter(base_url="file:///demo/demo_app.html")
|
||||||
|
items = [BatchItem(row_index=1, name="A", account="1", amount=1.0)]
|
||||||
|
|
||||||
|
page = MagicMock()
|
||||||
|
mock_cm = MagicMock()
|
||||||
|
mock_cm.__enter__.return_value = page
|
||||||
|
mock_cm.__exit__.return_value = False
|
||||||
|
mock_session.return_value = mock_cm
|
||||||
|
|
||||||
|
with patch.object(adapter, "_login", side_effect=RpaError("login fail")):
|
||||||
|
result = adapter.submit_batch("acct-demo-001", items)
|
||||||
|
|
||||||
|
self.assertFalse(result.ok)
|
||||||
|
mock_session.assert_called_once()
|
||||||
|
called_start_url = mock_session.call_args[0][0]
|
||||||
|
self.assertEqual(called_start_url, "file:///demo/demo_app.html")
|
||||||
|
for arg in CHROME_LAUNCH_ARGS:
|
||||||
|
self.assertNotIn(arg, called_start_url)
|
||||||
|
|
||||||
|
def test_safe_screenshot_without_artifacts_dir(self) -> None:
|
||||||
|
adapter = SimulatorBrowserRpaAdapter(artifacts_dir=None)
|
||||||
|
page = MagicMock()
|
||||||
|
self.assertIsNone(adapter._safe_screenshot(page, "tag"))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
55
examples/simulator_browser_rpa/tests/test_stop_reason.py
Normal file
55
examples/simulator_browser_rpa/tests/test_stop_reason.py
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""RPA 失败结果与 artifacts 单元测试。"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
from service.adapter import BatchItem, SimulatorBrowserRpaAdapter
|
||||||
|
from service.adapter.simulator_rpa import RpaError
|
||||||
|
|
||||||
|
|
||||||
|
class TestBatchSubmitFailureResult(unittest.TestCase):
|
||||||
|
@patch("service.adapter.simulator_rpa.find_chrome_executable", return_value="C:/Chrome/chrome.exe")
|
||||||
|
@patch("service.adapter.simulator_rpa.browser_session")
|
||||||
|
def test_rpa_error_converts_to_failed_result(self, mock_session: MagicMock, _chrome: MagicMock) -> None:
|
||||||
|
page = MagicMock()
|
||||||
|
mock_cm = MagicMock()
|
||||||
|
mock_cm.__enter__.return_value = page
|
||||||
|
mock_cm.__exit__.return_value = False
|
||||||
|
mock_session.return_value = mock_cm
|
||||||
|
|
||||||
|
adapter = SimulatorBrowserRpaAdapter(artifacts_dir="/tmp/art")
|
||||||
|
items = [BatchItem(row_index=1, name="A", account="1", amount=1.0)]
|
||||||
|
|
||||||
|
with patch.object(adapter, "_login", side_effect=RpaError("登录第一步失败:timeout", screenshot_path="/tmp/art/x.png")):
|
||||||
|
result = adapter.submit_batch("acct-demo-001", items)
|
||||||
|
|
||||||
|
self.assertFalse(result.ok)
|
||||||
|
self.assertIn("登录第一步失败", result.error_msg or "")
|
||||||
|
self.assertEqual(result.artifacts.get("adapter"), "simulator_browser_rpa")
|
||||||
|
self.assertEqual(result.artifacts.get("screenshot"), "/tmp/art/x.png")
|
||||||
|
|
||||||
|
@patch("service.adapter.simulator_rpa.find_chrome_executable", return_value="C:/Chrome/chrome.exe")
|
||||||
|
@patch("service.adapter.simulator_rpa.browser_session")
|
||||||
|
def test_unexpected_error_includes_adapter_name(self, mock_session: MagicMock, _chrome: MagicMock) -> None:
|
||||||
|
page = MagicMock()
|
||||||
|
mock_cm = MagicMock()
|
||||||
|
mock_cm.__enter__.return_value = page
|
||||||
|
mock_cm.__exit__.return_value = False
|
||||||
|
mock_session.return_value = mock_cm
|
||||||
|
|
||||||
|
adapter = SimulatorBrowserRpaAdapter(artifacts_dir=None)
|
||||||
|
items = [BatchItem(row_index=1, name="A", account="1", amount=1.0)]
|
||||||
|
|
||||||
|
with patch.object(adapter, "_login", side_effect=RuntimeError("boom")):
|
||||||
|
result = adapter.submit_batch("acct-demo-001", items)
|
||||||
|
|
||||||
|
self.assertFalse(result.ok)
|
||||||
|
self.assertIn("未预期异常", result.error_msg or "")
|
||||||
|
self.assertEqual(result.artifacts.get("adapter"), "simulator_browser_rpa")
|
||||||
|
self.assertNotIn("screenshot", result.artifacts)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -1,77 +1,13 @@
|
|||||||
---
|
# Agent 参考索引
|
||||||
description: "用用户能理解的方式说明这个技能能做什么、适合什么场景,以及如何开始使用。"
|
|
||||||
---
|
|
||||||
|
|
||||||
# 【技能名称】
|
本目录供 Agent **运行、编排、调用** skill 时渐进式加载,不是用户市场说明。
|
||||||
|
|
||||||
用一两句话说明这个技能帮助用户完成什么工作。
|
| 文档 | 用途 |
|
||||||
这里不要解释技术实现,要从用户的业务目标出发描述价值。
|
|------|------|
|
||||||
|
| 根目录 [`README.md`](../README.md) | 用户市场详情页说明 |
|
||||||
|
| [`SKILL.md`](../SKILL.md) | LLM / OpenClaw 平台技能入口 |
|
||||||
|
| [`CLI.md`](CLI.md) | 命令行入口、参数与调用契约 |
|
||||||
|
| [`SCHEMA.md`](SCHEMA.md) | 输入输出、数据库与字段说明 |
|
||||||
|
| [`../development/`](../development/) | 开发、测试、技术规范(给开发者 / AI 编程代理) |
|
||||||
|
|
||||||
## 这个技能能帮你做什么
|
按需阅读:编排任务时优先 `CLI.md`;解析结构化字段时读 `SCHEMA.md`;运行时环境细节见 `../development/RUNTIME.md`。
|
||||||
|
|
||||||
用 3 到 6 条业务能力说明技能价值,例如:
|
|
||||||
|
|
||||||
- 【自动整理/查询/生成/同步/核对/提交】某类业务数据
|
|
||||||
- 帮你减少重复操作,降低人工录入或核对成本
|
|
||||||
- 在任务完成后给出清晰的处理结果、失败原因或后续建议
|
|
||||||
|
|
||||||
## 适合什么场景
|
|
||||||
|
|
||||||
列出典型使用场景。请使用用户熟悉的业务语言,例如:
|
|
||||||
|
|
||||||
- 每天需要重复处理同一类订单、单据、报表或客户资料
|
|
||||||
- 需要从多个系统中查询信息并汇总结果
|
|
||||||
- 需要按固定规则检查数据是否完整、是否异常
|
|
||||||
- 需要把处理结果保存为文件、记录或任务报告
|
|
||||||
|
|
||||||
## 使用前需要准备什么
|
|
||||||
|
|
||||||
说明用户在使用前要准备的东西,例如:
|
|
||||||
|
|
||||||
- 相关账号已登录,且具备查询、导出或提交权限
|
|
||||||
- 需要处理的文件、时间范围、订单号、客户名称、项目名称等信息
|
|
||||||
- 如果涉及外部系统,请确认网络、账号、验证码或审批流程可正常使用
|
|
||||||
|
|
||||||
## 你可以这样告诉 Agent
|
|
||||||
|
|
||||||
用自然语言示例展示用户可以怎么发起任务,例如:
|
|
||||||
|
|
||||||
- “帮我查询今天的【业务对象】,整理成表格。”
|
|
||||||
- “帮我核对这些【数据/单据】是否有异常,并告诉我问题在哪里。”
|
|
||||||
- “帮我把【时间范围】内的【业务数据】导出并生成处理报告。”
|
|
||||||
- “帮我根据这个文件里的内容,逐条完成【业务动作】。”
|
|
||||||
|
|
||||||
注意:示例应是自然语言,不要写命令行命令。
|
|
||||||
|
|
||||||
## 执行后你会得到什么
|
|
||||||
|
|
||||||
说明用户会看到什么结果,例如:
|
|
||||||
|
|
||||||
- 任务是否成功完成
|
|
||||||
- 处理了多少条数据
|
|
||||||
- 哪些内容成功、哪些失败
|
|
||||||
- 失败原因和建议处理方式
|
|
||||||
- 生成的文件、表格、报告或记录
|
|
||||||
|
|
||||||
## 注意事项
|
|
||||||
|
|
||||||
用用户能理解的方式说明边界和风险,例如:
|
|
||||||
|
|
||||||
- 请确认输入范围准确,避免处理错数据
|
|
||||||
- 涉及提交、付款、删除、审批等高风险动作时,技能应在执行前请求确认
|
|
||||||
- 如果外部系统登录失效、权限不足或页面变化,任务可能需要用户介入
|
|
||||||
- 不建议在未核对数据的情况下直接执行批量操作
|
|
||||||
|
|
||||||
## 常见问题
|
|
||||||
|
|
||||||
### 为什么任务没有查到数据?
|
|
||||||
|
|
||||||
可能是时间范围、关键词、账号权限或系统筛选条件不正确。请先确认输入信息是否准确。
|
|
||||||
|
|
||||||
### 为什么任务执行到一半需要我操作?
|
|
||||||
|
|
||||||
可能遇到了登录、验证码、权限确认、二次审批或系统异常。请根据 Agent 的提示完成必要操作。
|
|
||||||
|
|
||||||
### 结果文件在哪里查看?
|
|
||||||
|
|
||||||
请根据 Agent 返回的结果说明查看生成文件、任务记录或处理报告。
|
|
||||||
|
|||||||
@@ -1,356 +0,0 @@
|
|||||||
# 技能需求文档模板
|
|
||||||
|
|
||||||
这份文档用于给技术人员、产品人员和实施人员统一描述某个 skill 的研发需求。
|
|
||||||
|
|
||||||
建议原则:
|
|
||||||
|
|
||||||
- 一个 skill 对应一份主需求文档
|
|
||||||
- 需求先写清楚,再进入开发
|
|
||||||
- 文档描述“要做什么”和“做到什么程度”,不要在这里堆实现细节
|
|
||||||
- 实现方式、代码结构、发布流程,分别放到 `DEVELOPMENT.md`、`CLI.md`、`SCHEMA.md`、`RUNTIME.md`
|
|
||||||
|
|
||||||
如果你是从 `skill-template` 复制新技能,请复制本文件后,把下面所有占位内容替换成你的真实项目内容。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# REQUIREMENTS
|
|
||||||
|
|
||||||
## 1. 文档目标
|
|
||||||
|
|
||||||
说明这份需求文档的作用,以及它解决什么问题。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
- 本文档用于明确 `【技能名称】` 的研发范围、交付标准、依赖关系和验收要求。
|
|
||||||
- 技术人员应以本文件作为开发范围依据,以避免实现偏差、范围蔓延或理解不一致。
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
- 本文档用于明确 `your-skill-slug`(示例:`disburse-payroll-icbc`)的研发范围、交付标准、依赖关系和验收要求。
|
|
||||||
|
|
||||||
## 2. 业务背景
|
|
||||||
|
|
||||||
说明为什么要做这个 skill,它服务什么业务场景,解决什么实际问题。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
- 当前业务场景中,用户需要在 `【目标平台】` 完成 `【业务动作】`。
|
|
||||||
- 现有流程主要依赖人工处理,存在 `【效率低 / 容易出错 / 不可批量 / 不可追踪】` 等问题。
|
|
||||||
- 因此需要开发 `【技能名称】`,将该流程标准化、自动化,并接入匠厂技能体系中。
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
- 当前财务团队需要将工资代发批次与银行接口对账,人工导出表格、核对差异耗时且易错。
|
|
||||||
- 因此需要开发 `disburse-payroll-icbc`,用于自动拉取代发结果、写入任务日志 `task_logs` 并输出对账摘要,支持审计追踪。
|
|
||||||
|
|
||||||
## 3. 开发目标
|
|
||||||
|
|
||||||
说明本次开发希望最终交付什么结果。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
- 完成 `【技能名称】` 的标准目录结构搭建
|
|
||||||
- 完成 CLI 入口与基础命令
|
|
||||||
- 完成核心业务流程
|
|
||||||
- 完成与兄弟技能或外部系统的必要集成
|
|
||||||
- 完成正式环境发布验证
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
- 完成 `your-skill-slug` 的标准 skill 结构建设
|
|
||||||
- 提供 `health`、`version`、`run`、`logs`、`log-get` 等命令
|
|
||||||
- 支持对接银行 / 薪酬系统 API(示例),并记录任务执行结果
|
|
||||||
- 支持写入任务日志 `task_logs`,并可在正式环境中安装验证
|
|
||||||
|
|
||||||
## 4. 功能范围
|
|
||||||
|
|
||||||
说明这次开发明确要实现哪些功能。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
- 支持 `【命令1】`
|
|
||||||
- 支持 `【命令2】`
|
|
||||||
- 支持读取 `【数据来源】`
|
|
||||||
- 支持执行 `【核心业务动作】`
|
|
||||||
- 支持记录 `【日志 / 状态 / 结果】`
|
|
||||||
|
|
||||||
建议将功能拆成“必须实现”和“可后续扩展”。
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
### 必须实现
|
|
||||||
|
|
||||||
- 支持 `python scripts/main.py health`
|
|
||||||
- 支持 `python scripts/main.py version`
|
|
||||||
- 支持 `python scripts/main.py run`
|
|
||||||
- 支持从 `some-sibling-skill` 读取批次元数据(如需要)
|
|
||||||
- 支持执行核心业务编排(HTTP / 批处理 / 可选 RPA)
|
|
||||||
- 支持写入任务日志(`task_logs`)
|
|
||||||
|
|
||||||
### 可后续扩展
|
|
||||||
|
|
||||||
- 支持定时批跑
|
|
||||||
- 支持失败自动重试
|
|
||||||
- 支持多目标轮询
|
|
||||||
|
|
||||||
## 5. 非功能要求
|
|
||||||
|
|
||||||
说明除功能外,对稳定性、可维护性、目录规范、日志、编码等方面的要求。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
- 目录结构必须符合当前 skill 模板规范
|
|
||||||
- 入口必须统一为 `scripts/main.py`
|
|
||||||
- 输出格式应尽量机读友好
|
|
||||||
- 错误前缀统一为 `ERROR:`
|
|
||||||
- Windows 环境下需保证 UTF-8 输出兼容
|
|
||||||
- 必须具备基本日志能力
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
- 项目结构必须对齐 `skill-template`
|
|
||||||
- CLI 入口统一使用 `scripts/main.py`
|
|
||||||
- 关键执行结果应可通过 JSON 或固定文本结构返回
|
|
||||||
- 任务日志必须可追踪(`task_logs`)
|
|
||||||
- 不允许重新引入旧模板中的 `docs/`、`optional/` 或 `scripts/skill_main.py`
|
|
||||||
|
|
||||||
## 6. 输入输出要求
|
|
||||||
|
|
||||||
说明这个 skill 接收什么输入,产出什么输出。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
### 输入
|
|
||||||
|
|
||||||
- `【输入参数1】`
|
|
||||||
- `【输入参数2】`
|
|
||||||
- `【依赖系统返回的数据】`
|
|
||||||
|
|
||||||
### 输出
|
|
||||||
|
|
||||||
- `【标准输出】`
|
|
||||||
- `【错误输出】`
|
|
||||||
- `【数据库记录】`
|
|
||||||
- `【日志文件】`
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
### 输入
|
|
||||||
|
|
||||||
- `target_id`:可选,指定任务目标(账号 / 客户 / 平台)
|
|
||||||
- `input_id`:可选,指定输入批次或记录
|
|
||||||
- 兄弟技能返回的结构化数据(如有)
|
|
||||||
|
|
||||||
### 输出
|
|
||||||
|
|
||||||
- 成功结果(stdout / JSON)
|
|
||||||
- 错误输出(`ERROR:` / `FAIL:`)
|
|
||||||
- 在本地数据库写入 `task_logs`
|
|
||||||
- 在日志目录中写入执行日志
|
|
||||||
|
|
||||||
## 7. 依赖的兄弟技能或外部系统
|
|
||||||
|
|
||||||
说明开发该 skill 时依赖哪些内部技能或外部平台。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
### 兄弟技能依赖
|
|
||||||
|
|
||||||
- `【skill-a】`:作用是 `【用途】`
|
|
||||||
- `【skill-b】`:作用是 `【用途】`
|
|
||||||
|
|
||||||
### 外部系统依赖
|
|
||||||
|
|
||||||
- `【平台名】`:作用是 `【用途】`
|
|
||||||
- `【浏览器 / API / 第三方服务】`:作用是 `【用途】`
|
|
||||||
|
|
||||||
### Python 包依赖(requirements.txt)
|
|
||||||
|
|
||||||
- 本技能若需**特有** Python 三方包,写入根目录 `requirements.txt`。
|
|
||||||
- `jiangchang-platform-kit`、`playwright` 等公共能力由宿主共享 runtime 提供,**不要**写入技能 requirements。
|
|
||||||
- `SKILL.md` 的 `platform_kit_min_version` 是运行契约/兼容性声明,供宿主校验,**不是** pip 依赖声明。
|
|
||||||
- 匠厂宿主安装/更新技能后,会将技能 requirements 安装到 `{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`。
|
|
||||||
- 版本须尽量收窄(如 `requests>=2.31.0,<3`),避免共享 venv 冲突。
|
|
||||||
- **不要**把系统运行时组件(如 Microsoft Visual C++ Redistributable)写进 requirements.txt。
|
|
||||||
|
|
||||||
### 系统运行时前置条件(preflight / health)
|
|
||||||
|
|
||||||
- 若依赖 Windows 原生 DLL、本机浏览器 channel 等**系统级**能力,在 `health` / preflight 中检测并提示用户自行安装。
|
|
||||||
- 此类依赖**不**通过 pip / requirements.txt 由宿主自动安装。
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
### 兄弟技能依赖
|
|
||||||
|
|
||||||
- `some-sibling-skill`:提供主数据或凭证索引(按业务填写)
|
|
||||||
|
|
||||||
### 外部系统依赖
|
|
||||||
|
|
||||||
- 银行 / 政务 HTTP API(示例):核心外部接口
|
|
||||||
- Chromium / Chrome / Edge(可选):用于浏览器自动化
|
|
||||||
- Gitea:用于代码托管和发布工作流
|
|
||||||
- 匠厂客户端:用于正式环境安装与验证
|
|
||||||
|
|
||||||
## 8. 不在本次范围内的内容
|
|
||||||
|
|
||||||
这一节非常重要,用来明确本次“不做什么”,避免研发越做越散。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
- 本次不实现 `【功能A】`
|
|
||||||
- 本次不处理 `【平台B】`
|
|
||||||
- 本次不做 `【高级能力】`
|
|
||||||
- 本次不兼容 `【旧结构 / 旧逻辑】`
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
- 本次不实现多租户隔离之外的附加报表
|
|
||||||
- 本次不实现实时流式处理
|
|
||||||
- 本次不实现自动重试机制
|
|
||||||
- 本次不兼容旧模板中的历史目录结构
|
|
||||||
|
|
||||||
## 9. 验收标准
|
|
||||||
|
|
||||||
说明什么情况下才算真正开发完成。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
- 代码结构符合模板规范
|
|
||||||
- 最小命令可运行
|
|
||||||
- 核心命令可运行
|
|
||||||
- 正式环境可安装
|
|
||||||
- 匠厂中可看到最新版本
|
|
||||||
- 可以在新建任务中实际使用
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
- `health`、`version` 命令执行正常
|
|
||||||
- `run` 主流程可运行
|
|
||||||
- 发布后 Gitea 工作流成功
|
|
||||||
- 匠厂技能市场能看到最新版本
|
|
||||||
- skill 可以正常安装
|
|
||||||
- 安装后可在“新建任务”中调用
|
|
||||||
|
|
||||||
**测试与日志相关验收(所有新 skill 必须满足)**:
|
|
||||||
|
|
||||||
- `python tests/run_tests.py -v` 必跑测试全部通过
|
|
||||||
- 任务日志(task_logs)写入和查询符合预期
|
|
||||||
- 真实联调(如有)已在 tests/integration/ 中验证,且默认套件不包含真实外联
|
|
||||||
|
|
||||||
## 10. 开发注意事项
|
|
||||||
|
|
||||||
说明研发过程中必须特别注意的事项。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
- 不要修改无关 skill
|
|
||||||
- 不要破坏现有模板规范
|
|
||||||
- 优先遵守目录和分层约定
|
|
||||||
- 不要在 CLI 层堆业务逻辑
|
|
||||||
- 发布前必须先做本地最小验证
|
|
||||||
|
|
||||||
示例:
|
|
||||||
|
|
||||||
- 只允许修改当前 skill 仓库,不要改动其他兄弟项目
|
|
||||||
- 如使用浏览器自动化,优先复用已验证过的定位器和流程
|
|
||||||
- `cli` 只做参数解析,核心逻辑统一放到 `service`
|
|
||||||
- 发布前必须完成本地验证、工作流验证和正式环境安装验证
|
|
||||||
|
|
||||||
## 11. 变更记录
|
|
||||||
|
|
||||||
这一节用于记录需求文档本身的变化,不是 git 提交记录的替代,而是给技术人员看“需求范围怎么变了”。
|
|
||||||
|
|
||||||
模板写法:
|
|
||||||
|
|
||||||
| 日期 | 版本 | 变更人 | 变更内容 |
|
|
||||||
|------|------|--------|----------|
|
|
||||||
| 2026-04-13 | v1.0 | 张三 | 初版需求文档 |
|
|
||||||
| 2026-04-14 | v1.1 | 李四 | 增加正式环境验收要求 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 建议使用方式
|
|
||||||
|
|
||||||
建议每个新 skill 开发时,按下面顺序使用文档:
|
|
||||||
|
|
||||||
1. 先写 `references/REQUIREMENTS.md`
|
|
||||||
2. 再按 `references/DEVELOPMENT.md` 进入开发
|
|
||||||
3. 开发过程中补充 `CLI.md`、`SCHEMA.md`、`RUNTIME.md`、`TESTING.md`
|
|
||||||
4. 发布前回到 `REQUIREMENTS.md` 对照验收标准逐项检查
|
|
||||||
|
|
||||||
## 最小模板示例
|
|
||||||
|
|
||||||
下面给出一个可直接参考的简化版示例:
|
|
||||||
|
|
||||||
```md
|
|
||||||
# REQUIREMENTS
|
|
||||||
|
|
||||||
## 1. 文档目标
|
|
||||||
|
|
||||||
本文档用于明确 `your-skill-slug` 的研发需求、范围和验收标准,作为开发与测试的统一依据。
|
|
||||||
|
|
||||||
## 2. 业务背景
|
|
||||||
|
|
||||||
采购审计需要将政府采购公告结构化归档;人工复制粘贴效率低,需要可追溯的任务日志。
|
|
||||||
|
|
||||||
## 3. 开发目标
|
|
||||||
|
|
||||||
- 完成 `your-skill-slug` 的标准 skill 结构
|
|
||||||
- 支持核心业务批处理 / HTTP 对接主流程
|
|
||||||
- 支持任务日志记录(task_logs)
|
|
||||||
|
|
||||||
## 4. 功能范围
|
|
||||||
|
|
||||||
- 支持 `health`
|
|
||||||
- 支持 `version`
|
|
||||||
- 支持 `run`
|
|
||||||
- 支持查询任务日志(logs / log-get)
|
|
||||||
|
|
||||||
## 5. 非功能要求
|
|
||||||
|
|
||||||
- 入口统一为 `scripts/main.py`
|
|
||||||
- 保持 UTF-8 输出
|
|
||||||
- 结构符合 skill 模板规范
|
|
||||||
|
|
||||||
## 6. 输入输出要求
|
|
||||||
|
|
||||||
### 输入
|
|
||||||
|
|
||||||
- `target_id`
|
|
||||||
- `input_id`
|
|
||||||
|
|
||||||
### 输出
|
|
||||||
|
|
||||||
- 成功结果
|
|
||||||
- 错误信息
|
|
||||||
- task_logs 记录
|
|
||||||
|
|
||||||
## 7. 依赖的兄弟技能或外部系统
|
|
||||||
|
|
||||||
- (按需填写兄弟 skill)
|
|
||||||
- 政务公告站点 HTTP API(示例)
|
|
||||||
|
|
||||||
## 8. 不在本次范围内的内容
|
|
||||||
|
|
||||||
- 不实现浏览器可视化回放(如需另行立项)
|
|
||||||
- 不实现自动重试
|
|
||||||
|
|
||||||
## 9. 验收标准
|
|
||||||
|
|
||||||
- 命令可运行
|
|
||||||
- `python tests/run_tests.py -v` 全部通过
|
|
||||||
- task_logs 写入符合 SCHEMA 约定
|
|
||||||
- 能完成正式环境安装验证
|
|
||||||
- 能在新建任务中使用
|
|
||||||
|
|
||||||
## 10. 开发注意事项
|
|
||||||
|
|
||||||
- 不修改无关项目
|
|
||||||
- 不引入旧模板结构
|
|
||||||
|
|
||||||
## 11. 变更记录
|
|
||||||
|
|
||||||
| 日期 | 版本 | 变更人 | 变更内容 |
|
|
||||||
|------|------|--------|----------|
|
|
||||||
| 2026-04-13 | v1.0 | 张三 | 初版 |
|
|
||||||
```
|
|
||||||
@@ -3,4 +3,4 @@
|
|||||||
SKILL_SLUG = "your-skill-slug"
|
SKILL_SLUG = "your-skill-slug"
|
||||||
SKILL_VERSION = "1.0.14"
|
SKILL_VERSION = "1.0.14"
|
||||||
LOG_LOGGER_NAME = "openclaw.skill.your_skill_slug"
|
LOG_LOGGER_NAME = "openclaw.skill.your_skill_slug"
|
||||||
PLATFORM_KIT_MIN_VERSION = "1.0.13"
|
PLATFORM_KIT_MIN_VERSION = "1.0.14"
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ def get_skill_root() -> str:
|
|||||||
return _SKILL_ROOT
|
return _SKILL_ROOT
|
||||||
|
|
||||||
|
|
||||||
def platform_kit_version_patch(version: str = "1.0.13"):
|
def platform_kit_version_patch(version: str = "1.0.14"):
|
||||||
"""Mock installed jiangchang-platform-kit version for health/diagnostics tests."""
|
"""Mock installed jiangchang-platform-kit version for health/diagnostics tests."""
|
||||||
from unittest.mock import patch
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
|||||||
@@ -16,17 +16,17 @@ class TestDocsStandards(unittest.TestCase):
|
|||||||
return f.read()
|
return f.read()
|
||||||
|
|
||||||
def test_rpa_md_covers_video_and_playwright_standards(self) -> None:
|
def test_rpa_md_covers_video_and_playwright_standards(self) -> None:
|
||||||
text = self._read("references/RPA.md")
|
text = self._read("development/RPA.md")
|
||||||
self.assertIn("title", text)
|
self.assertIn("title", text)
|
||||||
self.assertIn("closing_title", text)
|
self.assertIn("closing_title", text)
|
||||||
self.assertIn("中文", text)
|
self.assertIn("中文", text)
|
||||||
self.assertIn("--no-sandbox", text)
|
self.assertIn("--no-sandbox", text)
|
||||||
self.assertIn("--disable-blink-features=AutomationControlled", text)
|
self.assertIn("--disable-blink-features=AutomationControlled", text)
|
||||||
self.assertIn("RpaVideoSession", text)
|
self.assertIn("RpaVideoSession", text)
|
||||||
self.assertIn("1.0.13", text)
|
self.assertIn("1.0.14", text)
|
||||||
|
|
||||||
def test_adapter_md_covers_four_tiers_and_allow_flags(self) -> None:
|
def test_adapter_md_covers_four_tiers_and_allow_flags(self) -> None:
|
||||||
text = self._read("references/ADAPTER.md")
|
text = self._read("development/ADAPTER.md")
|
||||||
for marker in (
|
for marker in (
|
||||||
"mock",
|
"mock",
|
||||||
"simulator_rpa",
|
"simulator_rpa",
|
||||||
@@ -45,18 +45,17 @@ class TestDocsStandards(unittest.TestCase):
|
|||||||
self.assertIn("uv run python", text)
|
self.assertIn("uv run python", text)
|
||||||
|
|
||||||
def test_testing_md_mentions_pytest_txt_collection_guard(self) -> None:
|
def test_testing_md_mentions_pytest_txt_collection_guard(self) -> None:
|
||||||
text = self._read("references/TESTING.md")
|
text = self._read("development/TESTING.md")
|
||||||
self.assertIn(".txt", text)
|
self.assertIn(".txt", text)
|
||||||
self.assertIn("pytest.ini", text)
|
self.assertIn("pytest.ini", text)
|
||||||
|
|
||||||
def test_docs_do_not_claim_1_0_11_as_current_standard(self) -> None:
|
def test_docs_do_not_claim_1_0_11_as_current_standard(self) -> None:
|
||||||
for rel in (
|
for rel in (
|
||||||
"README.md",
|
|
||||||
"SKILL.md",
|
"SKILL.md",
|
||||||
"references/RUNTIME.md",
|
"development/RUNTIME.md",
|
||||||
"references/RPA.md",
|
"development/RPA.md",
|
||||||
"references/CONFIG.md",
|
"development/CONFIG.md",
|
||||||
"references/TESTING.md",
|
"development/TESTING.md",
|
||||||
):
|
):
|
||||||
text = self._read(rel)
|
text = self._read(rel)
|
||||||
self.assertNotIn(
|
self.assertNotIn(
|
||||||
|
|||||||
@@ -83,16 +83,16 @@ class TestPlatformImportSource(unittest.TestCase):
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_platform_kit_min_version_is_1_0_13(self) -> None:
|
def test_platform_kit_min_version_is_1_0_14(self) -> None:
|
||||||
from jiangchang_skill_core import version_ge
|
from jiangchang_skill_core import version_ge
|
||||||
from util.constants import PLATFORM_KIT_MIN_VERSION
|
from util.constants import PLATFORM_KIT_MIN_VERSION
|
||||||
|
|
||||||
self.assertEqual(PLATFORM_KIT_MIN_VERSION, "1.0.13")
|
self.assertEqual(PLATFORM_KIT_MIN_VERSION, "1.0.14")
|
||||||
|
|
||||||
md_path = os.path.join(get_skill_root(), "SKILL.md")
|
md_path = os.path.join(get_skill_root(), "SKILL.md")
|
||||||
with open(md_path, encoding="utf-8") as f:
|
with open(md_path, encoding="utf-8") as f:
|
||||||
md = f.read()
|
md = f.read()
|
||||||
self.assertEqual(_parse_platform_kit_min_version(md), "1.0.13")
|
self.assertEqual(_parse_platform_kit_min_version(md), "1.0.14")
|
||||||
|
|
||||||
req_path = os.path.join(get_skill_root(), "requirements.txt")
|
req_path = os.path.join(get_skill_root(), "requirements.txt")
|
||||||
with open(req_path, encoding="utf-8") as f:
|
with open(req_path, encoding="utf-8") as f:
|
||||||
|
|||||||
@@ -10,13 +10,15 @@ from _support import get_skill_root
|
|||||||
DOC_PATHS = (
|
DOC_PATHS = (
|
||||||
"README.md",
|
"README.md",
|
||||||
"SKILL.md",
|
"SKILL.md",
|
||||||
"references/RUNTIME.md",
|
"development/RUNTIME.md",
|
||||||
"references/CLI.md",
|
"references/CLI.md",
|
||||||
"references/DEVELOPMENT.md",
|
"development/DEVELOPMENT.md",
|
||||||
"references/RPA.md",
|
"development/RPA.md",
|
||||||
"references/CONFIG.md",
|
"development/CONFIG.md",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
RUNTIME_DOC_PATHS = tuple(p for p in DOC_PATHS if p != "README.md")
|
||||||
|
|
||||||
FORBIDDEN_PHRASES = (
|
FORBIDDEN_PHRASES = (
|
||||||
"scripts/jiangchang_skill_core/:运行时",
|
"scripts/jiangchang_skill_core/:运行时",
|
||||||
"运行时与统一日志副本",
|
"运行时与统一日志副本",
|
||||||
@@ -32,7 +34,7 @@ FORBIDDEN_PHRASES = (
|
|||||||
|
|
||||||
POSITIVE_MARKERS = (
|
POSITIVE_MARKERS = (
|
||||||
"jiangchang-platform-kit",
|
"jiangchang-platform-kit",
|
||||||
"1.0.13",
|
"1.0.14",
|
||||||
"共享 runtime",
|
"共享 runtime",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -54,7 +56,7 @@ class TestTemplateRuntimeStandard(unittest.TestCase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def test_guarded_docs_promote_shared_runtime_standard(self) -> None:
|
def test_guarded_docs_promote_shared_runtime_standard(self) -> None:
|
||||||
combined = "\n".join(self._read(p) for p in DOC_PATHS)
|
combined = "\n".join(self._read(p) for p in RUNTIME_DOC_PATHS)
|
||||||
for marker in POSITIVE_MARKERS:
|
for marker in POSITIVE_MARKERS:
|
||||||
self.assertIn(
|
self.assertIn(
|
||||||
marker,
|
marker,
|
||||||
@@ -67,7 +69,7 @@ class TestTemplateRuntimeStandard(unittest.TestCase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def test_runtime_md_mentions_collect_runtime_diagnostics(self) -> None:
|
def test_runtime_md_mentions_collect_runtime_diagnostics(self) -> None:
|
||||||
text = self._read("references/RUNTIME.md")
|
text = self._read("development/RUNTIME.md")
|
||||||
self.assertIn("collect_runtime_diagnostics", text)
|
self.assertIn("collect_runtime_diagnostics", text)
|
||||||
|
|
||||||
def test_cli_md_mentions_health_runtime_diagnostics(self) -> None:
|
def test_cli_md_mentions_health_runtime_diagnostics(self) -> None:
|
||||||
|
|||||||
194
tools/highlight_answers.py
Normal file
194
tools/highlight_answers.py
Normal file
@@ -0,0 +1,194 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Highlight correct answer options in Excel quiz file."""
|
||||||
|
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import openpyxl
|
||||||
|
from openpyxl.cell.rich_text import CellRichText, InlineFont, TextBlock
|
||||||
|
|
||||||
|
# Option letter to index mapping
|
||||||
|
LETTER_TO_IDX = {"A": 0, "B": 1, "C": 2, "D": 3}
|
||||||
|
IDX_TO_LETTER = {0: "A", 1: "B", 2: "C", 3: "D"}
|
||||||
|
|
||||||
|
# Regex to find option boundaries: A/B/C/D followed by separator
|
||||||
|
OPTION_MARKER_RE = re.compile(
|
||||||
|
r"(?=[A-D](?:[\..、::\))]|\s))"
|
||||||
|
)
|
||||||
|
|
||||||
|
NORMAL_FONT = InlineFont(b=False, color="000000")
|
||||||
|
RED_BOLD_FONT = InlineFont(b=True, color="FF0000")
|
||||||
|
|
||||||
|
|
||||||
|
def parse_answer(answer_raw) -> set[int]:
|
||||||
|
"""Parse answer column into set of option indices (0=A, 1=B, ...)."""
|
||||||
|
if answer_raw is None:
|
||||||
|
return set()
|
||||||
|
s = str(answer_raw).strip()
|
||||||
|
if not s:
|
||||||
|
return set()
|
||||||
|
|
||||||
|
indices = set()
|
||||||
|
|
||||||
|
# Pure digits like "13" -> 1 and 3 (not 13)
|
||||||
|
if re.fullmatch(r"[1-4]+", s):
|
||||||
|
for ch in s:
|
||||||
|
indices.add(int(ch) - 1)
|
||||||
|
return indices
|
||||||
|
|
||||||
|
# Split by common separators
|
||||||
|
parts = re.split(r"[,,;;\s|]+", s)
|
||||||
|
for part in parts:
|
||||||
|
part = part.strip().upper()
|
||||||
|
if not part:
|
||||||
|
continue
|
||||||
|
if part in LETTER_TO_IDX:
|
||||||
|
indices.add(LETTER_TO_IDX[part])
|
||||||
|
elif re.fullmatch(r"[1-4]", part):
|
||||||
|
indices.add(int(part) - 1)
|
||||||
|
|
||||||
|
return indices
|
||||||
|
|
||||||
|
|
||||||
|
def find_option_spans(text: str) -> list[tuple[int, int, str]]:
|
||||||
|
"""Find spans for each A/B/C/D option in the options text."""
|
||||||
|
if not text or not isinstance(text, str):
|
||||||
|
return []
|
||||||
|
|
||||||
|
markers = []
|
||||||
|
for m in OPTION_MARKER_RE.finditer(text):
|
||||||
|
letter = text[m.start()]
|
||||||
|
markers.append((m.start(), letter))
|
||||||
|
|
||||||
|
if not markers:
|
||||||
|
return []
|
||||||
|
|
||||||
|
spans = []
|
||||||
|
for i, (start, letter) in enumerate(markers):
|
||||||
|
end = markers[i + 1][0] if i + 1 < len(markers) else len(text)
|
||||||
|
spans.append((start, end, letter))
|
||||||
|
return spans
|
||||||
|
|
||||||
|
|
||||||
|
def build_rich_text(options_text: str, answer_indices: set[int]) -> CellRichText | str:
|
||||||
|
"""Build rich text with correct options in red bold."""
|
||||||
|
spans = find_option_spans(options_text)
|
||||||
|
if not spans:
|
||||||
|
return options_text
|
||||||
|
|
||||||
|
parts = []
|
||||||
|
pos = 0
|
||||||
|
for start, end, letter in spans:
|
||||||
|
if start > pos:
|
||||||
|
parts.append(TextBlock(NORMAL_FONT, options_text[pos:start]))
|
||||||
|
idx = LETTER_TO_IDX.get(letter)
|
||||||
|
font = RED_BOLD_FONT if idx is not None and idx in answer_indices else NORMAL_FONT
|
||||||
|
parts.append(TextBlock(font, options_text[start:end]))
|
||||||
|
pos = end
|
||||||
|
|
||||||
|
if pos < len(options_text):
|
||||||
|
parts.append(TextBlock(NORMAL_FONT, options_text[pos:]))
|
||||||
|
|
||||||
|
return CellRichText(*parts)
|
||||||
|
|
||||||
|
|
||||||
|
def load_workbook_from_xls(xls_path: Path) -> openpyxl.Workbook:
|
||||||
|
"""Load .xls file, converting via pandas/xlrd if needed."""
|
||||||
|
try:
|
||||||
|
import pandas as pd
|
||||||
|
|
||||||
|
xls_data = pd.read_excel(xls_path, sheet_name=None, header=None, dtype=str)
|
||||||
|
wb = openpyxl.Workbook()
|
||||||
|
# Remove default sheet
|
||||||
|
wb.remove(wb.active)
|
||||||
|
|
||||||
|
for sheet_name, df in xls_data.items():
|
||||||
|
ws = wb.create_sheet(title=str(sheet_name))
|
||||||
|
for r_idx, row in enumerate(df.itertuples(index=False), start=1):
|
||||||
|
for c_idx, val in enumerate(row, start=1):
|
||||||
|
if val is not None and str(val) != "nan":
|
||||||
|
ws.cell(row=r_idx, column=c_idx, value=str(val))
|
||||||
|
return wb
|
||||||
|
except Exception as e:
|
||||||
|
raise RuntimeError(f"Failed to read .xls file: {e}") from e
|
||||||
|
|
||||||
|
|
||||||
|
def find_header_columns(ws) -> tuple[int, int, int] | None:
|
||||||
|
"""Find header row and column indices for 题目选项 and 题目答案."""
|
||||||
|
for row_idx in range(1, min(ws.max_row + 1, 20)):
|
||||||
|
options_col = None
|
||||||
|
answer_col = None
|
||||||
|
for col_idx in range(1, ws.max_column + 1):
|
||||||
|
val = ws.cell(row=row_idx, column=col_idx).value
|
||||||
|
if val is None:
|
||||||
|
continue
|
||||||
|
s = str(val).strip()
|
||||||
|
if s == "题目选项":
|
||||||
|
options_col = col_idx
|
||||||
|
elif s == "题目答案":
|
||||||
|
answer_col = col_idx
|
||||||
|
if options_col is not None and answer_col is not None:
|
||||||
|
return row_idx, options_col, answer_col
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def process_sheet(ws, stats: dict) -> bool:
|
||||||
|
"""Process a single worksheet. Returns True if processed."""
|
||||||
|
header_info = find_header_columns(ws)
|
||||||
|
if header_info is None:
|
||||||
|
return False
|
||||||
|
|
||||||
|
header_row, options_col, answer_col = header_info
|
||||||
|
stats["sheets"] += 1
|
||||||
|
sheet_rows = 0
|
||||||
|
sheet_matches = 0
|
||||||
|
|
||||||
|
for row_idx in range(header_row + 1, ws.max_row + 1):
|
||||||
|
options_cell = ws.cell(row=row_idx, column=options_col)
|
||||||
|
answer_cell = ws.cell(row=row_idx, column=answer_col)
|
||||||
|
|
||||||
|
options_text = options_cell.value
|
||||||
|
if options_text is None:
|
||||||
|
continue
|
||||||
|
options_text = str(options_text).strip()
|
||||||
|
if not options_text:
|
||||||
|
continue
|
||||||
|
|
||||||
|
answer_indices = parse_answer(answer_cell.value)
|
||||||
|
if not answer_indices:
|
||||||
|
continue
|
||||||
|
|
||||||
|
sheet_rows += 1
|
||||||
|
sheet_matches += len(answer_indices)
|
||||||
|
|
||||||
|
rich = build_rich_text(options_text, answer_indices)
|
||||||
|
options_cell.value = rich
|
||||||
|
|
||||||
|
stats["rows"] += sheet_rows
|
||||||
|
stats["matches"] += sheet_matches
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
src = Path(r"D:\下载\安全知识竞赛题库(1).xls")
|
||||||
|
dst = Path(r"D:\下载\安全知识竞赛题库_答案标红.xlsx")
|
||||||
|
|
||||||
|
if not src.exists():
|
||||||
|
print(f"ERROR: Source file not found: {src}")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
print(f"Reading: {src}")
|
||||||
|
wb = load_workbook_from_xls(src)
|
||||||
|
|
||||||
|
stats = {"sheets": 0, "rows": 0, "matches": 0}
|
||||||
|
for ws in wb.worksheets:
|
||||||
|
process_sheet(ws, stats)
|
||||||
|
|
||||||
|
wb.save(dst)
|
||||||
|
print(f"Saved: {dst}")
|
||||||
|
print(f"处理结果: {stats['sheets']} 个工作表, {stats['rows']} 行, {stats['matches']} 个匹配选项")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
57
tools/verify_highlight.py
Normal file
57
tools/verify_highlight.py
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Verify highlighted answer output file."""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import openpyxl
|
||||||
|
|
||||||
|
dst = Path(r"D:\下载\安全知识竞赛题库_答案标红.xlsx")
|
||||||
|
src = Path(r"D:\下载\安全知识竞赛题库(1).xls")
|
||||||
|
|
||||||
|
print(f"Source exists: {src.exists()}")
|
||||||
|
print(f"Output exists: {dst.exists()}")
|
||||||
|
|
||||||
|
wb = openpyxl.load_workbook(dst, rich_text=True)
|
||||||
|
ws = wb.active
|
||||||
|
print(f"Sheet: {ws.title}, rows={ws.max_row}, cols={ws.max_column}")
|
||||||
|
|
||||||
|
# Find header columns
|
||||||
|
header_row = None
|
||||||
|
options_col = None
|
||||||
|
answer_col = None
|
||||||
|
for row_idx in range(1, 20):
|
||||||
|
for col_idx in range(1, ws.max_column + 1):
|
||||||
|
val = ws.cell(row=row_idx, column=col_idx).value
|
||||||
|
if val and str(val).strip() == "题目选项":
|
||||||
|
options_col = col_idx
|
||||||
|
if val and str(val).strip() == "题目答案":
|
||||||
|
answer_col = col_idx
|
||||||
|
if options_col and answer_col:
|
||||||
|
header_row = row_idx
|
||||||
|
break
|
||||||
|
|
||||||
|
print(f"Header row={header_row}, options_col={options_col}, answer_col={answer_col}")
|
||||||
|
|
||||||
|
# Sample verification for first 5 rows with answers 1,2,3
|
||||||
|
samples = []
|
||||||
|
for row_idx in range(header_row + 1, ws.max_row + 1):
|
||||||
|
answer = ws.cell(row=row_idx, column=answer_col).value
|
||||||
|
if answer in ("1", "2", "3", 1, 2, 3):
|
||||||
|
cell = ws.cell(row=row_idx, column=options_col)
|
||||||
|
val = cell.value
|
||||||
|
runs = []
|
||||||
|
if hasattr(val, "__iter__") and not isinstance(val, str):
|
||||||
|
for block in val:
|
||||||
|
font = block.font
|
||||||
|
bold = font.b if font else None
|
||||||
|
color = font.color if font else None
|
||||||
|
runs.append((block.text, bold, color))
|
||||||
|
samples.append((row_idx, answer, runs))
|
||||||
|
if len(samples) >= 5:
|
||||||
|
break
|
||||||
|
|
||||||
|
for row_idx, answer, runs in samples:
|
||||||
|
print(f"\nRow {row_idx}, answer={answer}:")
|
||||||
|
for text, bold, color in runs:
|
||||||
|
marker = "RED_BOLD" if bold and color == "FF0000" else "normal"
|
||||||
|
print(f" [{marker}] {repr(text[:50])}")
|
||||||
Reference in New Issue
Block a user