pytest-mock中assert_called_once_with的参数变更问题分析

在Python单元测试中，pytest-mock是一个常用的mock工具库，它基于标准库unittest.mock构建。本文将深入分析一个常见的测试陷阱：当被mock函数调用后参数被修改时，assert_called_once_with断言可能失败的问题。

问题现象

考虑以下代码场景：

# main.py
import utils

def func_a(name_list: list[str], name: str):
    utils.func_b(name_list)
    name_list.remove(name)

对应的测试代码：

# test_main.py
import pytest
from pytest_mock import MockerFixture
from unittest.mock import MagicMock

from main import func_a
import utils

@pytest.mark.asyncio
async def test_func_a(mocker: MockerFixture):
    mocked_method = mocker.patch.object(
        utils, "func_b", return_value=None, autospec=True
    )
    func_a(name_list=["astral1020", "nicoddemus"], name="astral1020")
    mocked_method.assert_called_once_with(name_list=["astral1020", "nicoddemus"])

这个测试会失败，因为在调用utils.func_b之后，name_list参数被修改了（移除了"astral1020"），而assert_called_once_with检查的是参数当前状态而非调用时的状态。

问题根源

这个问题源于Python中对象引用的特性以及unittest.mock的实现方式：

1. Python中列表是可变对象，通过引用传递
2. unittest.mock在记录调用参数时保存的是参数的引用而非副本
3. 当后续代码修改了参数对象时，mock记录的参数值也会随之改变

解决方案

1. 使用深拷贝保存参数

最直接的解决方案是在测试前对可变参数进行深拷贝：

import copy

@pytest.mark.asyncio
async def test_func_a(mocker: MockerFixture):
    name_list = ["astral1020", "nicoddemus"]
    original_list = copy.deepcopy(name_list)
    
    mocked_method = mocker.patch.object(
        utils, "func_b", return_value=None, autospec=True
    )
    func_a(name_list=name_list, name="astral1020")
    mocked_method.assert_called_once_with(name_list=original_list)

2. 修改unittest.mock实现（不推荐）

理论上可以修改unittest.mock的_increment_mock_call方法，在记录调用参数时使用深拷贝：

def _increment_mock_call(self, /, *args, **kwargs):
    self.called = True
    self.call_count += 1
    _call = _Call((copy.deepcopy(args), copy.deepcopy(kwargs)), two=True)
    self.call_args = _call
    self.call_args_list.append(_call)

但这种做法不推荐，因为：

1. 需要修改Python标准库代码
2. 深拷贝可能带来性能开销
3. 某些情况下可能需要保持引用而非副本

3. 使用不可变对象

如果业务逻辑允许，可以将可变参数转换为不可变对象：

def func_a(name_list: tuple[str, ...], name: str):
    utils.func_b(list(name_list))  # 临时转换为列表
    # ...其他操作

最佳实践

1. 在测试中，对于可能被修改的可变参数，总是使用深拷贝保存期望值
2. 考虑在业务代码中使用不可变对象作为参数，减少副作用
3. 编写测试时注意区分"参数调用时的值"和"参数当前值"
4. 对于复杂对象，可以使用专门的测试辅助类来管理期望值

总结

pytest-mock/unittest.mock的这种行为是Python语言特性的直接体现，理解这一点对于编写可靠的单元测试非常重要。在测试涉及可变参数的函数调用时，开发者需要特别注意参数对象可能被修改的情况，采取适当的防护措施确保测试的准确性。