Python中如何使用pytest-mock的spy功能追踪函数调用次数?

千萱同学_8015

千萱同学_8015

2026-07-14

1026人浏览

原创

spy是pytest-mock提供的监控机制,可记录函数调用(次数、参数等)但不改变其原始行为;而mock.patch默认完全替换目标函数,需手动设置side_effect才能转发调用。

python中如何使用pytest-mock的spy功能追踪函数调用次数?

spy是什么,和mock.patch有什么区别?

pytest-mock 本身不提供原生 spy 功能——它只是 unittest.mock 的封装层。所谓“spy”,指的是既能记录调用行为(如次数、参数),又不干扰原函数执行的机制。Python 标准库的 Mock 默认会拦截并替换目标,而真正实现 spy 行为,得靠 side_effect + 原函数转发。

常见误区是以为 mocker.spy() 是独立功能,其实它是 pytest-mock 提供的一个便捷包装,底层仍调用 Mock 并设置 side_effect 指向原函数。

  • mocker.spy(obj, "method") 返回一个 Mock 实例,该实例:
    • 自动把调用转发给原 obj.method
    • 同时记录所有调用(call_count、call_args_list 等可用)
  • 它不等价于 mocker.patch:后者默认完全替换,需手动设 side_effect 才能转发

如何正确使用mocker.spy()验证调用次数?

关键点:必须确保被 spy 的对象在测试中真实被调用,而不是被其他 patch 覆盖或导入路径错误。

  • 使用前确认目标函数的导入路径与 spy 路径一致(比如在 test_module.py 中 spy utils.helper,就要写 mocker.spy(utils, "helper"),不是 mocker.spy(myapp.utils, "helper"))
  • spy 返回的对象可直接断言:
    spy = mocker.spy(module, "some_function")
    some_function()  # 触发调用
    assert spy.call_count == 1
  • 若函数返回值重要,spy 不影响它;但若函数有副作用(如修改全局状态),这些副作用依然发生

容易踩的坑:

  • 在同一个模块里先 @patch("module.func"),再 mocker.spy(module, "func") → 后者失效,因为 patch 已接管符号
  • 对类方法 spy 时传错对象:应 spy 类本身(mocker.spy(MyClass, "method")),而非实例(除非你明确要 spy 实例绑定方法)

call_count不准?检查是否触发了真正的调用路径

call_count 为 0 很可能不是 spy 写错了,而是测试没走到那行代码。

  • 检查被测函数内部是否条件跳过、提前 return 或抛异常中断流程
  • 查看日志或加临时 print 确认目标函数是否真被执行(注意:不要在 spy 对象上 print,它本身不执行逻辑)
  • 使用 spy.assert_called() 或 spy.assert_called_once() 比直接读 call_count 更健壮,它们会在失败时给出清晰提示

示例场景:

python 查询技能
python 查询技能

查询客流数据,输出JSON格式,可直接导入Bitable等可视化工具

下载
def process_items(items):
    for item in items:
        validate(item)  # ← 这个要 spy
    return len(items)
<h1>测试</h1><p>def test_process_items_calls_validate_twice(mocker):
spy = mocker.spy(module, "validate")
process_items([1, 2])
assert spy.call_count == 2</p>

如果 items 是空列表,call_count 就是 0 —— 这不是 spy 的问题,是逻辑路径没覆盖。

spy和monkeypatch混用时要注意什么?

pytest-mock 的 mocker fixture 和 monkeypatch 都能改对象,但行为不同:

  • mocker.spy() 是轻量级监听,不改变绑定关系
  • monkeypatch.setattr(obj, "attr", new_value) 是硬替换,会彻底覆盖原值

二者同时作用于同一目标时,后应用的生效。比如:

# 先 spy
spy = mocker.spy(mod, "func")
# 再 monkeypatch 替换
monkeypatch.setattr(mod, "func", lambda: "fake")
# 此时 spy.call_count 永远为 0,因为原 func 根本没执行

所以:

  • 只需要观测调用 → 用 mocker.spy()
  • 需要替换行为 + 同时记录 → 改用 mocker.patch(..., side_effect=original_func)
  • 不要交叉使用 spy 和 monkeypatch 修改同一个属性,除非你清楚控制顺序和生命周期

实际项目里,spy 最适合验证“是否按预期触发了某个工具函数”,而不是替代逻辑分支。它的价值在于低侵入性 —— 你不用重写业务逻辑,就能确认协作关系是否成立。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1691

4

python能做什么
python能做什么

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

2023.07.25

4264

7

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

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

2023.07.31

1689

3

python教程
python教程

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

2023.08.03

24877

23

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

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

2023.08.04

3047

5

python eval
python eval

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

2023.08.04

3067

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

2363

5

热门下载

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

精品课程

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