Python 使用unittest.mock.patch时，为什么autospec默认值不是True

在本文中，我们将介绍Python中的mock模块，其中的unittest.mock.patch装饰器以及为什么在使用patch时autospec的默认值不是True。

什么是mock模块？

Mock是Python中一个非常有用的模块，它允许我们在测试过程中模拟和替代特定对象的行为。使用mock，我们可以通过创建一个虚拟对象来替代真实对象，然后定义这个虚拟对象的属性和方法的行为，以便在测试中模拟各种情况。

unittest.mock.patch装饰器

unittest.mock模块中的patch装饰器是一种方便的方法，用于在测试中将真实对象替换为虚拟对象。当我们需要替换某个对象的行为时，可以使用patch装饰器来创建一个临时的虚拟对象，然后在测试结束后自动将其还原回去。

patch装饰器接受一个参数，即需要替换的对象的路径。通常我们会使用字符串的形式传递对象的路径，例如：”package.module.ClassName”。在测试函数运行期间，patch将临时替换掉该路径指向的对象，并将其替换为一个mock对象。

autospec参数的作用和默认值

在使用patch时，我们可以为autospec参数传递一个布尔值，用于控制mock对象的属性和方法是否自动与真实对象保持一致。当autospec为True时，mock对象的属性和方法将从真实对象中进行复制，以保证二者行为的一致性。如果autospec为False或者没有提供该参数，则mock对象不会自动继承真实对象的特性。

那么为什么autospec的默认值不是True呢？

autospec默认值为False的原因在于，在某些情况下，自动继承真实对象的特性可能会导致测试的不准确或混乱。例如，当我们使用patch替换掉一个类的方法时，如果autospec为True，mock对象将自动继承类的方法签名、参数个数等特性，这可能会导致在测试过程中出现一些预料之外的行为。

举个例子，假设我们有一个Calculator类，其中有一个add方法用于计算两个数的和。如果我们使用patch装饰器替换掉这个类的add方法，而autospec又为True，那么patch将创建一个mock对象，并自动继承add方法的特性。如果我们在测试期间调用该mock对象的add方法时传递了一个额外的参数，这个参数将被mock对象默默地接受而不会引发任何错误。这可能会让我们在测试过程中产生误导，因为在真实对象中调用add方法时传递额外参数会引发TypeError。

同样，如果autospec的默认值为True，那么在我们没有明确设置autospec时，mock对象将自动继承真实对象的特性，这可能会给我们带来一些意料之外的结果。因此，默认情况下将autospec设置为False，以确保测试的准确性。

下面是一个展示autospec的默认行为和设置为True的情况的示例。

import unittest
from unittest.mock import patch

class Calculator:
    def add(self, a, b):
        return a + b

def do_calculation(a, b):
    calc = Calculator()
    return calc.add(a, b)

class TestCalculator(unittest.TestCase):
    @patch('__main__.Calculator')
    def test_add_method_default(self, mock_calculator):
        instance = mock_calculator.return_value
        instance.add.return_value = 5

        result = do_calculation(2, 3)

        self.assertEqual(result, 5)

    @patch('__main__.Calculator', autospec=True)
    def test_add_method_autospec_true(self, mock_calculator):
        instance = mock_calculator.return_value
        instance.add.return_value = 5

        with self.assertRaises(TypeError):
            result = do_calculation(2, 3, 4)

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

在上面的示例中，我们定义了一个Calculator类，其中有一个add方法用于计算两个数的和。在test_add_method_default方法中，我们使用patch装饰器替换了Calculator类，并且没有设置autospec参数，默认为False。在这个测试中，我们预期调用do_calculation函数时能正确地返回计算结果5。

而在test_add_method_autospec_true方法中，我们显式地将autospec参数设置为True。在这个测试中，我们预期调用do_calculation函数时，如果传入了额外的参数4，将会触发TypeError，并抛出异常。

总结

在本文中，我们介绍了Python中的mock模块和unittest.mock.patch装饰器，以及为什么在使用patch时autospec的默认值不是True。autospec参数可以控制mock对象是否自动继承真实对象的特性，默认设置为False，以确保测试的准确性。当autospec为True时，mock对象将自动继承真实对象的属性和方法，这可能导致在测试过程中产生一些意料之外的结果。

通过理解和灵活使用autospec参数，我们可以更好地利用mock模块进行单元测试，并确保测试用例的准确性和可靠性。