从 subprocess.communicate() 读取流输入

Question

我正在使用 Python 的 subprocess.communicate() 从运行大约一分钟的进程中读取标准输出。

如何以流方式打印出该进程的stdout 的每一行，以便我可以看到生成的输出，但在继续之前仍会阻止进程终止？

subprocess.communicate() 似乎一次性提供所有输出。

Answer 1

如果您想要一种非阻塞方法，请不要使用process.communicate()。如果将subprocess.Popen() 参数stdout 设置为PIPE，则可以从process.stdout 读取并检查进程是否仍在使用process.poll() 运行。

Answer 2

请注意，我认为J.F. Sebastian's method (below) 更好。

---

这是一个简单的例子（不检查错误）：

import subprocess
proc = subprocess.Popen('ls',
                       shell=True,
                       stdout=subprocess.PIPE,
                       )
while proc.poll() is None:
    output = proc.stdout.readline()
    print output,

如果ls 结束得太快，那么while 循环可能会在您读取所有数据之前结束。

您可以通过这种方式在标准输出中捕获余数：

output = proc.communicate()[0]
print output,

Answer 3

我相信以流方式从进程中收集输出的最简单方法是这样的：

import sys
from subprocess import *
proc = Popen('ls', shell=True, stdout=PIPE)
while True:
    data = proc.stdout.readline()   # Alternatively proc.stdout.read(1024)
    if len(data) == 0:
        break
    sys.stdout.write(data)   # sys.stdout.buffer.write(data) on Python 3.x

readline() 或 read() 函数只应在进程终止后在 EOF 上返回一个空字符串 - 否则如果没有可读取的内容，它将阻塞（readline() 包括换行符，因此在空行上，它返回“\n”）。这避免了在循环之后需要尴尬的最终 communicate() 调用。

在行很长的文件上read() 可能更适合减少最大内存使用量 - 传递给它的数字是任意的，但排除它会导致一次读取整个管道输出，这可能是不可取的。

Answer 4

在子进程刷新其标准输出缓冲区后，逐行获取子进程的输出：

#!/usr/bin/env python2
from subprocess import Popen, PIPE

p = Popen(["cmd", "arg1"], stdout=PIPE, bufsize=1)
with p.stdout:
    for line in iter(p.stdout.readline, b''):
        print line,
p.wait() # wait for the subprocess to exit

iter() 用于在写入行后立即读取行，以解决方法the read-ahead bug in Python 2。

如果子进程的标准输出在非交互模式下使用块缓冲而不是行缓冲（这会导致输出延迟，直到子进程的缓冲区已满或被子进程显式刷新），那么您可以尝试强制使用pexpect, pty modules 或unbuffer, stdbuf, script utilities 的无缓冲输出，请参阅Q: Why not just use a pipe (popen())?

---

这是 Python 3 代码：

#!/usr/bin/env python3
from subprocess import Popen, PIPE

with Popen(["cmd", "arg1"], stdout=PIPE, bufsize=1,
           universal_newlines=True) as p:
    for line in p.stdout:
        print(line, end='')

注意：不像 Python 2 那样输出子进程的字节串； Python 3 使用文本模式（cmd 的输出使用locale.getpreferredencoding(False) 编码解码）。

Answer 5

如果您只是想实时传递输出，很难比这更简单：

import subprocess

# This will raise a CalledProcessError if the program return a nonzero code.
# You can use call() instead if you don't care about that case.
subprocess.check_call(['ls', '-l'])

请参阅docs for subprocess.check_call()。

如果你需要处理输出，当然，循环它。但是，如果您不这样做，请保持简单。

编辑：J.F. Sebastian 指出 stdout 和 stderr 参数的默认值都传递给 sys.stdout 和 sys.stderr，如果 sys.stdout 和 sys.stderr 会失败。 stderr 已被替换（例如，用于捕获测试中的输出）。

Answer 6

myCommand="ls -l"
cmd=myCommand.split()
# "universal newline support" This will cause to interpret \n, \r\n and \r     equally, each as a newline.
p = subprocess.Popen(cmd, stderr=subprocess.PIPE, universal_newlines=True)
while True:    
    print(p.stderr.readline().rstrip('\r\n'))

Answer 7

添加另一个 python3 解决方案并进行一些小改动：

1. 允许您捕获 shell 进程的退出代码（我在使用 with 构造时无法获取退出代码）
2. 还可以实时输出标准错误

import subprocess
import sys
def subcall_stream(cmd, fail_on_error=True):
    # Run a shell command, streaming output to STDOUT in real time
    # Expects a list style command, e.g. `["docker", "pull", "ubuntu"]`
    p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, bufsize=1, universal_newlines=True)
    for line in p.stdout:
        sys.stdout.write(line)
    p.wait()
    exit_code = p.returncode
    if exit_code != 0 and fail_on_error:
        raise RuntimeError(f"Shell command failed with exit code {exit_code}. Command: `{cmd}`")
    return(exit_code)