スクリプトからstdoutをキャプチャしますか？

次のようなことを行うスクリプトがあるとします。

# module writer.py
import sys

def write():
    sys.stdout.write("foobar")

ここで、write関数の出力をキャプチャして、さらに処理するために変数に格納するとします。素朴な解決策は次のとおりです。

# module mymodule.py
from writer import write

out = write()
print out.upper()

しかし、これは機能しません。私は別の解決策を考え出し、それは機能しますが、問題を解決するためのより良い方法があるかどうか教えてください。ありがとう

import sys
from cStringIO import StringIO

# setup the environment
backup = sys.stdout

# ####
sys.stdout = StringIO()     # capture output
write()
out = sys.stdout.getvalue() # release output
# ####

sys.stdout.close()  # close the stream 
sys.stdout = backup # restore original stdout

print out.upper()   # post processing

設定stdoutはそれを行うための合理的な方法です。もう1つは、別のプロセスとして実行することです。

import subprocess

proc = subprocess.Popen(["python", "-c", "import writer; writer.write()"], stdout=subprocess.PIPE)
out = proc.communicate()[0]
print out.upper()

これがあなたのコードのコンテキストマネージャーバージョンです。2つの値のリストが生成されます。1つ目はstdout、2つ目はstderrです。

import contextlib
@contextlib.contextmanager
def capture():
    import sys
    from cStringIO import StringIO
    oldout,olderr = sys.stdout, sys.stderr
    try:
        out=[StringIO(), StringIO()]
        sys.stdout,sys.stderr = out
        yield out
    finally:
        sys.stdout,sys.stderr = oldout, olderr
        out[0] = out[0].getvalue()
        out[1] = out[1].getvalue()

with capture() as out:
    print 'hi'

将来の訪問者向け：Python 3.4 contextlibは、コンテキストマネージャーを介してこれを直接提供します（Python contextlibヘルプを参照）redirect_stdout。

from contextlib import redirect_stdout
import io

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

これは、私の元のコードのデコレータ版です。

writer.py 同じまま：

import sys

def write():
    sys.stdout.write("foobar")

mymodule.py わずかに変更されます：

from writer import write as _write
from decorators import capture

@capture
def write():
    return _write()

out = write()
# out post processing...

そして、ここにデコレータがあります：

def capture(f):
    """
    Decorator to capture standard output
    """
    def captured(*args, **kwargs):
        import sys
        from cStringIO import StringIO

        # setup the environment
        backup = sys.stdout

        try:
            sys.stdout = StringIO()     # capture output
            f(*args, **kwargs)
            out = sys.stdout.getvalue() # release output
        finally:
            sys.stdout.close()  # close the stream 
            sys.stdout = backup # restore original stdout

        return out # captured output wrapped in a string

    return captured

または、すでに存在する機能を使用することもできます...

from IPython.utils.capture import capture_output

with capture_output() as c:
    print('some output')

c()

print c.stdout

Python 3以降では、sys.stdout.buffer.write()（すでに）エンコードされたバイト文字列をstdoutに書き込むこともできます（Python 3のstdoutを参照）。そうするとStringIO、どちらsys.stdout.encodingもsys.stdout.buffer利用できないため、単純なアプローチは機能しません。

Python 2.6以降では、不足している属性を含むTextIOBaseAPIを使用できます。

import sys
from io import TextIOWrapper, BytesIO

# setup the environment
old_stdout = sys.stdout
sys.stdout = TextIOWrapper(BytesIO(), sys.stdout.encoding)

# do some writing (indirectly)
write("blub")

# get output
sys.stdout.seek(0)      # jump to the start
out = sys.stdout.read() # read output

# restore stdout
sys.stdout.close()
sys.stdout = old_stdout

# do stuff with the output
print(out.upper())

このソリューションは、Python 2> = 2.6およびsys.stdout.write()Python3で機能します。Unicode文字列sys.stdout.buffer.write()のみを受け入れ、バイト文字列のみを受け入れることに注意してください。これは古いコードには当てはまらないかもしれませんが、Python2および3で変更なしで実行するように構築されたコードにはよくあります。

stdout.bufferを使用せずにバイト文字列をstdoutに直接送信するコードをサポートする必要がある場合は、次のバリエーションを使用できます。

class StdoutBuffer(TextIOWrapper):
    def write(self, string):
        try:
            return super(StdoutBuffer, self).write(string)
        except TypeError:
            # redirect encoded byte strings directly to buffer
            return super(StdoutBuffer, self).buffer.write(string)

バッファのエンコーディングをsys.stdout.encodingに設定する必要はありませんが、これは、スクリプト出力のテスト/比較にこのメソッドを使用する場合に役立ちます。

質問ここでは（出力をリダイレクトする方法の例は、いないtee部分）を使用してos.dup2OSレベルでストリームをリダイレクトします。これは、プログラムから生成するコマンドにも適用されるため、便利です。

私はあなたがこれらの4つのオブジェクトを見るべきだと思います：

from test.test_support import captured_stdout, captured_output, \
    captured_stderr, captured_stdin

例：

from writer import write

with captured_stdout() as stdout:
    write()
print stdout.getvalue().upper()

UPD：エリックがコメントで言ったように、それらを直接使用するべきではないので、私はそれをコピーして貼り付けました。

# Code from test.test_support:
import contextlib
import sys

@contextlib.contextmanager
def captured_output(stream_name):
    """Return a context manager used by captured_stdout and captured_stdin
    that temporarily replaces the sys stream *stream_name* with a StringIO."""
    import StringIO
    orig_stdout = getattr(sys, stream_name)
    setattr(sys, stream_name, StringIO.StringIO())
    try:
        yield getattr(sys, stream_name)
    finally:
        setattr(sys, stream_name, orig_stdout)

def captured_stdout():
    """Capture the output of sys.stdout:

       with captured_stdout() as s:
           print "hello"
       self.assertEqual(s.getvalue(), "hello")
    """
    return captured_output("stdout")

def captured_stderr():
    return captured_output("stderr")

def captured_stdin():
    return captured_output("stdin")

私はcontextmanagerソリューションが好きですが、開いているファイルとfilenoサポートとともに保存されたバッファーが必要な場合は、次のようにすることができます。

import six
from six.moves import StringIO


class FileWriteStore(object):
    def __init__(self, file_):
        self.__file__ = file_
        self.__buff__ = StringIO()

    def __getattribute__(self, name):
        if name in {
            "write", "writelines", "get_file_value", "__file__",
                "__buff__"}:
            return super(FileWriteStore, self).__getattribute__(name)
        return self.__file__.__getattribute__(name)

    def write(self, text):
        if isinstance(text, six.string_types):
            try:
                self.__buff__.write(text)
            except:
                pass
        self.__file__.write(text)

    def writelines(self, lines):
        try:
            self.__buff__.writelines(lines)
        except:
            pass
        self.__file__.writelines(lines)

    def get_file_value(self):
        return self.__buff__.getvalue()

使用する

import sys
sys.stdout = FileWriteStore(sys.stdout)
print "test"
buffer = sys.stdout.get_file_value()
# you don't want to print the buffer while still storing
# else it will double in size every print
sys.stdout = sys.stdout.__file__
print buffer

これは、属性へのバイトの書き込みをサポートする@JonnyJDの回答からインスピレーションを得たコンテキストマネージャーですが、さらに単純化するためbufferにsysのdunder-ioレファレンも利用しています。

import io
import sys
import contextlib


@contextlib.contextmanager
def capture_output():
    output = {}
    try:
        # Redirect
        sys.stdout = io.TextIOWrapper(io.BytesIO(), sys.stdout.encoding)
        sys.stderr = io.TextIOWrapper(io.BytesIO(), sys.stderr.encoding)
        yield output
    finally:
        # Read
        sys.stdout.seek(0)
        sys.stderr.seek(0)
        output['stdout'] = sys.stdout.read()
        output['stderr'] = sys.stderr.read()
        sys.stdout.close()
        sys.stderr.close()

        # Restore
        sys.stdout = sys.__stdout__
        sys.stderr = sys.__stderr__


with capture_output() as output:
    print('foo')
    sys.stderr.buffer.write(b'bar')

print('stdout: {stdout}'.format(stdout=output['stdout']))
print('stderr: {stderr}'.format(stderr=output['stderr']))

出力は次のとおりです。

stdout: foo

stderr: bar