如何在 Python 模块中存根类以进行测试？

Question

我正在使用一个使用 RealClass 的模块，因此它是我无权访问的内部依赖项。

我希望能够创建一个 FakeClass 来替换 RealClass 的功能以进行测试。我不想替换单个方法，而是替换整个类。

我查看了 stubble 这似乎是我想要的，但我想知道是否 mox 或任何其他模拟框架有这个功能吗？或者你建议使用什么？也许忽悠，猴子补丁？只是寻找这些东西的最佳实践。另外，任何有用的例子都会很棒。

伪代码：

from module import RealClass

class FakeClass
    methodsFromRealClassOverridden

class Test(unittest.TestCase):
    setup()
    teardown()

test1()
    stub(RealClass, FakeClass) // something like this, but really just want the functionality
    classThatUsesRealClass // now will use FakeClass

更新：

这是我发现的一种方法。它并不完美，但它有效。

例子：

fake = FakeClass()
stub = stubout.StubOutForTesting()
stub.Set(RealClass, 'method_1', fake.method_1)
stub.Set(RealClass, 'method_2', fake.method_2)

Answer 1

我认为你想要意见/经验，所以我只给出我的 2 美分。

正如您所注意到的，有一些 Python 测试工具/类/框架，但大多数时候，鉴于 Python 的简单性/动态性/开放性，您将限制自己使用特定的相关测试用例，其中涉及接口级别的存根，并且一些单元测试......直到您开始使用框架。

猴子修补没有任何贬义，特别是在执行测试/存根时：

#!/usr/bin/env python
# minimal example of library code

class Class:
    """ a class """
    def method(self, arg):
        """ a method that does real work """
        print("pouet %s" % arg)

#!/usr/bin/env python
# minimal example for stub and tests, overriding/wrapping one method
from Class import Class

Class._real_method = Class.method
def mymethod(self, arg):
    # do what you want
    print("called stub")
    # in case you want to call the real function...
    self._real_method(arg)
Class.method = mymethod

# ...

e = Class()
e.method("pouet")

命名空间将允许您修补导入模块内部的内容...

请注意，上述方法不适用于 C 模块中的类。
对于它们，您可以使用包装类，该包装类使用 getattr/setattr 过滤类成员名称，并从包装类返回重新定义的成员。

#!/usr/bin/env python
# Stupid minimal example replacing the sys module
# (not very useful / optimal, it's just an example of patching)

import sys

class SysWrap():
    real = sys
    def __getattr__(self, attr):
        if attr == 'stderr':
            class StdErr():
                def write(self, txt):
                    print("[err: %s]" % txt)
            return StdErr()
        print("Getattr %s" % attr)
        return getattr(SysWrap.real, attr)

sys = SysWrap()
# use the real stdout
sys.stdout.write("pouet")
# use fake stderr
sys.stderr.write("pouet")

一旦您厌倦了执行临时测试，您会发现更高级别的东西，例如您提到的那些（胡茬，软糖）很有用，但是要享受它们并有效地使用它们，您必须首先看到它们解决的问题和接受他们在幕后所做的所有自动的事情。

临时猴子修补的一部分可能会保留，只是更容易理解，并且所有工具都有一些限制。

工具赋予你力量，但你必须深入了解它们才能有效地使用它们。

决定是否使用工具时的一个重要方面是，当您传输一段代码时，您就传输了整个环境（包括测试工具）。
下一个人可能不像你那么聪明并跳过测试，因为你的测试工具对他来说太复杂了。
通常，您希望避免在软件中使用大量依赖项。

最后，我认为如果您只使用单元测试和临时测试/猴子修补，只要您的东西有效，就没有人会打扰您。
无论如何，您的代码可能没有那么复杂。