Python doctest：有条件地跳过测试

Question

我知道如何使用# doctest: +SKIP跳过doctest，但我无法根据运行时条件弄清楚如何跳过测试。例如：

>>> if os.path.isfile("foo"):
...    open("foo").readlines()
... else:
...    pass # doctest: +SKIP
['hello', 'world']

这就是我想要做的事情。我也接受运行测试的解决方案，但是如果不满足条件，则将预期结果更改为带有回溯的异常（即无条件地运行测试但修改预期结果）。

Answer 1

如果不希望测试输出，可以返回特殊值。我们打电话给_skip这个特殊值：

• 如果设置了适当的标志，并且你得到的值是_skip，那么无论预期的是什么，测试都是成功的
• 否则（即无标志或正常返回值），按常规执行测试。

你需要一个自定义OutputChecker：

_skip = object()
COND_SKIP = doctest.register_optionflag('COND_SKIP')

class CondSkipChecker(doctest.OutputChecker):
    def check_output(self, want, got, optionflags):
        if optionflags & COND_SKIP and got.strip() == str(_skip):
            return True
        else:
            return super(CondSkipChecker, self).check_output(want, got, optionflags)

这是一个概念证明（doctest API有点麻烦：一个人喜欢使用带有testmod̀参数的checker）：

"""
>>> 1 if True else _skip
2
>>> 1 if False else _skip
2
>>> 1 if True else _skip # doctest: +COND_SKIP
2
>>> 1 if False else _skip # doctest: +COND_SKIP
2
"""

import doctest, sys
_skip = object()
COND_SKIP = doctest.register_optionflag('COND_SKIP')

class CondSkipChecker(doctest.OutputChecker):
    def check_output(self, want, got, optionflags):
        if optionflags & COND_SKIP and got.strip() == str(_skip):
            return True
        else:
            return super(CondSkipChecker, self).check_output(want, got, optionflags)

finder = doctest.DocTestFinder()
runner = doctest.DocTestRunner(CondSkipChecker())
m = sys.modules.get('__main__')
for test in finder.find(m, m.__name__):
    runner.run(test)
print(runner.summarize())

输出：

**********************************************************************
File "temp.py", line 2, in __main__
Failed example:
    1 if True else _skip
Expected:
    2
Got:
    1
**********************************************************************
File "temp.py", line 4, in __main__
Failed example:
    1 if False else _skip
Expected:
    2
Got:
    <object object at 0x0033B8A8>
**********************************************************************
File "temp.py", line 6, in __main__
Failed example:
    1 if True else _skip # doctest: +COND_SKIP
Expected:
    2
Got:
    1
**********************************************************************
1 items had failures:
   3 of   4 in __main__
***Test Failed*** 3 failures.
TestResults(failed=3, attempted=4)

没有doctest注释的两个测试按预期失败。注意：如果在没有_skip标志的情况下使用COND_SKIP，则可以轻松添加警告。

第三次测试失败（得到1与预期的2），但第四次是成功（获得_skip + COND_SKIP vs任何事情都没关系）。