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

本文旨在帮助开发者理解如何在单元测试中，使用 unittest.mock.mock_open 来模拟类方法内部 open 函数的调用，从而避免实际的文件写入操作，并验证代码的预期行为。文章将提供示例代码，并详细解释如何正确地使用 patch 和 mock_open 来实现这一目标。

在编写单元测试时，我们经常需要模拟外部依赖，例如文件操作。unittest.mock 模块提供了强大的模拟功能，其中 mock_open 可以用来模拟 open 函数的行为。然而，在类方法中使用 open 函数时，如何正确地进行模拟可能会让人感到困惑。

正确使用 patch 和 mock_open

问题的关键在于正确指定 patch 的目标。通常，我们需要模拟的是 builtins.open，而不是类方法内部的 open。这是因为 Python 在执行 open 函数时，会首先查找 builtins 模块中的 open 函数。

下面是一个示例，展示了如何正确地使用 patch 和 mock_open 来模拟类方法中的 open 函数调用：

阿里云-虚拟数字人

阿里云-虚拟数字人是什么？ ...

2

查看详情

import unittest
from unittest.mock import mock_open, MagicMock, 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()
        handle.write.assert_called_once_with("")

        print(handle.mock_calls)

代码解释：

1. patch("builtins.open", m): 这行代码使用 patch 装饰器来替换 builtins.open 函数为 mock_open 创建的 mock 对象 m。
2. m.assert_called_with("outputs/test_out.EB", "w"): 这行代码验证 open 函数是否按照预期被调用，参数是否正确。
3. handle = m(): mock_open 返回的是一个上下文管理器，我们需要调用 mock 对象 m 来获取文件对象。
4. handle.write.assert_called_once_with(""): 这行代码验证 write 函数是否按照预期被调用，参数是否正确。

注意事项：

• 确保 patch 的目标是 builtins.open，而不是类方法内部的 open。
• mock_open 返回的是一个上下文管理器，需要调用 mock 对象来获取文件对象。
• 可以使用 assert_called_with 和 assert_called_once_with 等方法来验证 mock 对象的调用情况。

总结：

通过正确地使用 patch 和 mock_open，我们可以轻松地模拟类方法中的 open 函数调用，从而编写更加健壮和可测试的单元测试。理解 patch 的目标以及 mock_open 的返回值是关键。希望本文能够帮助你更好地掌握单元测试技巧。

以上就是使用 mock_open 模拟类方法中 open 函数调用的详细内容，更多请关注php中文网其它相关文章！