在 Python 单元测试中，unittest.mock（简称 Mock 库）是一个非常有用的工具，用于模拟依赖项，尤其是那些在测试环境中不易控制或不需要真正执行的依赖。例如，模拟网络请求、数据库连接或某些函数调用的返回值等。
以下是使用 Mock 库进行依赖模拟的基本步骤和示例。
1. Mock 和 patch 的基础使用
Mock 对象可以模拟 Python 的任何对象。patch 是一个装饰器或上下文管理器，用于替换某个对象或类，使其在测试中可以被替换为 Mock 对象。
示例 1：模拟函数的返回值
假设我们有一个函数 get_data，它从外部 API 获取数据。我们希望在测试时不实际调用外部 API，而是使用模拟数据。
# example.py
import requestsdef get_data(url):response = requests.get(url)return response.json()
为了测试这个函数，我们可以使用 Mock 库来模拟 requests.get 的行为。
# test_example.py
import unittest
from unittest.mock import patch
from example import get_dataclass TestGetData(unittest.TestCase):@patch('example.requests.get') # 模拟 example 模块中的 requests.get 方法def test_get_data(self, mock_get):# 配置模拟对象的返回值mock_get.return_value.json.return_value = {'key': 'value'}result = get_data('http://fakeurl.com')# 断言模拟返回值是否符合预期self.assertEqual(result, {'key': 'value'})# 断言 requests.get 被调用了一次mock_get.assert_called_once_with('http://fakeurl.com')if __name__ == '__main__':unittest.main()
在这个示例中：
- 使用
@patch装饰器模拟requests.get方法。 mock_get是patch传递给测试方法的模拟对象。mock_get.return_value.json.return_value配置了requests.get().json()的返回值。- 测试用例中，我们断言返回值是否符合预期，并验证
requests.get是否被正确调用。
2. 使用 patch 的不同方式
patch 可以作为装饰器，也可以作为上下文管理器使用。
作为上下文管理器
# test_example.py
import unittest
from unittest.mock import patch
from example import get_dataclass TestGetData(unittest.TestCase):def test_get_data(self):with patch('example.requests.get') as mock_get:# 配置模拟对象的返回值mock_get.return_value.json.return_value = {'key': 'value'}result = get_data('http://fakeurl.com')# 断言模拟返回值是否符合预期self.assertEqual(result, {'key': 'value'})# 断言 requests.get 被调用了一次mock_get.assert_called_once_with('http://fakeurl.com')if __name__ == '__main__':unittest.main()
3. 模拟类和对象的行为
有时我们需要模拟类的实例及其方法。在这种情况下，我们可以使用 patch.object。
示例 2：模拟类方法
假设有一个类 DataFetcher，其中的方法 fetch 从外部 API 获取数据。
# example.py
import requestsclass DataFetcher:def fetch(self, url):response = requests.get(url)return response.json()
在测试中，我们想要模拟 fetch 方法的行为。
# test_example.py
import unittest
from unittest.mock import patch
from example import DataFetcherclass TestDataFetcher(unittest.TestCase):@patch.object(DataFetcher, 'fetch') # 模拟 DataFetcher 类中的 fetch 方法def test_fetch(self, mock_fetch):# 配置模拟对象的返回值mock_fetch.return_value = {'key': 'value'}fetcher = DataFetcher()result = fetcher.fetch('http://fakeurl.com')# 断言模拟返回值是否符合预期self.assertEqual(result, {'key': 'value'})# 断言 fetch 方法被调用了一次mock_fetch.assert_called_once_with('http://fakeurl.com')if __name__ == '__main__':unittest.main()
4. 总结
Mock对象：用于模拟函数、方法、类或模块的行为。patch和patch.object：用于动态替换测试中的对象，提供更精确的控制。- 配置返回值和断言调用：通过设置
return_value、side_effect等属性，可以灵活地模拟对象的行为，并使用assert_called_once_with等方法验证函数的调用。
这些技巧能够帮助你在单元测试中模拟依赖项，使你的测试更加稳定和快速。
