Python中如何用mock_open断言指定文件的写入内容？原代码失效排查

初始实现的问题 #

我有一个程序会根据特定逻辑向不同文件写入内容，尝试编写assert_file_written_with_content(filepath: str, content: str)函数，通过mock_open验证指定内容是否写入到指定文件路径中。初始实现如下：

@pytest.fixture(autouse=True)
def mock_open_file(self, mocker):
    mocker.patch("builtins.open", mock_open(), create=True)

def assert_file_written_with_content(file_path, content):
    """当通过builtins.open打开文件且已被mock时，断言文件写入了指定内容。"""
    mock_open_file = builtins.open # 此时是mock_open对象
    for call in mock_open_file.call_args_list:
        if call.args[0] == file_path and call.args[1] == "w":
            call.return_value.write.assert_called_with(content)
            return
    raise AssertionError(f"File {file_path} was not written with content {content}")

但即使内容不匹配，这个断言也始终通过，不会抛出错误。此外希望pytest在不匹配时能打印文件路径和内容的对比信息。

更新后的不优雅实现 #

我现在有一个能正常工作的实现，但逻辑依赖mock_calls的顺序，显得很不优雅：

import builtins
from testfixtures import compare

@pytest.fixture(autouse=True)
def mock_open_file(self, mocker):
    mocker.patch("builtins.open", mock_open(), create=True)

def assert_file_written_with_content(file_path, content):
    """当通过builtins.open打开文件且已被mock时，断言文件写入了指定内容。"""
    mock_open_file = builtins.open # 此时是mock_open对象
    for i, call in enumerate(mock_open_file.mock_calls[::4]):
        current_iteration = i * 4
        if call.args[0] == file_path and call.args[1] == "w":
            call_write = mock_open_file.mock_calls[current_iteration + 2]
            compare(content, call_write[1][0])
            return
    raise AssertionError(f"File {file_path} was not written with content {content}")

解答 #

为什么初始断言不会触发错误？ #

你的初始实现存在两个核心问题：

1. 全局共享的文件Mock：mock_open()默认会让所有open()调用返回同一个文件对象Mock。这意味着所有文件的write操作都会记录在同一个Mock的调用历史中，你无法区分某段内容属于哪个文件的写入操作。
2. 错误的Mock对象引用：当使用with open(...) as f:语法时，f是open()返回对象的__enter__方法的返回值，而非open()直接返回的上下文管理器对象。你的代码中call.return_value.write访问的是上下文管理器Mock的write方法，这个方法根本没被实际调用过，断言逻辑自然无法生效。

优雅的实现方案 #

我们可以通过让每次open()调用返回独立的文件Mock对象，同时正确跟踪每个文件的写入内容，来实现可靠且易维护的断言：

import builtins
from unittest.mock import MagicMock
import pytest

@pytest.fixture(autouse=True)
def mock_open_file(mocker):
    # 为每个open调用创建独立的文件Mock实例
    def create_file_mock():
        file_mock = MagicMock()
        # 模拟上下文管理器行为，__enter__返回自身
        file_mock.__enter__.return_value = file_mock
        return file_mock
    
    # 让open的Mock每次调用都返回新的文件Mock
    open_mock = MagicMock(side_effect=create_file_mock)
    mocker.patch("builtins.open", open_mock)
    return open_mock

def assert_file_written_with_content(open_mock, file_path, expected_content):
    """验证指定路径的文件被写入了预期内容"""
    # 遍历所有open调用记录
    for open_call in open_mock.call_args_list:
        call_args, _ = open_call
        # 检查是否是以写入模式打开目标文件
        if call_args[0] == file_path and call_args[1] == "w":
            # 获取实际执行写入操作的文件Mock（上下文管理器__enter__的返回值）
            file_mock = open_call.return_value.__enter__.return_value
            # 拼接所有write调用的参数，还原完整写入内容
            actual_content = "".join([call.args[0] for call in file_mock.write.call_args_list])
            # 对比内容，不匹配时输出清晰的对比信息
            assert actual_content == expected_content, (
                f"文件 {file_path} 写入内容不匹配:\n"
                f"预期内容:\n{repr(expected_content)}\n"
                f"实际内容:\n{repr(actual_content)}"
            )
            return
    # 未找到目标文件的写入操作
    raise AssertionError(f"未找到对文件 {file_path} 的写入操作（模式为'w'）")

使用示例 #

在测试用例中直接注入fixture并调用断言函数即可：

def test_multi_file_write(mock_open_file):
    # 模拟业务代码中的文件写入
    with open("file1.txt", "w") as f:
        f.write("第一部分")
        f.write("第二部分")
    
    with open("file2.txt", "w") as f:
        f.write("测试内容")
    
    # 验证文件写入
    assert_file_written_with_content(mock_open_file, "file1.txt", "第一部分第二部分")
    assert_file_written_with_content(mock_open_file, "file2.txt", "测试内容")

方案优势 #

1. 独立隔离：每个文件的Mock对象相互独立，不同文件的写入操作不会干扰断言结果。
2. 内容完整还原：支持多次write调用的场景，拼接所有写入内容进行验证。
3. 清晰的错误反馈：断言失败时会打印预期与实际内容的对比，便于快速定位问题。
4. 逻辑健壮：不依赖mock_calls的调用顺序，后续代码变动不会轻易导致断言失效。

内容的提问来源于stack exchange，提问作者ACarver