如何在Python中利用pytest-snapshot进行UI界面或长文本对比测试?

胖墨同学_1770

胖墨同学_1770

2026-06-17

794人浏览

原创

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

如何在python中利用pytest-snapshot进行ui界面或长文本对比测试?

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 默认只读取已有快照,不做写入。你需要显式启用写入模式:

testing-python
testing-python

使用pytest编写和评估有效的Python测试。适用于编写测试、审查测试代码、调试测试失败或提高测试覆盖率。

下载
  • 首次运行加参数: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 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1671

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4204

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

24457

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2987

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3007

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1163

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2323

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程