Skip to content

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

@Julian

Description

@Julian

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions