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

(1 commento) (0 reazioni) (0 assegnatari)Python (1985 fork)batch import

builderextensions:doctesthelp wantedtype:proposal

Metriche repository

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

Direzione di ricerca: Indaga l'ordine di importazione in sphinx.ext.doctest per assicurarsi che sys.stdout e sys.stderr vengano patchati prima di importare il modulo di destinazione.
Tech stack: python
Dominio: documentationbackend
Tipo issue: Bug
Difficoltà: 2
Tempo stimato: Mezza giornata
Stato attività: Nuova
Chiarezza: Chiara
Prerequisiti: PythonSphinx
Adatta ai principianti: 70