Python单元测试：如何正确使用unittest.mock.patch的new和side_effect？

2024-07-22 22:15:35

Python unittest.mock.patch：深入理解 new 和 side_effect 的使用

在 Python 单元测试中，我们常常需要模拟外部依赖项的行为，例如数据库连接、API 调用等。unittest.mock.patch 正是这样一个强大的工具，它允许我们替换函数或对象的行为，从而隔离测试目标，提高测试效率。然而，patch 的 new 和 side_effect 参数经常让开发者感到困惑。本文将深入探讨这两个参数的使用方法，并结合实际案例分析它们的区别和适用场景，帮助您编写更加精准有效的单元测试。

场景引入：测试函数与 API 交互

假设我们正在开发一个天气预报应用程序，其中一个函数 get_weather 负责调用外部 API 获取天气数据并进行处理。

import requests

def get_weather(city):
    api_key = "your_api_key"
    url = f"https://api.openweathermap.org/data/2.5/weather?q={city}&appid={api_key}"
    response = requests.get(url)
    data = response.json()
    return data.get("main", {}).get("temp")

在测试 get_weather 函数时，我们不希望真的发送网络请求，因为这会引入外部依赖，使测试变得缓慢且不稳定。这时，unittest.mock.patch 就派上用场了。

new 参数：替换目标对象

new 参数用于指定一个新的对象来替换 patch 指定的目标对象。这个新的对象可以是一个值、一个函数或者一个 Mock 对象。

from unittest.mock import patch

@patch("test_module.requests.get")
def test_get_weather_with_patch_new(mock_get):
    mock_get.return_value = Mock(ok=True, json=lambda: {"main": {"temp": 298.15}})
    temperature = get_weather("London")
    assert temperature == 298.15

在这个例子中，我们使用了 patch 将 test_module.requests.get 替换成一个 Mock 对象。Mock 对象是一个强大的工具，它可以模拟任何 Python 对象的行为。我们设置 mock_get.return_value，使其返回一个模拟的响应对象，该对象包含预设的天气数据。这样一来，get_weather 函数就不会发送真实的 API 请求，而是直接使用我们提供的模拟数据。

side_effect 参数：模拟函数副作用

side_effect 参数允许我们定义函数被调用时的副作用。副作用可以是返回值、异常或者其他任何我们想要执行的代码。

from unittest.mock import patch

@patch("test_module.requests.get")
def test_get_weather_with_patch_side_effect(mock_get):
    mock_get.side_effect = lambda url: Mock(ok=True, json=lambda: {"main": {"temp": 298.15}})
    temperature = get_weather("London")
    assert temperature == 298.15

在这个例子中，我们使用 side_effect 参数将 test_module.requests.get 的行为替换成一个 lambda 函数。该函数接受一个参数 url，并返回一个模拟的响应对象，该对象包含预设的天气数据。

new vs side_effect：何时使用？

当我们需要完全替换目标对象的行为时，可以使用 new 参数。例如，模拟数据库连接、配置对象等。
当我们需要模拟函数的副作用，例如根据不同的输入返回不同的结果、抛出异常等，可以使用 side_effect 参数。

案例分析：处理 API 请求异常

在实际开发中，API 请求可能会出现各种异常情况，例如网络连接失败、服务器错误等。我们可以使用 side_effect 参数模拟这些异常情况，以测试我们的代码在异常情况下的行为。

from unittest.mock import patch
import requests

@patch("test_module.requests.get")
def test_get_weather_with_api_error(mock_get):
    mock_get.side_effect = requests.exceptions.Timeout
    temperature = get_weather("London")
    assert temperature is None

在这个例子中，我们将 test_module.requests.get 的副作用设置为 requests.exceptions.Timeout，这意味着每次调用 requests.get 都会抛出一个超时异常。

常见问题解答

patch 的作用域是什么？

patch 的作用域默认是函数级别。这意味着 patch 只会影响被装饰的函数或方法内部的代码。如果需要在类级别或模块级别进行模拟，可以使用 patch.object 或 patch 的 @classmethod 和 @patch 装饰器。
如何模拟多个函数或对象？

可以使用嵌套的 patch 装饰器，或者使用 patch.multiple 方法。
如何访问被模拟的函数或对象？

patch 装饰器会将被模拟的函数或对象作为参数传递给测试函数。
如何模拟实例方法？

可以使用 patch.object 方法，并将 new 或 side_effect 参数传递给它。
如何测试函数是否被调用？

可以使用 Mock 对象的 assert_called、assert_called_once、assert_called_with 等方法。