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

(1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (1.985 Forks)batch import

builderextensions:doctesthelp wantedtype:proposal

Repository-Metriken

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.

doctest a function like:

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

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

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

Research-Richtung: Untersuchen Sie die Importreihenfolge in sphinx.ext.doctest, um sicherzustellen, dass sys.stdout und sys.stderr vor dem Import des Zielmoduls gepatcht werden.
Tech Stack: python
Domain: documentationbackend
Issue Type: Fehler
Schwierigkeit: 2
Geschätzte Zeit: Halber Tag
Aktivitätsstatus: Frisch
Klarheit: Klar
Voraussetzungen: PythonSphinx
Einsteigerfreundlichkeit: 70