Python関数呼び出しからstdout出力をキャプチャする方法？

オブジェクトに対して何かを行うPythonライブラリを使用しています

do_something(my_object)

そしてそれを変更します。その間、いくつかの統計をstdoutに出力します。この情報を把握したいと思います。適切な解決策はdo_something()、関連情報を返すように変更することです。

out = do_something(my_object)

しかしdo_something()、この問題に取り組む開発者たちが現れるまでにはしばらくかかります。回避策として、私do_something()はstdoutへの書き込みを解析することを考えました。

コードの2点間の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']

更新：Python 3.4で追加さredirect_stdout()れcontextlibました（とともに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()