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

如何使用pytest-mock在Python中模拟open函数读写文件?

千墨姑娘_6047

千墨姑娘_6047

发布时间:2026-08-19 11:10:10

|

745人浏览过

|

来源于php中文网

原创

因为open是内置函数,patch需作用于其被导入的位置(如"utils.open"),而非定义位置"builtins.open";否则mock不生效,真实文件操作仍执行。

如何使用pytest-mock在python中模拟open函数读写文件?

为什么直接 patch open 会失败?

因为 Python 的 open 是内置函数,它在模块的全局命名空间里,但 pytest-mock(底层用的是 unittest.mock.patch)默认 patch 的是「目标对象被导入的位置」,不是定义位置。比如你在 my_module.py 里写了 with open("data.txt") as f:,就得 patch my_module.open,而不是 builtins.open(Python 3)或 __builtin__.open(Python 2)。否则 mock 不生效,真实文件操作照常发生。

常见错误现象:FileNotFoundError 仍抛出,或断言 mock 调用次数为 0。

  • 确认被测函数所在模块名,比如 utils.py,就 patch "utils.open"
  • Python 3 下不要写 "builtins.open" —— 除非你明确在测试文件里 import 了 builtins 并直接调用它
  • 如果被测代码在 __main__ 中运行(如脚本式代码),需 patch "__builtin__.open" 或 "builtins.open",但这种情况应尽量避免

用 mocker.patch 模拟读文件(open 返回 StringIO)

最稳妥的方式是让 mock 的 open 返回一个可读的类文件对象,比如 io.StringIO(文本模式)或 io.BytesIO(二进制模式)。这样能兼容 read()、readlines()、上下文管理等行为。

import io
from mypackage.utils import load_config
<p>def test_load_config(mocker):</p><p><span>立即学习</span>“<a href="https://pan.quark.cn/s/00968c3c2c15" style="text-decoration: underline !important; color: blue; font-weight: bolder;" rel="nofollow" target="_blank">Python免费学习笔记(深入)</a>”;</p><h1>模拟 open 返回一个含 JSON 内容的 StringIO</h1><pre class="brush:php;toolbar:false;">mock_file = io.StringIO('{"host": "localhost", "port": 8080}')
mocker.patch("mypackage.utils.open", return_value=mock_file)

result = load_config()
assert result == {"host": "localhost", "port": 8080}

注意:这里 return_value=mock_file 只处理了单次调用;若函数中多次 open(如先读再写),需用 side_effect 返回不同对象。

提示词大师-python版
提示词大师-python版

图片提示词生成器?不止如此。 马甲系统 —— 把脑海中的画面,翻译成AI能理解的专业表达。 用得越多,它越懂你:首次需要多问几句确认方向,用久了几乎一说就懂。 用得越多,它越快:缓存机制让后续对话越来越省。 RAG进化:成功案例持续入库,越跑越聪明。 输入「新手指南」查看完整功能介绍

下载
  • 必须手动调用 mock_file.seek(0) 后续才能重复读取,否则第二次 read() 返回空字符串
  • 如果被测函数用了 encoding 参数(如 open(..., encoding="utf-8")),mock 不校验参数,但你要确保 StringIO 内容是合法字符串
  • 不推荐用 return_value=mocker.mock_open(read_data="...") —— 它对 readline() 和迭代行为支持不稳定,容易在复杂逻辑中翻车

模拟写文件并验证内容是否正确写入

要验证写入行为,关键是捕获写入的目标对象(即 mock 返回的文件句柄),然后检查它的 write 方法是否被调用、传入什么参数。

def test_save_report(mocker):
    mock_file_obj = mocker.mock_open()
    mocker.patch("reports.generate.open", mock_file_obj)
<pre class="brush:php;toolbar:false;">save_report({"status": "ok"})

# 验证 open 被以 "w" 模式调用
mock_file_obj.assert_called_once_with("report.json", "w", encoding="utf-8")
# 验证 write 被调用,且内容包含预期字符串
handle = mock_file_obj()
handle.write.assert_called_once()
assert '"status": "ok"' in handle.write.call_args[0][0]

注意 mocker.mock_open() 返回的是一个 mock 工厂,第一次调用它(mock_file_obj())才拿到那个“假文件句柄”对象。

  • 如果被测函数用的是 print(..., file=f),需额外 patch builtins.print 或确保 mock 文件对象有 write 和 flush 方法
  • 二进制写入("wb")要用 BytesIO,且 write 参数得是 bytes,否则类型错误
  • 别忘了检查 mode 和 encoding 是否匹配——mock 不报错,但真实逻辑可能因编码不一致崩溃

遇到 OSError: [Errno 9] Bad file descriptor 怎么办?

这通常是因为 mock 的文件对象缺少关键方法(如 __enter__、__exit__、close),而被测代码在 with 语句结束时试图调用它们。原生 mock_open 默认不带完整上下文协议支持。

解决方案:手动补全协议方法,或改用 io.StringIO + 显式设置 mock 行为:

def test_with_open_context(mocker):
    mock_file = mocker.MagicMock()
    mock_file.__enter__.return_value = mock_file
    mock_file.__exit__.return_value = None
    mock_file.read.return_value = "fake content"
<pre class="brush:php;toolbar:false;">mocker.patch("mymodule.open", return_value=mock_file)
result = read_from_file()
assert result == "fake content"

  • 直接用 mocker.MagicMock 更可控,尤其当你要精细控制 __iter__(for line in f)、readline() 等行为时
  • 如果被测函数调用了 f.close(),mock 对象必须有该方法(哪怕只是 pass),否则抛 AttributeError
  • 别依赖 mock_open 的自动上下文支持——它的 __enter__ 默认返回自身,但 __exit__ 可能没设,导致 Bad file descriptor

真正麻烦的从来不是怎么 mock,而是被测函数里那些没显式关闭、混用文本/二进制模式、或依赖文件指针位置的细节——这些地方 mock 很难覆盖,得靠重构来降低耦合。

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

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

豆包大模型

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

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

相关专题

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

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

1611

2023.07.20

python能做什么
python能做什么

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

3864

2023.07.25

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

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

1609

2023.07.31

python教程
python教程

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

22357

2023.08.03

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

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

2747

2023.08.04

python eval
python eval

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

2787

2023.08.04

scratch和python区别
scratch和python区别

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

1123

2023.08.11

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

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

596

2023.08.10

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

0

2026.09.29

热门下载

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

精品课程

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

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