Як зафіксувати вихід stdout з виклику функції Python?

Я використовую бібліотеку Python, яка робить щось із об’єктом

do_something(my_object)

і змінює його. При цьому він друкує певну статистику для stdout, і я хотів би зрозуміти цю інформацію. Правильним рішенням було б змінити, do_something()щоб повернути відповідну інформацію,

out = do_something(my_object)

але пройде ще деякий час, перш ніж чорти do_something()дістануться до цього питання. Як вирішення, я подумав про розбір того, що do_something()пише для stdout.

Як я можу зафіксувати висновок stdout між двома точками в коді, наприклад,

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

?

Спробуйте цей контекстний менеджер:

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

Використання:

with Capturing() as output:
    do_something(my_object)

output тепер це список, що містить рядки, надруковані викликом функції.

Розширене використання:

Що може бути не очевидним, це те, що це можна зробити не один раз, а результати об'єднані:

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)

Вихід:

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

Оновлення : Вони додали redirect_stdout()до contextlibв Python 3.4 (поряд з redirect_stderr()). Таким чином, ви можете використовувати io.StringIOз цим для досягнення аналогічного результату (хоча Capturing, як список, а також менеджер контексту, можливо, зручніше).

У python> = 3.4, contextlib містить redirect_stdoutдекоратор. З його допомогою можна відповісти на ваше запитання так:

import io
from contextlib import redirect_stdout

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

З документів :

Контекстний менеджер для тимчасового перенаправлення sys.stdout на інший файл або схожий на файл об'єкт.

Цей інструмент додає гнучкість існуючим функціям або класам, вихід яких є провідним для прошивки.

Наприклад, вихідний help () зазвичай надсилається до sys.stdout. Ви можете зафіксувати цей результат у рядку, перенаправивши вихід на об'єкт io.StringIO:

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

Щоб надіслати вихід help () у файл на диску, перенаправіть вихід у звичайний файл:

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

Щоб надіслати вихід help () на sys.stderr:

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

Зауважте, що глобальний побічний ефект на sys.stdout означає, що цей контекстний менеджер не підходить для використання в бібліотечному коді та більшості потокових програм. Це також не впливає на вихід підпроцесів. Однак це все ще корисний підхід для багатьох скриптів утиліти.

Цей менеджер контексту є ретентом.

Ось рішення асинхронізації за допомогою файлових труб.

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

Приклад використання:

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()