pytest-snapshot 是一个 pytest 插件,用于快照测试,它只比对 python 可序列化对象(如 str、dict、list)与历史快照,本身不支持直接测 ui;若用于 ui 测试,需先用 selenium/playwright 等工具提取稳定、去噪的文本或结构化数据(如清洗后的 html 或关键文本),再交由其断言。

pytest-snapshot 是什么,它能测 UI 吗?
pytest-snapshot 本身不抓屏、不渲染 HTML、不启动浏览器。它只做一件事:把 Python 对象(str、dict、list 等)序列化后与历史快照比对。所谓“UI 测试”,实际是你自己先用 Selenium / Playwright / BeautifulSoup 等工具提取出 UI 的**可序列化表示**——比如页面标题、关键文本块、JSON 化的 DOM 结构、或渲染后的 Markdown 源码——再交给 snapshot 去比对。
如果你直接传一个 WebDriver 实例或 WebElement 给 assert_snapshot,会报 TypeError: Object of type WebDriver is not JSON serializable。这是最常卡住的第一步。
如何安全地 snapshot 页面文本或结构?
核心原则:只 snapshot 字符串或纯数据结构,且确保每次提取逻辑稳定、无随机值(如时间戳、UUID、动态 ID)。
- 用
driver.title+driver.find_element(...).text提取关键可见文本,拼成str后传给snapshot.assert_match() - 若需结构化对比,用
driver.execute_script("return document.body.outerHTML")获取 HTML 片段,但务必先用正则清洗掉动态属性:re.sub(r' id="[^"]*"', '', html)、re.sub(r'data-timestamp="[^"]*"', '', html) - 避免 snapshot 整个
page_source:体积大、diff 不友好、容易因空格/换行微小差异失败 - 对长文本,建议按语义分块 snapshot,例如:
snapshot.assert_match(header_text, "header")、snapshot.assert_match(main_content, "main_content"),而不是塞进一个大字符串
为什么 snapshot 第一次运行就失败?
因为没生成快照文件。pytest-snapshot 默认只读取已有快照,不做写入。你需要显式启用写入模式:
- 首次运行加参数:
pytest --snapshot-update(注意是双横线) - CI 环境中禁止该参数,否则会意外覆盖快照;本地开发确认结果正确后再提交新快照文件
- 快照文件默认存在
__snapshots__目录下,路径基于测试函数名生成,如test_login.py/test_login_ui/__snapshots__/test_login_ui.json - 如果改了测试函数名或挪了文件位置,旧快照不会自动迁移,得手动删对应快照文件再
--snapshot-update
中文、emoji 或特殊字符显示为 \uXXXX 怎么办?
这是 JSON 序列化的默认行为,pytest-snapshot 内部用的是 json.dumps(..., ensure_ascii=True)。不影响比对正确性,但人工 review 快照文件时体验差。
解决方法是在 conftest.py 中重载序列化器:
def pytest_configure(config):
import pytest_snapshot.plugin
pytest_snapshot.plugin.JSONEncoder = lambda self, obj: json.dumps(
obj, ensure_ascii=False, indent=2, sort_keys=True
)
注意:这个 patch 必须在 pytest 导入 pytest_snapshot 插件前生效,所以放在 conftest.py 顶部、且确保没有其他插件提前触发导入。
真正麻烦的是非确定性输出:比如日志里带毫秒级时间、服务端返回的临时 token、或者前端框架插入的注释节点。这些必须在提取阶段剔除,否则每次 snapshot 都会变——而你很难一眼看出是 bug 还是噪声。
Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!











