Comment capturer la sortie stdout d'un appel de fonction Python?

J'utilise une bibliothèque Python qui fait quelque chose sur un objet

do_something(my_object)

et le change. Ce faisant, il imprime des statistiques sur stdout, et j'aimerais avoir une idée de ces informations. La bonne solution serait de changer do_something()pour renvoyer les informations pertinentes,

out = do_something(my_object)

mais il faudra un certain temps avant que les développeurs do_something()se penchent sur ce problème. Pour contourner le problème, j'ai pensé à analyser tout ce qui do_something()écrit sur stdout.

Comment puis-je capturer la sortie stdout entre deux points dans le code, par exemple,

start_capturing()
do_something(my_object)
out = end_capturing()

?

Essayez ce gestionnaire de contexte:

from io import StringIO 
import sys

class Capturing(list):
    def __enter__(self):
        self._stdout = sys.stdout
        sys.stdout = self._stringio = StringIO()
        return self
    def __exit__(self, *args):
        self.extend(self._stringio.getvalue().splitlines())
        del self._stringio    # free up some memory
        sys.stdout = self._stdout

Usage:

with Capturing() as output:
    do_something(my_object)

output est maintenant une liste contenant les lignes imprimées par l'appel de fonction.

Utilisation avancée:

Ce qui n'est peut-être pas évident, c'est que cela peut être fait plus d'une fois et les résultats concaténés:

with Capturing() as output:
    print('hello world')

print('displays on screen')

with Capturing(output) as output:  # note the constructor argument
    print('hello world2')

print('done')
print('output:', output)

Production:

displays on screen                     
done                                   
output: ['hello world', 'hello world2']

Mise à jour : ils ont été ajoutés redirect_stdout()à contextlibPython 3.4 (avec redirect_stderr()). Vous pouvez donc l'utiliser io.StringIOpour obtenir un résultat similaire (bien Capturingqu'être une liste et un gestionnaire de contexte soit sans doute plus pratique).

En python> = 3.4, contextlib contient un redirect_stdoutdécorateur. Il peut être utilisé pour répondre à votre question comme ceci:

import io
from contextlib import redirect_stdout

f = io.StringIO()
with redirect_stdout(f):
    do_something(my_object)
out = f.getvalue()

À partir de la documentation :

Gestionnaire de contexte pour rediriger temporairement sys.stdout vers un autre fichier ou objet semblable à un fichier.

Cet outil ajoute de la flexibilité aux fonctions ou classes existantes dont la sortie est câblée à stdout.

Par exemple, la sortie de help () est normalement envoyée à sys.stdout. Vous pouvez capturer cette sortie dans une chaîne en redirigeant la sortie vers un objet io.StringIO:

  f = io.StringIO() 
  with redirect_stdout(f):
      help(pow) 
  s = f.getvalue()

Pour envoyer la sortie de help () vers un fichier sur le disque, redirigez la sortie vers un fichier normal:

 with open('help.txt', 'w') as f:
     with redirect_stdout(f):
         help(pow)

Pour envoyer la sortie de help () à sys.stderr:

with redirect_stdout(sys.stderr):
    help(pow)

Notez que l'effet secondaire global sur sys.stdout signifie que ce gestionnaire de contexte n'est pas adapté à une utilisation dans le code de bibliothèque et la plupart des applications threadées. Il n'a également aucun effet sur la sortie des sous-processus. Cependant, c'est toujours une approche utile pour de nombreux scripts utilitaires.

Ce gestionnaire de contexte est réentrant.

Voici une solution asynchrone utilisant des canaux de fichiers.

import threading
import sys
import os

class Capturing():
    def __init__(self):
        self._stdout = None
        self._stderr = None
        self._r = None
        self._w = None
        self._thread = None
        self._on_readline_cb = None

    def _handler(self):
        while not self._w.closed:
            try:
                while True:
                    line = self._r.readline()
                    if len(line) == 0: break
                    if self._on_readline_cb: self._on_readline_cb(line)
            except:
                break

    def print(self, s, end=""):
        print(s, file=self._stdout, end=end)

    def on_readline(self, callback):
        self._on_readline_cb = callback

    def start(self):
        self._stdout = sys.stdout
        self._stderr = sys.stderr
        r, w = os.pipe()
        r, w = os.fdopen(r, 'r'), os.fdopen(w, 'w', 1)
        self._r = r
        self._w = w
        sys.stdout = self._w
        sys.stderr = self._w
        self._thread = threading.Thread(target=self._handler)
        self._thread.start()

    def stop(self):
        self._w.close()
        if self._thread: self._thread.join()
        self._r.close()
        sys.stdout = self._stdout
        sys.stderr = self._stderr

Exemple d'utilisation:

from Capturing import *
import time

capturing = Capturing()

def on_read(line):
    # do something with the line
    capturing.print("got line: "+line)

capturing.on_readline(on_read)
capturing.start()
print("hello 1")
time.sleep(1)
print("hello 2")
time.sleep(1)
print("hello 3")
capturing.stop()