Python Mock Patch 类中的多个方法

Question

我试图修补一个类中的多个方法。 这是我的简化设置

Hook.py 定义为

class Hook():
    def get_key(self):
        return "Key"

    def get_value(self):
        return "Value"

HookTransfer.py 定义为

from Hook import Hook

class HookTransfer():
    def execute(self):
        self.hook = Hook()
        key = self.hook.get_key()
        value = self.hook.get_value()
        print(key)
        print(value)

我想模拟 Hook 类中的 get_key 和 get_value 方法。 以下作品即打印 New_Key 和 New_Value

from HookTransfer import HookTransfer
import unittest
from unittest import mock

class TestMock(unittest.TestCase):
    @mock.patch('HookTransfer.Hook.get_key', return_value="New_Key")
    @mock.patch('HookTransfer.Hook.get_value', return_value="New_Value")
    def test_execute1(self, mock_get_key, mock_get_value):
        HookTransfer().execute()

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

然而这并没有。 它打印<MagicMock name='Hook().get_key()' id='4317706896'>和<MagicMock name='Hook().get_value()' id='4317826128'>

from HookTransfer import HookTransfer
import unittest
from unittest import mock

class TestMock(unittest.TestCase):
    @mock.patch('HookTransfer.Hook', spec=True)
    def test_execute2(self, mock_hook):
        mock_hook.get_key = mock.Mock(return_value="New_Key")
        mock_hook.get_value = mock.Mock(return_value="New_Value")
        HookTransfer().execute()

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

直觉上，似乎第二个也应该工作，但事实并非如此。 你能帮助解释为什么它没有。 我怀疑它与“在哪里修补”有关，但我无法弄清楚。

Answer 1

您可以使用patch.multiple()修补模块或类的多个方法。 这样的事情应该适用于您的情况：

import unittest
from unittest.mock import MagicMock, patch

class TestMock(unittest.TestCase):
    @patch.multiple('HookTransfer.Hook',
                    get_key=MagicMock(return_value='New_Key'),
                    get_value=MagicMock(return_value='New_Value'))
    def test_execute1(self, **mocks):
        HookTransfer().execute()

当patch.multiple()作为装饰器使用时，mocks通过关键字传递给被装饰的函数，当它作为上下文管理器使用时返回一个字典。

Answer 2

你需要的是：

模拟 Hook 类，

from HookTransfer import HookTransfer
from Hook import Hook

import unittest
try:
    import mock
except ImportError:
    from unittest import mock

class TestMock(unittest.TestCase):
    @mock.patch.object(Hook, 'get_key', return_value="New_Key")
    @mock.patch.object(Hook, 'get_value', return_value="New_Value")
    def test_execute1(self, mock_get_key, mock_get_value):
        HookTransfer().execute()

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

Answer 3

经过一些测试，我能够找到问题所在。

在第二个测试用例中，补丁装饰器创建一个 Mock 类的新实例，并通过 mock_hook 参数将其传递给 test_execute2 函数。 让我们将其称为 mock1。 mock1 替换了 HookTransfer.py 中的 Hook 类。 当self.hook = Hook()运行时，它转换为调用 mock1 的__init__ 。 按照设计，这会返回另一个 Mock 实例 - 让我们将其称为 mock2。 所以self.hook指向mock2。 但是mock_hook.get_key = mock.Mock(return_value="New_Key") ，mock1 中的方法。

为了正确模拟，mock2 需要打补丁。 这可以通过两种方式完成

1. 通过模拟mock1的return_value（返回mock2） mock_hook.return_value.get_key = mock.Mock(return_value="New_Key")
2. 模拟mock1（返回mock2）的构造函数的返回值mock_hook().get_key = mock.Mock(return_value="New_Key")

在幕后，这两个选项确实做同样的事情。