Python mock 方法如何模拟函数返回值？

Question

在使用 Python 的 `unittest.mock` 进行单元测试时，如何正确使用 `mock` 方法模拟函数的返回值？ 实际开发中，我们常需要对某些函数进行打桩（stub），使其返回预设值，以隔离外部依赖。然而，许多开发者在使用 `patch` 和 `return_value` 时容易出错，例如作用域不正确、未正确绑定方法、或在类方法中模拟时未处理 `self` 参数。 请结合示例说明，如何使用 `@patch` 装饰器或 `patch` 上下文管理器，准确地模拟一个函数或方法的返回值，并确保测试中调用该函数时获得预期结果。

Answer 1

使用 Python 的 unittest.mock 正确模拟函数返回值的深度解析

在单元测试中，隔离外部依赖是保证测试稳定性和可重复性的关键。Python 的 unittest.mock 模块提供了强大的工具，如 patch 和 Mock，可以用于模拟函数、方法、类等的行为。本文将从基础使用到进阶技巧，逐步讲解如何正确使用 mock 方法模拟函数的返回值。

1. 基本概念与使用方式

patch 是 unittest.mock 提供的核心函数之一，用于临时替换模块中的对象。它可以通过装饰器或上下文管理器的方式使用。

• @patch('module.path.function_name', return_value=value)：装饰器方式
• with patch('module.path.function_name', return_value=value):：上下文管理器方式

示例代码如下：

from unittest.mock import patch
import mymodule

@patch('mymodule.add', return_value=10)
def test_add(mock_add):
    result = mymodule.add(2, 3)
    assert result == 10

注意：测试函数中必须显式接收 mock_add 参数，否则会报错。

2. 理解 mock 的作用域与导入路径

使用 patch 时，必须确保路径是“被测试代码中导入的位置”，而非函数定义的位置。

例如，假设 mymodule.py 中导入了 requests.get：

# mymodule.py
import requests

def fetch_data(url):
    response = requests.get(url)
    return response.json()

在测试中应 mock mymodule.requests.get，而不是 requests.get：

@patch('mymodule.requests.get')
def test_fetch_data(mock_get):
    mock_get.return_value.json.return_value = {'status': 'ok'}
    result = mymodule.fetch_data('http://example.com')
    assert result == {'status': 'ok'}

3. 使用上下文管理器实现更灵活的 mock

当需要在特定代码块中 mock 某个函数时，可以使用上下文管理器：

def test_with_context_manager():
    with patch('mymodule.multiply', return_value=20):
        result = mymodule.multiply(2, 3)
        assert result == 20

上下文管理器适用于 setup/teardown 场景或需动态控制 mock 的生命周期。

4. 模拟类方法与处理 self 参数

当 mock 类方法时，需注意实例方法的第一个参数是 self，mock 的返回值应忽略该参数。

示例：

class Calculator:
    def add(self, a, b):
        return a + b

@patch.object(Calculator, 'add', return_value=100)
def test_calculator_add(mock_add):
    calc = Calculator()
    result = calc.add(1, 2)
    assert result == 100

注意：使用 @patch.object 可直接 mock 类或实例的方法。

5. 高级用法：动态返回值与副作用

有时需要根据输入参数返回不同的值，可使用 side_effect：

def side_effect(a, b):
    if a < 0:
        return "negative"
    return a + b

@patch('mymodule.add', side_effect=side_effect)
def test_side_effect(mock_add):
    assert mymodule.add(2, 3) == 5
    assert mymodule.add(-1, 3) == "negative"

此外，也可以传入异常作为副作用，用于测试异常分支。