本文旨在帮助开发者理解如何使用 unittest.mock 模块中的 mock_open 函数，来模拟类方法中 open 函数的行为，从而进行有效的单元测试。我们将通过一个具体的示例，详细讲解如何正确地使用 patch 和 mock_open，以及如何断言模拟的 open 函数及其返回的文件对象的方法调用。
在进行单元测试时，我们经常需要模拟一些外部依赖，比如文件操作。unittest.mock 模块提供了强大的模拟功能，其中 mock_open 可以用于模拟 open 函数。然而，在类方法中使用 open 函数时，如何正确地使用 mock_open 可能会让人困惑。
正确使用 mock_open 和 patch
关键在于理解 mock_open 返回的模拟对象实际上是用于模拟 open 函数的上下文管理器。要访问模拟的文件对象及其方法调用，需要调用 mock_open 返回的模拟对象。
立即学习“Python免费学习笔记（深入）”；
以下是一个示例，展示了如何正确地使用 mock_open 来测试一个包含 open 函数的类方法：
import unittest
from unittest.mock import mock_open, patch
class Builder:
def __init__(self, input_template_map, output_filename, output_dir=""):
self.input_template_map = input_template_map
self.output_filename = output_filename
self.output_dir = output_dir
def build(self):
output = ""
# some code that adds to the output that requires files to be read
# (i.e. calls open(somefile, "r"))
with open(f"{self.output_dir}/{self.output_filename}.EB", "w") as f:
f.write(output)
class ModelTest(unittest.TestCase):
@classmethod
def setUpClass(cls):
cls.builder = Builder({...}, output_filename="test_out", output_dir="outputs")
def test_build(self):
m = mock_open()
with patch("builtins.open", m):
self.builder.build()
# 检查 open 函数是否被正确调用
m.assert_called_with("outputs/test_out.EB", "w")
# 检查 write 函数是否被正确调用
handle = m() # 调用 mock_open 返回的模拟对象，获取文件对象
handle.write.assert_called_once_with("")
print(handle.mock_calls) # 打印文件对象上的所有模拟调用代码解释：
- patch("builtins.open", m): 使用 patch 装饰器或上下文管理器来替换 builtins.open 函数为 mock_open 创建的模拟对象 m。 builtins.open 是 Python 内置的 open 函数，这是最可靠的 patching 目标。
- m.assert_called_with("outputs/test_out.EB", "w"): 断言 open 函数是否以期望的参数被调用。
- handle = m(): 这是关键的一步。m 是 mock_open 返回的模拟对象，它代表的是 open 函数本身。 调用 m() 会返回一个模拟的文件对象，这个对象可以用来模拟文件操作。
- handle.write.assert_called_once_with(""): 断言模拟的文件对象的 write 方法是否以期望的参数被调用。
- print(handle.mock_calls): 打印模拟的文件对象上的所有调用，有助于调试。
注意事项：
- 确保 patch 的目标是正确的。通常，builtins.open 是一个安全的选择。
- mock_open 返回的模拟对象是用于模拟 open 函数本身，而不是文件对象。要访问文件对象，需要调用该模拟对象。
- 可以使用 assert_called_with 和 assert_called_once_with 等方法来断言模拟对象是否被正确调用。
总结：
通过正确地使用 mock_open 和 patch，我们可以有效地模拟类方法中的 open 函数，从而编写出可靠的单元测试。关键在于理解 mock_open 返回的模拟对象代表的是 open 函数，需要调用它才能获取模拟的文件对象。通过断言模拟对象及其方法的调用，我们可以验证代码的正确性。
