Mock的autospec将一个错误的参数注入到一个被调用的函数中

时间:2015-01-10 17:01:18

标签: python unit-testing mocking python-mock

我的理解是autospec在这里使用的最简单的形式将检查正在针对所提出的参数进行模拟的函数的签名。其目的是在不匹配时引发错误。在下面的代码中,它似乎注入了一个额外的参数 - 对象本身。为什么使用模拟模块的autospec会导致此处显示的意外行为? 对于这个问题,我在模块simplebutton中创建了一个简化版本。当它作为主要模块运行时,就会打印出“这不是开玩笑”的行。

#module simplebutton
import sys


class _Dialog2:
    def callback(self):
        print("It's no joke")


def main():
    dialog = _Dialog2()
    dialog.callback()


if __name__ == '__main__':
    sys.exit(main())

测试模块test_simplebutton包含两个测试模块。两者都模拟了callback函数。但是,第二项测试包括autospec=True

    @unittest.mock.patch('simplebutton._Dialog2.callback',
                         name='callback', autospec=True)

在此测试中,必须使用dialog参数调用应该不带参数调用的回调函数,否则测试将失败。

编辑: 每个人都知道您不是method(instance)而是instance.method()调用方法。那是我的错。这里需要instance1.method('instance2'),其中instance1是模拟,instance2是包含模拟方法的对象。感谢Michele d'Amico。

        mock_callback.assert_called_once_with(dialog)    

测试套件如下:

#module test_simplebutton
import unittest
import unittest.mock

import simplebutton


class Test_Dialog(unittest.TestCase):

    @unittest.mock.patch('simplebutton._Dialog2.callback',
                         name='callback')
    def test_direct_call_to_callback_by_mocking_1(self, mock_callback):
        dialog = simplebutton._Dialog2()
        dialog.callback()
        mock_callback.assert_called_once_with()

    @unittest.mock.patch('simplebutton._Dialog2.callback',
                         name='callback', autospec=True)
    def test_direct_call_to_callback_by_mocking_2(self, mock_callback):
        dialog = simplebutton._Dialog2()
        dialog.callback()
        mock_callback.assert_called_once_with(dialog)

1 个答案:

答案 0 :(得分:3)

通过autospec=True补丁,用具有相同原始对象签名的模拟替换对象(在您的情况下为方法)。此外,生成的模拟不能扩展:尝试访问不在原始定义中的属性或方法(或在MagicMock()中)将引发异常。

在第一种情况下(没有autospec=True),您正在通过无限制的方法修补绑定方法。当您调用修补方法时,mock_callback被称为函数,而不是dialog对象的绑定方法。

当你在autospec=True装饰器中使用@patch时,它会用新的绑定方法mock_callback替换原来的方法:这就像所有其他绑定方法一样,并且将被self作为第一个参数调用。为了使示例更清楚,我更改了它以更好地解释autospec=True补丁参数的行为。

import unittest
import unittest.mock

import simplebutton

class Test_Dialog(unittest.TestCase):

    @unittest.mock.patch('simplebutton._Dialog2.callback')
    def test_direct_call_to_callback_by_mocking_1(self, mock_callback):
        dialog = simplebutton._Dialog2()
        dialog.callback()
        mock_callback.assert_called_once_with()
        mock_callback.reset_mock()
        simplebutton._Dialog2.callback()
        mock_callback.assert_called_once_with()

    @unittest.mock.patch('simplebutton._Dialog2.callback', autospec=True)
    def test_direct_call_to_callback_by_mocking_2(self, mock_callback):
        dialog = simplebutton._Dialog2()
        dialog.callback()
        mock_callback.assert_called_once_with(dialog)
        self.assertRaises(Exception, simplebutton._Dialog2.callback)

        dialog2 = simplebutton._Dialog2()
        dialog.callback()
        dialog2.callback()
        mock_callback.assert_has_calls([unittest.mock.call(dialog), unittest.mock.call(dialog2)])

在第一个测试中,我们通过_Dialog2.callback()明确调用simplebutton._Dialog2.callback()作为未绑定方法,行为与dialog.callback()完全相同。

在第二个中,如果我们尝试像第一个测试一样将其称为未绑定,则会引发异常。此外,如果我们从两个不同的对象调用该方法,我们将发现对同一个mock的两个不同的调用,我们可以识别它们。

我希望现在可以清楚地了解使用autospec=True参数时会发生什么以及您应该期待什么。