Python中的Stubber()用法及示例

在Python中，Stubber是unittest模块中的一个类，用于创建一个可以模拟或替代其他对象功能的对象。

Stubber类提供了一些方法，可以用来创建一个虚拟对象，并对其方法进行打桩（stubbing），即指定返回值或行为。 Stubber对象可以在测试中使用，以模拟一些行为或确保某些方法被调用。

下面是Stubber类主要的方法：

- add_method(method, value)：给虚拟对象添加一个方法，并指定其返回值为value。

- add_methods(**methods)：给虚拟对象添加多个方法，并指定其返回值。

- add_mock(mock_obj)：添加一个Mock对象来代替真实对象。

- active()：开启Stubber对象，模拟下一个被调用的方法。

- deactivate()：关闭Stubber对象。

- reset_mock()：重置模拟对象的状态。

- reset()：重置Stubber对象并清除所有添加的方法和行为。

下面是一个示例，演示了如何使用Stubber类：

import unittest
from unittest.mock import Stubber

class SomeClass:
    def method1(self):
        return 5
    
    def method2(self, x, y):
        return x + y

class TestSomeClass(unittest.TestCase):
    def test_stubbing(self):
        obj = SomeClass()
        with Stubber(obj) as stubber:
            stubber.add_method('method1', 10)
            stubber.add_mock(obj)
            stubber.active()
            self.assertEqual(obj.method1(), 10)  # 方法1已被替换为返回10
            self.assertEqual(obj.method2(2, 3), 5)  # 方法2保持不变
            self.assertEqual(obj.method3(), None)  # 方法3不存在，返回None
            stubber.deactivate()
            self.assertEqual(obj.method1(), 5)  # 恢复原始的方法1行为
    
    def test_reset_mock(self):
        obj = SomeClass()
        with Stubber(obj) as stubber:
            stubber.add_method('method1', 10)
            stubber.add_method('method2', 20)
            stubber.active()
            self.assertEqual(obj.method1(), 10)
            self.assertEqual(obj.method2(2, 3), 20)
            stubber.reset_mock()
            self.assertEqual(obj.method1(), 5)  # 恢复原始的方法1行为
            self.assertEqual(obj.method2(2, 3), 5)  # 恢复原始的方法2行为

if __name__ == '__main__':
    unittest.main()

在示例中我们定义了一个SomeClass类，包含两个方法method1和method2。我们使用Stubber对象来模拟SomeClass对象，并对其方法进行打桩。在test_stubbing方法中，我们首先创建了一个SomeClass的实例obj，并将其传给Stubber对象。然后通过add_method方法给obj添加了一个新的方法method1，并指定其返回值为10。接着，我们将obj本身作为一个Mock对象添加到Stubber中，使得obj的所有方法都被模拟。最后，通过active方法开启Stubber对象，从而模拟下一个被调用的方法。在测试中，我们可以通过obj调用被打桩的方法并验证其返回值。

在test_reset_mock方法中，我们首先使用Stubber对象对obj的两个方法进行了打桩，然后通过active方法开启Stubber对象。接着，我们通过obj调用被打桩的方法，并验证其返回值。最后，通过reset_mock方法重置了obj的状态，回到了原始的方法行为。

通过使用Stubber类，我们可以在测试中对某些方法进行模拟，以确保特定的行为或验证方法的调用。这对于编写单元测试和集成测试非常有用，尤其是当某些方法依赖于其他类或外部资源时。