サブプロセスを使用してリアルタイム出力を取得する

操作の進行状況インジケーターを表示するコマンドラインプログラム（svnadmin verify）のラッパースクリプトを記述しようとしています。これには、ラップされたプログラムからの出力が出力されるとすぐに、その出力の各行を表示できる必要があります。

私はsubprocess.Popen、を使用してプログラムを実行し、を使用してstdout=PIPE、入ってくる各行を読み取り、それに応じて処理するだけだと考えました。しかし、次のコードを実行すると、出力がどこかにバッファリングされているように見え、1行から332行、次に333行から439行（出力の最後の行）の2つのチャンクとして表示されました。

from subprocess import Popen, PIPE, STDOUT

p = Popen('svnadmin verify /var/svn/repos/config', stdout = PIPE, 
        stderr = STDOUT, shell = True)
for line in p.stdout:
    print line.replace('\n', '')

サブプロセスに関するドキュメントを少し調べたところ、へのbufsizeパラメーターを見つけたPopenので、bufsizeを1（各行をバッファー）および0（バッファーなし）に設定してみましたが、どちらの値もラインの配信方法を変更するようには見えませんでした。

この時点でストローを把握し始めたので、次の出力ループを作成しました。

while True:
    try:
        print p.stdout.next().replace('\n', '')
    except StopIteration:
        break

しかし同じ結果を得た。

サブプロセスを使用して実行されたプログラムの「リアルタイム」プログラム出力を取得することは可能ですか？Pythonには、上位互換性のある（でないexec*）オプションが他にありますか？

私はこれを試しました、そしてなぜかコードが

for line in p.stdout:
  ...

積極的にバッファリングし、バリアント

while True:
  line = p.stdout.readline()
  if not line: break
  ...

ではない。どうやらこれは既知のバグです：http : //bugs.python.org/issue3907（2018年8月29日現在、この問題は「クローズ」されています）

p = subprocess.Popen(cmd, stdout=subprocess.PIPE, bufsize=1)
for line in iter(p.stdout.readline, b''):
    print line,
p.stdout.close()
p.wait()

サブプロセスの出力を直接ストリームに送ることができます。簡略化した例：

subprocess.run(['ls'], stderr=sys.stderr, stdout=sys.stdout)

あなたはこれを試すことができます：

import subprocess
import sys

process = subprocess.Popen(
    cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE
)

while True:
    out = process.stdout.read(1)
    if out == '' and process.poll() != None:
        break
    if out != '':
        sys.stdout.write(out)
        sys.stdout.flush()

readの代わりにreadlineを使用すると、入力メッセージが出力されない場合があります。インライン入力が必要なコマンドで試してみて、自分の目で確かめてください。

ストリーミングサブプロセスのstdinとstdoutとasyncioのPythonでのブログのポストケビン・マッカーシー asyncioでそれを行う方法を示しています。

import asyncio
from asyncio.subprocess import PIPE
from asyncio import create_subprocess_exec


async def _read_stream(stream, callback):
    while True:
        line = await stream.readline()
        if line:
            callback(line)
        else:
            break


async def run(command):
    process = await create_subprocess_exec(
        *command, stdout=PIPE, stderr=PIPE
    )

    await asyncio.wait(
        [
            _read_stream(
                process.stdout,
                lambda x: print(
                    "STDOUT: {}".format(x.decode("UTF8"))
                ),
            ),
            _read_stream(
                process.stderr,
                lambda x: print(
                    "STDERR: {}".format(x.decode("UTF8"))
                ),
            ),
        ]
    )

    await process.wait()


async def main():
    await run("docker build -t my-docker-image:latest .")


if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

リアルタイム出力の問題の解決：cプログラムからリアルタイム出力をキャプチャ中に、Pythonで同様の問題が発生しました。「fflush（stdout） ;」を追加しました 私のCコードで。それは私のために働いた。これがコードの一部です

<< Cプログラム>>

#include <stdio.h>
void main()
{
    int count = 1;
    while (1)
    {
        printf(" Count  %d\n", count++);
        fflush(stdout);
        sleep(1);
    }
}

<< Pythonプログラム>>

#!/usr/bin/python

import os, sys
import subprocess


procExe = subprocess.Popen(".//count", shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)

while procExe.poll() is None:
    line = procExe.stdout.readline()
    print("Print:" + line)

<<出力>>印刷：カウント1印刷：カウント2印刷：カウント3

それが役に立てば幸い。

〜sairam

しばらく前に同じ問題に遭遇しました。私の解決策は、readメソッドの反復を破棄することでした。これは、サブプロセスの実行が終了していなくても、すぐに戻るなどです。

ユースケースによっては、サブプロセス自体のバッファリングを無効にすることもできます。

サブプロセスがPythonプロセスの場合、呼び出しの前にこれを行うことができます。

os.environ["PYTHONUNBUFFERED"] = "1"

または、これをenv引数でに渡しますPopen。

それ以外の場合、Linux / Unixを使用している場合は、stdbufツールを使用できます。例：

cmd = ["stdbuf", "-oL"] + cmd

またはその他のオプションについては、こちらもご覧くださいstdbuf。

（同じ回答については、こちらもご覧ください。）

このソリューションを使用して、サブプロセスのリアルタイム出力を取得しました。このループは、プロセスが完了するとすぐに停止し、breakステートメントまたは可能な無限ループの必要がなくなります。

sub_process = subprocess.Popen(my_command, close_fds=True, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)

while sub_process.poll() is None:
    out = sub_process.stdout.read(1)
    sys.stdout.write(out)
    sys.stdout.flush()

この「プラグアンドプレイ」機能はここにあります。魅力のように働いた！

import subprocess

def myrun(cmd):
    """from http://blog.kagesenshi.org/2008/02/teeing-python-subprocesspopen-output.html
    """
    p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
    stdout = []
    while True:
        line = p.stdout.readline()
        stdout.append(line)
        print line,
        if line == '' and p.poll() != None:
            break
    return ''.join(stdout)

サブプロセスの出力の各バイトに対してイテレータを使用できます。これにより、サブプロセスからのインライン更新（ '\ r'で終わる行が前の出力行を上書きする）が可能になります。

from subprocess import PIPE, Popen

command = ["my_command", "-my_arg"]

# Open pipe to subprocess
subprocess = Popen(command, stdout=PIPE, stderr=PIPE)


# read each byte of subprocess
while subprocess.poll() is None:
    for c in iter(lambda: subprocess.stdout.read(1) if subprocess.poll() is None else {}, b''):
        c = c.decode('ascii')
        sys.stdout.write(c)
sys.stdout.flush()

if subprocess.returncode != 0:
    raise Exception("The subprocess did not terminate correctly.")

Python 3.xでは、出力が文字列ではなくバイト配列であるため、プロセスがハングすることがあります。必ず文字列にデコードしてください。

Python 3.6以降ではencoding、Popenコンストラクターのパラメーターを使用して実行できます。完全な例：

process = subprocess.Popen(
    'my_command',
    stdout=subprocess.PIPE,
    stderr=subprocess.STDOUT,
    shell=True,
    encoding='utf-8',
    errors='replace'
)

while True:
    realtime_output = process.stdout.readline()

    if realtime_output == '' and process.poll() is not None:
        break

    if realtime_output:
        print(realtime_output.strip(), flush=True)

このコードは出力エラーにリダイレクト stderrしstdoutて処理することに注意してください。

pexpect [ http://www.noah.org/wiki/Pexpect ]を非ブロッキングreadlinesで使用すると、この問題が解決します。これは、パイプがバッファリングされるため、アプリの出力がパイプによってバッファリングされるため、バッファがいっぱいになるかプロセスが終了するまで、その出力に到達できません。

完全なソリューション：

import contextlib
import subprocess

# Unix, Windows and old Macintosh end-of-line
newlines = ['\n', '\r\n', '\r']
def unbuffered(proc, stream='stdout'):
    stream = getattr(proc, stream)
    with contextlib.closing(stream):
        while True:
            out = []
            last = stream.read(1)
            # Don't loop forever
            if last == '' and proc.poll() is not None:
                break
            while last not in newlines:
                # Don't loop forever
                if last == '' and proc.poll() is not None:
                    break
                out.append(last)
                last = stream.read(1)
            out = ''.join(out)
            yield out

def example():
    cmd = ['ls', '-l', '/']
    proc = subprocess.Popen(
        cmd,
        stdout=subprocess.PIPE,
        stderr=subprocess.STDOUT,
        # Make all end-of-lines '\n'
        universal_newlines=True,
    )
    for line in unbuffered(proc):
        print line

example()

これは私がいつもこのために使用する基本的なスケルトンです。タイムアウトの実装が容易になり、不可避のハングプロセスに対処できます。

import subprocess
import threading
import Queue

def t_read_stdout(process, queue):
    """Read from stdout"""

    for output in iter(process.stdout.readline, b''):
        queue.put(output)

    return

process = subprocess.Popen(['dir'],
                           stdout=subprocess.PIPE,
                           stderr=subprocess.STDOUT,
                           bufsize=1,
                           cwd='C:\\',
                           shell=True)

queue = Queue.Queue()
t_stdout = threading.Thread(target=t_read_stdout, args=(process, queue))
t_stdout.daemon = True
t_stdout.start()

while process.poll() is None or not queue.empty():
    try:
        output = queue.get(timeout=.5)

    except Queue.Empty:
        continue

    if not output:
        continue

    print(output),

t_stdout.join()

（このソリューションはPython 2.7.15でテストされてい
ます）各行の読み取り/書き込み後にsys.stdout.flush（）を実行するだけです。

while proc.poll() is None:
    line = proc.stdout.readline()
    sys.stdout.write(line)
    # or print(line.strip()), you still need to force the flush.
    sys.stdout.flush()

python 3.xまたはpthon 2.xを示唆する回答はほとんどありません。以下のコードは両方で機能します。

 p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,)
    stdout = []
    while True:
        line = p.stdout.readline()
        if not isinstance(line, (str)):
            line = line.decode('utf-8')
        stdout.append(line)
        print (line)
        if (line == '' and p.poll() != None):
            break