sphinx-doc/sphinx

sphinx.ext.doctest should ensure that output is patched before importing the target

Open

#3,891 创建于 2017年6月25日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Python (5,625 star) (1,985 fork)batch import
builderextensions:doctesthelp wantedtype:proposal

描述

Problem

  • sphinx.ext.doctest will import the target before making sure that docutils has patched sys.stdout and sys.stderr with _SpoofOut objects. If the target module has already gotten a reference to stdout and stderr and writes to them doctests will fail.

Procedure to reproduce the problem

doctest a function like:

def f(stdout=sys.stdout):
    """
    .. testcode::
        f()
    .. testoutput::
        hello
    """
    stdout.write("hello")

Expected results

a successful doctest, where sys.stdout should be patched before the module under test is imported

Actual results

The output goes to the real sys.stdout, and the doctest fails claiming no output was produced

贡献者指南