如何使用unittest.mock替换类方法、自定义返回值并自动还原
使用
unittest.mock完成方法替换与自动还原的实现方案 核心问题:如何用unittest.mock替换/修改方法返回值
Python 3.3+ 内置的unittest.mock模块提供的patch工具,专门用于完成测试场景下的对象替换,完全可以替代手动存储原方法、手动赋值替换的逻辑。
针对类方法的替换,有两类最常用的写法,无需自行编写模拟函数,可直接指定返回值:
- 使用
patch.object直接引用已导入的类对象,避免路径写错的问题 - 替换时直接传入
return_value参数,绑定需要的模拟返回值,无需单独定义_test_data这类模拟函数
适配现有类初始化逻辑的示例
因为需要在setUpClass阶段完成方法替换后再实例化MyData,可使用以下两种改造方案:
- 手动启停补丁的写法:
import unittest from unittest.mock import patch from mockplay import MyData class MyTest_Sim(unittest.TestCase): @classmethod def setUpClass(cls): # 启动补丁:自动留存原始方法、完成替换 cls.patcher = patch.object( MyData, "_get_default_data", return_value="simulated test data" ) cls.mock_method = cls.patcher.start() # 替换完成后再初始化实例 MyData() @classmethod def tearDownClass(cls): # 仅需调用stop(),自动还原原始方法 cls.patcher.stop() def test_data(self): self.assertEqual(MyData.me.data, "simulated test data") # 可直接验证方法的调用次数、参数 self.mock_method.assert_called_once_with() - 上下文管理器写法(无需编写
setUpClass/tearDownClass):def test_data(self): # 进入with块时自动替换方法 with patch.object( MyData, "_get_default_data", return_value="simulated test data" ) as mock_method: MyData() self.assertEqual(MyData.me.data, "simulated test data") # 退出with块时自动完成还原,无任何手动操作
次要问题:补丁的隐式自动还原机制
unittest.mock.patch的所有使用模式,都内置了完整的自动还原逻辑,彻底解决手动还原容易遗漏的问题:
- 装饰器模式:被装饰的测试方法/类执行结束后,自动执行还原,无需编写任何
tearDown相关代码 - 上下文管理器模式:退出
with代码块时自动触发还原 - 手动start模式:只要调用对应的
stop()方法,就会自动将被替换的对象恢复为补丁应用前的原始实现,无需手动存储原方法、手动赋值回原状态
注意:不要依赖垃圾回收触发的自动还原,按规范调用
stop()或使用上下文管理器/装饰器即可保证还原逻辑稳定执行。
内容的提问来源于stack exchange,提问作者buhtz
相关产品推荐
相关产品推荐

