プロセスの実行中にサブプロセスの出力を常に出力する

Pythonスクリプトからプログラムを起動するには、次の方法を使用しています。

def execute(command):
    process = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
    output = process.communicate()[0]
    exitCode = process.returncode

    if (exitCode == 0):
        return output
    else:
        raise ProcessException(command, exitCode, output)

したがって、のようなプロセスを起動するProcess.execute("mvn clean install")と、プログラムはプロセスが終了するまで待機し、その後初めてプログラムの完全な出力を取得します。終了するまでに時間がかかるプロセスを実行している場合、これは迷惑です。

ループなどで終了する前にプロセス出力をポーリングすることで、プログラムに1行ずつプロセス出力を書き込ませることができますか？

** [編集]すみません、この質問を投稿する前によく検索できませんでした。スレッディングが実際の鍵です。それを行う方法を示す例をここに見つけました：** スレッドからPython Subprocess.Popen

iterを使用して、コマンドが行を出力するとすぐに行を処理できますlines = iter(fd.readline, "")。以下は、典型的な使用例を示す完全な例です（@jfsの協力に感謝します）。

from __future__ import print_function # Only Python 2.x
import subprocess

def execute(cmd):
    popen = subprocess.Popen(cmd, stdout=subprocess.PIPE, universal_newlines=True)
    for stdout_line in iter(popen.stdout.readline, ""):
        yield stdout_line 
    popen.stdout.close()
    return_code = popen.wait()
    if return_code:
        raise subprocess.CalledProcessError(return_code, cmd)

# Example
for path in execute(["locate", "a"]):
    print(path, end="")

[OK]を私はこの質問からスニペットを使って、（スレッドを使用すると良いだろう、なぜ任意の提案が高く評価されている）スレッドせずにそれを解決するために管理し、それを実行している間、サブプロセスの標準出力インターセプト

def execute(command):
    process = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)

    # Poll process for new output until finished
    while True:
        nextline = process.stdout.readline()
        if nextline == '' and process.poll() is not None:
            break
        sys.stdout.write(nextline)
        sys.stdout.flush()

    output = process.communicate()[0]
    exitCode = process.returncode

    if (exitCode == 0):
        return output
    else:
        raise ProcessException(command, exitCode, output)

Python 3でstdoutバッファーがフラッシュされるとすぐに、サブプロセスの出力を行ごとに出力するには、次のようにします。

from subprocess import Popen, PIPE, CalledProcessError

with Popen(cmd, stdout=PIPE, bufsize=1, universal_newlines=True) as p:
    for line in p.stdout:
        print(line, end='') # process line here

if p.returncode != 0:
    raise CalledProcessError(p.returncode, p.args)

注意：必要ありませんp.poll()-eofに到達するとループが終了します。そして必要ありませんiter(p.stdout.readline, '')-先読みバグはPython 3で修正されています。

「Python：subprocess.communicate（）からストリーミング入力を読み取る」も参照してください。

出力を印刷したいだけの場合、実際にこれを行う簡単な方法があります。

import subprocess
import sys

def execute(command):
    subprocess.check_call(command, stdout=sys.stdout, stderr=subprocess.STDOUT)

ここでは、サブプロセスを独自のstdoutにポイントし、既存の成功または例外APIを使用しています。

@tokland

コードを試して3.4で修正しました。windowsdir.cmdはcmd-fileとして保存された単純なdirコマンドです

import subprocess
c = "dir.cmd"

def execute(command):
    popen = subprocess.Popen(command, stdout=subprocess.PIPE,bufsize=1)
    lines_iterator = iter(popen.stdout.readline, b"")
    while popen.poll() is None:
        for line in lines_iterator:
            nline = line.rstrip()
            print(nline.decode("latin"), end = "\r\n",flush =True) # yield line

execute(c)

誰かが両方から読みたい場合stdoutやstderr、スレッドを使用して、同時に、これは私が思い付いたものです：

import threading
import subprocess
import Queue

class AsyncLineReader(threading.Thread):
    def __init__(self, fd, outputQueue):
        threading.Thread.__init__(self)

        assert isinstance(outputQueue, Queue.Queue)
        assert callable(fd.readline)

        self.fd = fd
        self.outputQueue = outputQueue

    def run(self):
        map(self.outputQueue.put, iter(self.fd.readline, ''))

    def eof(self):
        return not self.is_alive() and self.outputQueue.empty()

    @classmethod
    def getForFd(cls, fd, start=True):
        queue = Queue.Queue()
        reader = cls(fd, queue)

        if start:
            reader.start()

        return reader, queue


process = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
(stdoutReader, stdoutQueue) = AsyncLineReader.getForFd(process.stdout)
(stderrReader, stderrQueue) = AsyncLineReader.getForFd(process.stderr)

# Keep checking queues until there is no more output.
while not stdoutReader.eof() or not stderrReader.eof():
   # Process all available lines from the stdout Queue.
   while not stdoutQueue.empty():
       line = stdoutQueue.get()
       print 'Received stdout: ' + repr(line)

       # Do stuff with stdout line.

   # Process all available lines from the stderr Queue.
   while not stderrQueue.empty():
       line = stderrQueue.get()
       print 'Received stderr: ' + repr(line)

       # Do stuff with stderr line.

   # Sleep for a short time to avoid excessive CPU use while waiting for data.
   sleep(0.05)

print "Waiting for async readers to finish..."
stdoutReader.join()
stderrReader.join()

# Close subprocess' file descriptors.
process.stdout.close()
process.stderr.close()

print "Waiting for process to exit..."
returnCode = process.wait()

if returnCode != 0:
   raise subprocess.CalledProcessError(returnCode, command)

私がこれを共有したかったのは、私が同じようなことをしようとするこの質問に終わったので、答えのどれも私の問題を解決しなかったからです。うまくいけば、それは誰かを助けるでしょう！

私の使用例では、外部プロセスが私たちのプロセスを強制終了していることに注意してくださいPopen()。

Pythonスクリプトからstdoutを取得するためにこの質問への回答を試みる人にとって、Pythonはそのstdoutをバッファーするため、stdoutを表示するのに時間がかかる場合があることに注意してください。

これは、ターゲットスクリプトの各stdout書き込みの後に以下を追加することで修正できます。

sys.stdout.flush()

Python> = 3.5ではsubprocess.run、私のために作品を使用しています：

import subprocess

cmd = 'echo foo; sleep 1; echo foo; sleep 2; echo foo'
subprocess.run(cmd, shell=True)

（実行中に出力を取得してもなしで機能しますshell=True） https://docs.python.org/3/library/subprocess.html#subprocess.run

元の質問に答えるために、IMOがstdoutプログラムに直接サブプロセスをリダイレクトするのが最善の方法stdoutです（オプションで、stderr以下の例のように、に対して同じことができます）

p = Popen(cmd, stdout=sys.stdout, stderr=sys.stderr)
p.communicate()

このPoCは常にプロセスからの出力を読み取り、必要なときにアクセスできます。最後の結果のみが保持され、他のすべての出力は破棄されるため、PIPEがメモリ不足になるのを防ぎます。

import subprocess
import time
import threading
import Queue


class FlushPipe(object):
    def __init__(self):
        self.command = ['python', './print_date.py']
        self.process = None
        self.process_output = Queue.LifoQueue(0)
        self.capture_output = threading.Thread(target=self.output_reader)

    def output_reader(self):
        for line in iter(self.process.stdout.readline, b''):
            self.process_output.put_nowait(line)

    def start_process(self):
        self.process = subprocess.Popen(self.command,
                                        stdout=subprocess.PIPE)
        self.capture_output.start()

    def get_output_for_processing(self):
        line = self.process_output.get()
        print ">>>" + line


if __name__ == "__main__":
    flush_pipe = FlushPipe()
    flush_pipe.start_process()

    now = time.time()
    while time.time() - now < 10:
        flush_pipe.get_output_for_processing()
        time.sleep(2.5)

    flush_pipe.capture_output.join(timeout=0.001)
    flush_pipe.process.kill()

print_date.py

#!/usr/bin/env python
import time

if __name__ == "__main__":
    while True:
        print str(time.time())
        time.sleep(0.01)

出力：〜2.5s間隔からの出力のみがあり、その間に何もないことが明確にわかります。

>>>1520535158.51
>>>1520535161.01
>>>1520535163.51
>>>1520535166.01

これは少なくともPython3.4で機能します

import subprocess

process = subprocess.Popen(cmd_list, stdout=subprocess.PIPE)
for line in process.stdout:
    print(line.decode().strip())

ここでの答えはどれも私のニーズのすべてに対応していません。

1. stdoutのスレッドはありません（キューなどもありません）
2. 進行中の他のことを確認する必要があるため、ノンブロッキング
3. ストリーム出力、ログファイルへの書き込み、出力の文字列コピーの返送など、複数のことを実行するために必要なPIPEを使用します。

少し背景：私はThreadPoolExecutorを使用してスレッドのプールを管理し、それぞれがサブプロセスを起動して並行処理を実行しています。（Python2.7では、これは新しい3.xでも機能するはずです）。他のもののために可能な限り多くを利用したいので、出力収集のためだけにスレッドを使用したくありません（20プロセスのプールは、実行するためだけに40スレッドを使用します;プロセススレッド用に1つ、標準出力用に1つ...そして、もしあなたが私が推測するstderrが欲しいなら）

ここでは多くの例外などを取り除いているので、これは本番環境で機能するコードに基づいています。うまくいけば、私はコピーアンドペーストでそれを台無しにしていない。また、フィードバックは大歓迎です！

import time
import fcntl
import subprocess
import time

proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)

# Make stdout non-blocking when using read/readline
proc_stdout = proc.stdout
fl = fcntl.fcntl(proc_stdout, fcntl.F_GETFL)
fcntl.fcntl(proc_stdout, fcntl.F_SETFL, fl | os.O_NONBLOCK)

def handle_stdout(proc_stream, my_buffer, echo_streams=True, log_file=None):
    """A little inline function to handle the stdout business. """
    # fcntl makes readline non-blocking so it raises an IOError when empty
    try:
        for s in iter(proc_stream.readline, ''):   # replace '' with b'' for Python 3
            my_buffer.append(s)

            if echo_streams:
                sys.stdout.write(s)

            if log_file:
                log_file.write(s)
    except IOError:
        pass

# The main loop while subprocess is running
stdout_parts = []
while proc.poll() is None:
    handle_stdout(proc_stdout, stdout_parts)

    # ...Check for other things here...
    # For example, check a multiprocessor.Value('b') to proc.kill()

    time.sleep(0.01)

# Not sure if this is needed, but run it again just to be sure we got it all?
handle_stdout(proc_stdout, stdout_parts)

stdout_str = "".join(stdout_parts)  # Just to demo

ここにオーバーヘッドが追加されることは確かですが、私の場合は問題になりません。機能的には、私が必要とすることを行います。私が解決していない唯一のことは、これがログメッセージに対して完全に機能する理由ですが、一部のprintメッセージが後で一度にすべて表示されるのがわかります。

Python 3.6では、これを使用しました：

import subprocess

cmd = "command"
output = subprocess.call(cmd, shell=True)
print(process)