用途
该工具包用于与本地 Web 应用进行交互和测试,基于 Playwright 实现。主要面向需要验证前端功能、调试 UI 行为、捕获控制台日志等场景。
主要能力
- 使用原生 Python Playwright 脚本测试本地 Web 应用。
- 提供辅助脚本
scripts/with_server.py,用于管理服务器生命周期,支持同时管理多个服务器。 - 支持验证前端功能、调试 UI 行为、捕获控制台日志。
- 提供示例文件,展示常见模式:
element_discovery.py:发现页面上的按钮、链接和输入框。static_html_automation.py:使用 file:// URL 处理本地 HTML。console_logging.py:在自动化过程中捕获控制台日志。
使用方式
脚本调用原则
始终先用 --help 运行脚本以查看用法。在尝试运行脚本并确认确实需要自定义方案之前,不要阅读脚本源码。这些脚本可能非常大,会污染上下文窗口;它们应作为黑盒脚本直接调用,而不是被读入上下文窗口。
决策树:选择方法
用户任务 → 是否为静态 HTML?
- 是 → 直接读取 HTML 文件以识别选择器
- 成功 → 使用选择器编写 Playwright 脚本
- 失败/不完整 → 按动态应用处理(见下)
- 否(动态 Web 应用)→ 服务器是否已在运行?
- 否 → 运行:
python scripts/with_server.py --help,然后使用该辅助脚本并编写简化的 Playwright 脚本 - 是 → 先侦察后操作:
- 导航并等待 networkidle
- 截图或检查 DOM
- 从渲染状态识别选择器
- 使用发现的选择器执行操作
- 否 → 运行:
使用 with_server.py 的示例
启动服务器前先运行 --help,然后使用辅助脚本。
单服务器:
python scripts/with_server.py --server "npm run dev" --port 5173 -- python your_automation.py
多服务器(例如后端 + 前端):
python scripts/with_server.py \
--server "cd backend && python server.py" --port 3000 \
--server "cd frontend && npm run dev" --port 5173 \
-- python your_automation.py
创建自动化脚本时,只包含 Playwright 逻辑(服务器会被自动管理):
from playwright.sync_api import sync_playwright
with sync_playwright() as p:
browser = p.chromium.launch(headless=True) # Always launch chromium in headless mode
page = browser.new_page()
page.goto('http://localhost:5173') # Server already running and ready
page.wait_for_load_state('networkidle') # CRITICAL: Wait for JS to execute
# ... your automation logic
browser.close()
先侦察后操作模式
检查渲染后的 DOM:
page.screenshot(path='/tmp/inspect.png', full_page=True)
content = page.content()
page.locator('button').all()
从检查结果中识别选择器,然后使用发现的选择器执行操作。
常见陷阱
- 不要在动态应用上等待 networkidle 之前就检查 DOM。
- 应在检查前执行
page.wait_for_load_state('networkidle')。
最佳实践
- 将捆绑脚本作为黑盒使用:为完成任务,考虑
scripts/中是否有脚本可以提供帮助。这些脚本能可靠地处理常见、复杂的工作流,而不会使上下文窗口变得杂乱。使用--help查看用法,然后直接调用。 - 同步脚本使用
sync_playwright()。 - 完成后始终关闭浏览器。
- 使用描述性选择器:
text=、role=、CSS 选择器或 ID。 - 添加适当的等待:
page.wait_for_selector()或page.wait_for_timeout()。
适用场景
- 本地 Web 应用的前端功能验证。
- UI 行为调试。
- 控制台日志捕获。
- 静态 HTML 与动态 Web 应用的自动化测试。
限制
资料中未提供关于收费、价格、平台支持范围、性能效果等方面的信息,暂未提供。