python - 在 autospeccing 时模拟 side_effect 为函数提供额外的参数

Question

因此示例代码非常基础:

@mock.patch.object(BookForm, 'is_valid')
def test_edit(self, mocked_is_valid):
    create_superuser()
    self.client.login(username="test", password="test")

    book = Book()
    book.save()

    mocked_is_valid.side_effect = lambda: True

    self.client.post(reverse('edit', args=[book.pk]), {})

这很好用。但是将 autospec 关键字添加到模拟中:

@mock.patch.object(BookForm, 'is_valid', autospec=True)

导致将附加参数传递给可调用的 side_effect，这显然会导致错误:

TypeError: <lambda>() takes 0 positional arguments but 1 was given

我不明白的是为什么 autospeccing 给出了额外的论据。我读过 docs , 但仍然找不到这种行为的解释。

理论上是这样写的

In addition mocked functions / methods have the same call signature as the original so they raise a TypeError if they are called incorrectly.

所以它没问题(is_valid 有 self 参数，这可能是这里传递的内容)，但另一方面它也写了关于 side_effect 那个

The function is called with the same arguments as the mock, and unless it returns DEFAULT, the return value of this function is used as the return value.

据我所知，即使没有自动指定，也应该使用 self 参数调用 side_effect。但事实并非如此。

is called with the same arguments as the mock

if form.is_valid():  # the mock is_valid is called with the self argument, isn't it?

因此，如果有人可以向我解释，最好是引用文档，我将不胜感激。

Answer 1

您误解了文档。没有autospec , side_effect在不检查原始声明的情况下，被调用的是字面意思。让我们创建一个更好的最小示例来演示此问题。

class Book(object):
    def __init__(self):
        self.valid = False
    def save(self):
        self.pk = 'saved'
    def make_valid(self):
        self.valid = True

class BookForm(object):
    def __init__(self, book):
        self.book = book
    def is_valid(self):
        return self.book.valid

class Client(object):
    def __init__(self, book):
        self.form = BookForm(book)
    def post(self):
        if self.form.is_valid() is True:  # to avoid sentinel value
            print('Book is valid')
        else:
            print('Book is invalid')

现在您的原始测试应该与一些调整大致相同

@mock.patch.object(BookForm, 'is_valid')
def test_edit(mocked_is_valid):
    book = Book()
    book.save()
    client = Client(book)
    mocked_is_valid.side_effect = lambda: True
    client.post()

按原样运行测试将导致 Book is valid被打印到标准输出，即使我们还没有完成将 Book.valid 标志设置为 true 的过程，因为 self.form.is_valid正在调用 Client.post被调用的 lambda 替换。我们可以通过调试器看到这一点:

> /usr/lib/python3.4/unittest/mock.py(962)_mock_call()
-> ret_val = effect(*args, **kwargs)
(Pdb) pp effect
<function test_edit.<locals>.<lambda> at 0x7f021dee6730>
(Pdb) bt
...
  /tmp/test.py(20)post()
-> if self.form.is_valid():
  /usr/lib/python3.4/unittest/mock.py(896)__call__()
-> return _mock_self._mock_call(*args, **kwargs)
  /usr/lib/python3.4/unittest/mock.py(962)_mock_call()
-> ret_val = effect(*args, **kwargs)

也在Client.post的框架内方法调用，它不是绑定(bind)方法(我们稍后再讲)

(Pdb) self.form.is_valid
<MagicMock name='is_valid' id='140554947029032'>

嗯，我们这里可能有问题:side_effect字面上可以是任何可能与现实不同的可调用对象，在我们的例子中是 is_valid函数签名(即参数列表)可能与我们提供的模拟不同。如果BookForm.is_valid怎么办？方法被修改为接受一个额外的参数:

class BookForm(object):
    def __init__(self, book):
        self.book = book
    def is_valid(self, authcode):
        return authcode > 0 and self.book.valid

重新运行我们的测试...您将看到我们的测试通过，即使Client.post还在打电话BookForm.is_valid 没有任何参数。即使您的测试通过了，您的产品在生产中也会失败。这就是为什么 autospec参数被引入，我们将在我们的第二个测试中应用它，而不用通过 side_effect 替换可调用对象:

@mock.patch.object(BookForm, 'is_valid', autospec=True)
def test_edit_autospec(mocked_is_valid):
    book = Book()
    book.save()
    client = Client(book)
    client.post()

现在调用函数时会发生这种情况

Traceback (most recent call last):
  ...
  File "/tmp/test.py", line 49, in test_edit_autospec
    client.post()
  File "/tmp/test.py", line 20, in post
    if self.form.is_valid():
  ...
  File "/usr/lib/python3.4/inspect.py", line 2571, in _bind
    raise TypeError(msg) from None
TypeError: 'authcode' parameter lacking default value

什么是你想要什么autospec打算提供 - 在调用模拟之前进行检查，并且

In addition mocked functions / methods have the same call signature as the original so they raise a TypeError if they are called incorrectly.

所以我们必须修复 Client.post通过提供大于 0 的授权码的方法.

    def post(self):
        if self.form.is_valid(123) is True:
            print('Book is valid')
        else:
            print('Book is invalid')

因为我们的测试没有模拟 is_valid通过 side_effect 运行可调用，该方法最终将打印 Book is invalid .

现在如果我们想提供 side_effect , 它必须匹配相同的签名

@mock.patch.object(BookForm, 'is_valid', autospec=True)
def test_edit_autospec(mocked_is_valid):
    book = Book()
    book.save()
    client = Client(book)
    mocked_is_valid.side_effect = lambda self, authcode: True
    client.post()

Book is valid现在将再次打印。通过调试器检查 autospec 'd 和 mock is_valid Client.post 框架内的对象方法调用

(Pdb) self.form.is_valid
<bound method BookForm.is_valid of <__main__.BookForm object at 0x7fd57f43dc88>>

啊，不知何故方法签名不是简单的MagicMock对象(回想一下前面提到的 <MagicMock name='is_valid' id='140554947029032'>)并且是一个正确绑定(bind)的方法，这意味着 self参数现在被传递到模拟中，解决了这个问题:

side_effect: A function to be called whenever the Mock is called. See the side_effect attribute. Useful for raising exceptions or dynamically changing return values. The function is called with the same arguments as the mock...

在这种情况下，“与 mock 相同的参数”意味着与传递给 mock 的任何内容相同。重申一下，第一种情况 self.form.is_valid被一个裸露的、无界的可调用对象所取代，所以 self从未通过；在第二种情况下，可调用对象现在绑定(bind)到 self , self和 authcode将被传递到 side_effect可调用 - 就像在真实调用中会发生的一样。这应该可以调和人们认为与 autospec=True 交互的不当行为。对于 mock.patch.object并手动定义 side_effect可调用模拟。