python | Python mock对象与测试替身

本文来源公众号“python”，仅用于学术分享，侵权删，干货满满。

原文链接：Python mock对象与测试替身

在软件开发中，单元测试是一项不可或缺的工作。它能够验证代码的正确性，提升代码的可维护性。在实际测试中，可能会遇到一些无法直接测试的情况，例如：

1. 外部依赖（数据库、API）不可用。

2. 方法的调用存在副作用（修改文件、发送网络请求）。

3. 需要隔离测试目标，避免其他模块的影响。

为了解决这些问题，Python 的 unittest.mock 模块提供了功能强大的 Mock 对象，用于替代实际对象或方法，模拟其行为。通过 Mock 对象，开发者可以灵活地创建测试替身，隔离测试环境，捕捉调用行为，并验证交互是否符合预期。本文将详细介绍 Python Mock 对象的核心功能及其应用。

Mock对象的核心概念

Mock 对象是一种动态创建的对象，可以模仿实际对象的行为。它常用于模拟函数、类或模块。

Mock 的核心功能包括：

1. 行为模拟：定义对象方法的返回值或副作用。

2. 调用监控：记录方法调用的参数和次数。

3. 替代依赖：临时替换实际对象，隔离测试环境。

unittest.mock 提供了以下常用工具：

• Mock：基础的 Mock 对象。

• patch：用于动态替换模块中的对象。

• MagicMock：扩展了 Mock，对特殊方法（如 __getitem__）提供支持。

数据准备

以下是一个简单的场景：有一个用于发送邮件的类 EmailSender，它依赖于外部 API 的 send 方法。

# 假设有一个简单的邮件发送类
class EmailSender:
    def __init__(self, api_client):
        self.api_client = api_client

    def send_email(self, recipient, subject, body):
        response = self.api_client.send(recipient, subject, body)
        if response == "success":
            return "Email sent successfully"
        else:
            return "Failed to send email"

在单元测试中，由于 api_client.send 是一个外部依赖，我们需要使用 Mock 对象替代它。

Mock的基本用法

创建Mock对象

Mock 对象可以直接通过 Mock 类创建。默认情况下，Mock 的所有方法和属性都是动态生成的。

from unittest.mock import Mock

# 创建 Mock 对象
mock_api = Mock()

# 模拟方法返回值
mock_api.send.return_value = "success"

# 调用模拟方法
result = mock_api.send("test@example.com", "Subject", "Hello!")
print(result)  # 输出: success

通过 return_value 属性，可以指定模拟方法的返回值。

在测试中使用Mock

以下是为 EmailSender 创建单元测试的示例：

from unittest import TestCase
from unittest.mock import Mock

class TestEmailSender(TestCase):
    def test_send_email_success(self):
        # 创建 Mock 对象
        mock_api = Mock()
        mock_api.send.return_value = "success"

        # 初始化 EmailSender 并传入 Mock 对象
        sender = EmailSender(api_client=mock_api)

        # 调用方法并断言结果
        result = sender.send_email("test@example.com", "Test Subject", "Test Body")
        self.assertEqual(result, "Email sent successfully")

        # 验证 mock 方法被正确调用
        mock_api.send.assert_called_once_with("test@example.com", "Test Subject", "Test Body")

验证方法调用

Mock 对象可以记录方法调用的参数和次数，提供以下验证功能：

• assert_called_once_with：验证方法被调用一次，且参数正确。

• assert_called_with：验证方法被调用过一次，且参数正确。

• assert_not_called：验证方法从未被调用。

mock_api.send.assert_called_once_with("test@example.com", "Test Subject", "Test Body")
mock_api.send.assert_not_called()  # 如果从未调用，则测试通过

使用patch动态替换

patch 是 Mock 的一个高效工具，用于动态替换模块中的对象。在测试范围内，它可以将目标对象替换为 Mock 对象，并在测试结束后自动恢复原始状态。

替换模块中的对象

假设邮件发送功能依赖一个 email_api 模块，可以使用 patch 替换其中的 send 方法。

from unittest.mock import patch

# 假设 email_api 模块有一个 send 方法
import email_api

@patch("email_api.send")
def test_email_send(mock_send):
    # 配置 Mock 对象
    mock_send.return_value = "success"

    # 调用被测试的代码
    result = email_api.send("test@example.com", "Subject", "Hello!")
    assert result == "success"

    # 验证 send 方法被正确调用
    mock_send.assert_called_once_with("test@example.com", "Subject", "Hello!")

通过 patch，可以轻松替换 email_api.send，而无需修改原始代码。

使用patch装饰器和上下文管理

patch 支持装饰器和上下文管理两种使用方式。

装饰器

@patch("email_api.send")
def test_email_send(mock_send):
    mock_send.return_value = "success"
    # 测试代码...

上下文管理

with patch("email_api.send") as mock_send:
    mock_send.return_value = "success"
    # 测试代码...

MagicMock扩展Mock

MagicMock 是 Mock 的一个扩展类，支持特殊方法（如 __getitem__ 和 __call__）的模拟。

from unittest.mock import MagicMock

# 创建 MagicMock 对象
mock_object = MagicMock()

# 模拟列表访问
mock_object.__getitem__.return_value = "mocked item"
print(mock_object[0])  # 输出: mocked item

# 模拟调用
mock_object.return_value = "mocked call"
print(mock_object())  # 输出: mocked call

MagicMock 适用于需要模拟复杂行为或容器对象的场景。

模拟副作用

Mock 对象可以通过 side_effect 模拟方法的副作用，例如引发异常或返回不同值。

# 模拟引发异常
mock_api.send.side_effect = Exception("API Error")

# 模拟返回不同值
mock_api.send.side_effect = ["success", "failure", "success"]
print(mock_api.send())  # 输出: success
print(mock_api.send())  # 输出: failure

总结

Mock 对象是 Python 单元测试中的重要工具，它通过模拟实际对象或方法的行为，帮助开发者隔离测试环境、捕捉交互行为并验证测试目标是否符合预期。本文详细介绍了 Mock 对象的核心功能，包括创建 Mock 对象、动态替换、验证调用以及模拟副作用，并结合实例演示了如何在测试中使用 Mock 对象。

THE END !

文章结束，感谢阅读。您的点赞，收藏，评论是我继续更新的动力。大家有推荐的公众号可以评论区留言，共同学习，一起进步。