Python mock：包装实例方法答案

【问题标题】：Python mock: wrap instance methodPython mock：包装实例方法
【发布时间】：2017-06-26 20:51:50
【问题描述】：

我想要什么： 确保在with 语句中创建的所有Foo 实例都将其foo 实例方法通过wraps=Foo.foo 包装在MagicMock 中。我想要这样做的原因是，我可以在 foo 方法上跟踪 call_count 创建的所有 Foo 实例。既然这么说，好像有点不可能……

>>> from mock import patch
...
... class Foo(object):
...
...     def foo(self):
...         return "foo"
...
... with patch("__main__.Foo.foo", wraps=Foo.foo) as m:
...     foo = Foo()
...     print(foo.foo())

Traceback (most recent call last):
  File "a.py", line 12, in <module>
    print(foo.foo())
  File "/disk/software/lib/python27/mock/mock.py", line 1062, in __call__
    return _mock_self._mock_call(*args, **kwargs)
  File "/disk/software/lib/python27/mock/mock.py", line 1132, in _mock_call
    return self._mock_wraps(*args, **kwargs)
TypeError: unbound method foo() must be called with Foo instance as first argument (got nothing instead)

问题模拟的foo 方法没有绑定到通过foo = Foo() 创建的foo 实例，因为它包装了未绑定的方法Foo.foo。有谁知道如何确保模拟方法绑定到实例？

我已经知道的：

>>> foo = Foo()
... with patch.object(foo, "foo", wraps=foo.foo) as m:
...     print(foo.foo())
"foo"

但这不满足我的约束，即对象必须在 patch 上下文中实例化。

【问题讨论】：

这是一个可行的方法，但它使用 try..finally 而不是模拟库：stackoverflow.com/questions/45584656/…
我只花了几个小时试图解决同样的问题。你有没有发现有用的东西？ @guettli 的建议仍然依赖于处理实例，所以如果我的测试没有直接创建实例，它就没有帮助。
@Colin 在下面写了一个比较简单的解决方案。

标签： python-2.7 python-mock

【解决方案1】：

上面我提出的和不正确的解决方案的问题

with patch("__main__.Foo.foo", wraps=Foo.foo) as m:
    ...

是Foo上的foo方法被mock了，以至于它包裹了未绑定的方法Foo.foo，这自然是行不通的，因为未绑定的方法Foo.foo不知道它何时附加到哪个实例稍后调用。

我能想到的最简单的解决方案

from mock import patch, MagicMock

class Foo:

    def foo(self):
        return "foo"

class MockFoo(Foo):

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # Every instance of MockFoo will now have its `foo` method 
        # wrapped in a MagicMock
        self.foo = MagicMock(wraps=self.foo)

with patch("__main__.Foo", MockFoo) as m:
    foo = Foo()
    print(foo.foo())
    assert foo.foo.call_count == 1

【讨论】：

我已经解决了这个问题，但是这个解决方案非常有趣！我会试一试！感谢@Filip Kilibarda 的想法！
您仍然需要该实例。这与 OP 代码有何不同？
@nitely 是的，您仍然需要实例来检查call_count，但您不需要实例来应用补丁。这在类在被测代码深处实例化并且实例返回到测试代码的情况下很有用。当返回到测试代码时，测试可以检查那个特定实例的call_count。如果您想在不访问实例本身的情况下跟踪补丁块中所有实例的总和 call_count，那么这不是您的解决方案。

【解决方案2】：

这对 Python 模拟来说太糟糕了，所以我最终构建了一个自定义补丁实现（如果需要，可以使用其他功能进行扩展）。

import contextlib

class Patcher:
    UNCHANGED_RET = object()

    def __init__(self):
        self.call_count = 0
        self.return_value = Patcher.UNCHANGED_RET


@contextlib.contextmanager
def patch(klass, method_name):
    patcher = Patcher()
    orig_method = getattr(klass, method_name)

    def new_method(myself, *args, **kwargs):
        patcher.call_count += 1
        orig_return_value = orig_method(myself, *args, **kwargs)

        if patcher.return_value != Patcher.UNCHANGED_RET:
            return patcher.return_value

        return orig_return_value

    setattr(klass, method_name, new_method)
    yield patcher
    setattr(klass, method_name, orig_method)

如下使用：

class MyClass:
    def f(self):
        return 42


x = MyClass()
with patch(MyClass, 'f') as f_patcher:
    y = MyClass()  # inside or outside -- does not matter
    assert x.f() == 42
    assert f_patcher.call_count == 1
    f_patcher.return_value = 7
    assert y.f() == 7
    assert f_patcher.call_count == 2

【讨论】：