讲师中心 微信公众号
AI工具推荐 视频效率加速

在Python中如何使用pytest-snapshot做快照测试

秋伟小哥_6065

秋伟小哥_6065

发布时间:2026-10-08 06:01:41

|

990人浏览过

|

来源于php中文网

原创

pytest-snapshot已官方归档,pip install默认安装过时的0.5.x版本(仅支持Python旧版本),不再维护,不推荐使用。

在python中如何使用pytest-snapshot做快照测试

pytest-snapshot 本身不维护了,官方已归档,直接 pip install 会失败或装到过时的 0.5.x 版本(仅支持 Python

为什么 pip install pytest-snapshot 失败或测试不运行

PyPI 上的 pytest-snapshot 自 2020 年起停止更新,GitHub 仓库 marked as “archived”。它依赖旧版 py 和硬编码的 pytest 钩子机制,在 pytest ≥ 6.0 和 Python ≥ 3.8 下会抛出 AttributeError: 'Config' object has no attribute 'slaveinput' 或导入失败。

  • 你看到的 No module named 'pytest_snapshot' 通常是因为安装空包或版本冲突
  • 即使装上,@snapshot 装饰器在新 pytest 中根本不会被识别
  • 快照文件默认生成在错误路径(如 __snapshots__/test_foo.py.snap),但插件不处理目录自动创建或编码问题

替代方案:用 pytest-asyncio + pytest-snapshot 的精神继承者 —— pytest-snapshot(注意重名)

真正可用的是社区维护的现代分支:pytest-snapshot(作者 erev0s,PyPI 包名相同但版本从 0.7.0+ 起重构)。它兼容 pytest ≥ 7.0、Python 3.8+,API 几乎一致,但必须手动指定安装源:

pip install -U "pytest-snapshot @ git+https://github.com/erev0s/pytest-snapshot.git"
  • 安装后,pytest --snapshot-update 可正常生成/更新快照
  • 快照默认存放在测试文件同级的 __snapshots__/ 目录,文件名基于测试函数名自动推导
  • 支持 JSON、字符串、字典、列表等常见 Python 类型,底层调用 pprint.pformat 确保可读性与稳定性
  • 不支持自定义序列化器(比如对 datetime 或 numpy array 做特殊处理),遇到这类对象需先转成 dict/list 或 str

写一个能跑通的快照测试示例

假设你有个函数返回结构化数据,想确保输出格式不意外变更:

python-pro
python-pro

高级 Python 特性、异步编程、性能调优、静态类型、内存管理、Python 内部机制及生态库方面的专家。

下载

立即学习“Python免费学习笔记(深入)”;

def get_user_profile():
    return {
        "id": 123,
        "name": "Alice",
        "tags": ["admin", "beta"],
        "created_at": "2024-05-20T10:30:00Z"  # 注意:避免直接塞 datetime 对象
    }

对应测试:

def test_get_user_profile(snapshot):
    assert get_user_profile() == snapshot
  • snapshot 是 pytest 自动注入的 fixture,无需 import
  • 首次运行加 --snapshot-update 参数生成 __snapshots__/test_example.py.snap
  • 后续运行会比对当前返回值和快照文件内容(逐行字符串比较),不通过则报 diff
  • 如果修改了 get_user_profile 返回结构,必须显式加 --snapshot-update 才能通过,防止无感知变更

容易被忽略的三个细节

快照测试不是“设好就忘”的黑盒 —— 它的可靠性高度依赖人为约定:

  • 快照文件是代码的一部分,必须提交进 Git;否则 CI 会因找不到快照而失败
  • 不要在快照中包含非确定性字段(如 uuid4()、time.time()、内存地址),否则每次运行都不同;应提前 mock 或剥离
  • snapshot fixture 不支持参数化测试的每个 case 单独快照(比如 @pytest.mark.parametrize);若需区分,得手动拼接快照名称:assert result == snapshot(name="test_with_foo")

快照测试的价值不在“省事”,而在“锁定结构契约”——一旦快照变,就得人眼确认:这是预期改进,还是破坏性改动。别让它变成没人敢点 --snapshot-update 的定时炸弹。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

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

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

1671

2023.07.20

python能做什么
python能做什么

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

4184

2023.07.25

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

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

1669

2023.07.31

python教程
python教程

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

24197

2023.08.03

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

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

2967

2023.08.04

python eval
python eval

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

2987

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn