python - 什么时候应该将 `autospec=True` 与模拟库一起使用？

Question

在使用 mock.patch 及其变体时，我什么时候应该使用 autospec=True？

一方面，this article警告我们始终使用 autospec=True:

... you should always use the create_autospec method and the autospec parameter with the @patch and @patch.object decorators.

另一方面，autospec 有严重的缺点和限制，正如 idjaw 对 this question 的回答中所解释的那样.

所以我的问题是:什么时候应该使用autospec=True或create_autospec，什么时候不应该使用它？

我担心不使用 autospec 可能会导致测试在真正应该中断时却没有中断，如上述文章中所述。然而 autospec 有其缺点。我该如何操作？

Answer 1

我能理解建议强制使用 autospec 的动机。

也许以下内容可以帮助您更清楚地了解使用 autospec 可以得到什么，不能得到什么。

简而言之，使用 autospec 可确保您在模拟中使用的属性实际上是您正在模拟的类的一部分。

因此，通过下面的示例，我将说明在技术上您可能不希望测试通过时如何通过:

以我们将测试的这个简单示例为例:

class Foo:
    def __init__(self, x):
        self.x = x

class Bar:
    def __init__(self):
        self.y = 4
        self.c = Foo('potato')

和测试代码:

class TestAutoSpec(unittest.TestCase):
    @patch('some_module.Foo')
    def test_autospec(self, mock_foo_class):
        mock_foo_obj = mock_foo_class.return_value

        bar_obj = some_module.Bar()

        self.assertTrue(hasattr(bar_obj.c, 'you_should_fail'))

现在，如果您回头看看 Foo 类，您会清楚地看到 you_should_fail 显然不是 Foo 中的属性。但是，如果您运行此测试代码，它实际上会通过。这是非常具有误导性的。

这是因为如果 MagicMock 中不存在某个属性，它仍然是 MagicMock 类型。如果你在那个测试中打印 type(bar_obj.c.you_should_fail)，你最终会得到:

<class 'unittest.mock.MagicMock'>

这肯定会导致 hasattr 测试通过。如果您再次运行上述测试，除了将您的补丁更改为:@patch('some_module.Foo', autospec=True)，它将失败。

现在，要为此编写一个成功的测试并仍然使用 autospec=True，您只需根据需要在模拟测试中创建该属性。请记住，之所以需要这样做，是因为 autospec 无法知道动态创建的属性，即在创建实例时在 __init__ 中创建的属性。

因此，autospec 的方法是:

class TestAutoSpec(unittest.TestCase):

    @patch('some_module.Foo', autospec=True)
    def test_autospec(self, mock_foo_class):
        mock_foo_obj = mock_foo_class.return_value

        # create the attribute you need from mocked Foo
        mock_foo_obj.x = "potato"

        bar_obj = some_module.Bar()

        self.assertEqual(bar_obj.c.x, 'potato')
        self.assertFalse(hasattr(bar_obj.c, 'poof'))

现在，您的测试将成功通过验证您的 x 属性，同时还验证您没有一些在您的真实 Foo 中不存在的虚假属性类(class)。

这也是 Martijn Pieters 的另一种解释，不一定直接回答您的问题，但提供了一个很好的示例和使用 autospec 的解释，可以帮助您加深理解:

https://stackoverflow.com/a/31710001/1832539