使用 mock_open 模拟 open 函数调用方法

本文旨在解决在单元测试中，如何使用 unittest.mock.mock_open 来模拟类方法中 open 函数的调用，从而避免实际的文件写入操作，并验证写入的内容。通过正确的 patch 目标和调用方式，可以有效地测试与文件操作相关的代码逻辑。

在编写单元测试时，经常需要模拟文件操作，以避免实际的文件写入或读取，并验证代码是否按照预期的方式与文件系统交互。unittest.mock 模块提供了 mock_open 函数，可以方便地模拟 open 函数的行为。然而，在类方法中使用 open 函数时，如何正确地 patch 它可能会让人困惑。本文将详细介绍如何使用 mock_open 来模拟类方法中 open 函数的调用，并提供示例代码和注意事项。

模拟 open 函数

mock_open 函数返回一个可以替代 open 函数的 mock 对象。这个 mock 对象可以记录 open 函数的调用参数，并提供一个模拟的文件对象，该文件对象可以模拟文件读取和写入操作。

正确的 patch 目标

patch 函数用于替换指定的对象。在使用 mock_open 模拟 open 函数时，需要确保 patch 的目标是 open 函数本身，而不是类或类方法。在 Python 3 中，内置的 open 函数位于 builtins 模块中。因此，正确的 patch 目标是 builtins.open。

示例代码

以下是一个示例代码，演示了如何使用 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):
    def test_build(self):
        m = mock_open()
        with patch("builtins.open", m):
            builder = Builder({}, output_filename="test_out", output_dir="outputs")
            builder.build()

        # 验证 open 函数是否被调用，以及调用参数是否正确
        m.assert_called_with("outputs/test_out.EB", "w")

        # 验证 write 函数是否被调用，以及写入的内容是否正确
        handle = m() # 获取模拟的文件对象
        handle.write.assert_called_once_with("")

        print(handle.mock_calls)

在这个示例中，patch("builtins.open", m) 将 open 函数替换为 mock_open 返回的 mock 对象 m。在 builder.build() 方法中调用 open 函数时，实际上调用的是 m。

m.assert_called_with("outputs/test_out.EB", "w") 验证 open 函数是否被调用，以及调用参数是否为 "outputs/test_out.EB" 和 "w"。

handle = m() 获取模拟的文件对象。handle.write.assert_called_once_with("") 验证模拟的文件对象的 write 方法是否被调用，以及写入的内容是否为 ""。

注意事项

• 确保 patch 的目标是 builtins.open，而不是类或类方法。
• 使用 m() 获取模拟的文件对象，而不是 m.return_value。
• 使用 assert_called_with 和 assert_called_once_with 等方法验证 mock 对象的调用参数。

总结

使用 mock_open 可以方便地模拟类方法中 open 函数的调用，从而避免实际的文件写入操作，并验证写入的内容。通过正确的 patch 目标和调用方式，可以有效地测试与文件操作相关的代码逻辑。在编写单元测试时，请务必注意 patch 的目标和 mock 对象的调用方式，以确保测试的准确性和可靠性。