为什么在与Sphinx的‘make doctest’一起运行时，doctest会引发NameError？

问题描述

我有一个简单的function with a doctest，当它与Sphinx的make doctest一起运行时，会出现以下错误：

File "scheemey.rst", line ?, in default
Failed example:
    verify_balanced('asdf (foo [bar] [[baz], {}, ()]')
Exception raised:
    Traceback (most recent call last):
      File "/usr/local/Cellar/python/2.7.8/Frameworks/Python.framework/Versions/2.7/lib/python2.7/doctest.py", line 1315, in __run
        compileflags, 1) in test.globs
      File "<doctest default[0]>", line 1, in <module>
        verify_balanced('asdf (foo [bar] [[baz], {}, ()]')
    NameError: name 'verify_balanced' is not defined

这可能是什么原因？

---

解决方案

如果没有正确导入带有测试功能的模块，我可以重现问题中的错误。

要使其工作，您可以使用testsetup指令：

.. testsetup:: 

   from yourmodule import verify_balanced

>>> verify_balanced('asdf (foo) [bar] [[baz], {}, ()]')
>>> verify_balanced('asdf (foo [bar] [[baz], {}, ()]')
5

请注意，doctest忽略None返回值(请参阅Python doctests: test for None)。