有什么好的等效于subprocess.check_call并返回stdout内容的方法？

Question

我想要一个好用的方法，它的接口和 subprocess.check_call 一样。也就是说，当执行失败时，它会抛出 CalledProcessError 错误，并且是同步执行的等等。不过，它不是返回命令的返回码（如果有的话），而是返回程序的输出，可以是只返回标准输出，也可以是返回一个包含标准输出和标准错误输出的元组。

有没有人有这样的方法呢？

Answer 1

我看了两遍后才意识到，这个内容已经有十年了，而且大部分回答都是针对已经不再使用的python2.7，而不是python3。

现在我们应该使用python3，特别是3.7及以上版本，最好的选择是使用下面提到的内容，这在很多评论中都有提到：

result = subprocess.run(..., check=True, capture_output=True)

为了省去你寻找更多细节的时间，我推荐一个我找到的答案，作者是SethMMorton，在“如何抑制或捕获subprocess.run()的输出？”这个问题的回答中，详细描述了如何直接访问标准输出和错误输出：

print(result.stdout)
print(result.stderr)

如果你需要支持Python 3.6：

你可以通过将stdout和stderr都设置为PIPE来“模拟”这个功能：

from subprocess import PIPE

subprocess.run(["ls", "-l", "/dev/null"], stdout=PIPE, stderr=PIPE)

这些信息来自Willem Van Onsem对一个相关问题的回答。

我通常会直接去https://docs.python.org/3/library/subprocess.html刷新一下关于subprocess的一般知识。（不过，Stack Overflow上的例子通常更容易让我快速找到。）

Answer 2

我在评论里无法格式化，所以这是对J.F. Sebastian回答的补充

我觉得这个回答非常有帮助，所以我想在这里补充一些内容。我希望在代码中能顺畅地工作，而不需要去检查版本。这是我做的事情……

我把上面的代码放进一个叫做'subprocess_compat.py'的文件里。然后在我使用subprocess的代码中，我这样做了。

import sys
if sys.version_info < (2, 7):
    import subprocess_compat
    subprocess.check_output = subprocess_compat.check_output

现在在代码的任何地方，我只需要调用'subprocess.check_output'，并传入我想要的参数，不管我使用的是哪个版本的Python，它都能正常工作。

Answer 3

Python 2.7+

from subprocess import check_output as qx

Python < 2.7

来自 subprocess.py 的内容：

import subprocess
def check_output(*popenargs, **kwargs):
    if 'stdout' in kwargs:
        raise ValueError('stdout argument not allowed, it will be overridden.')
    process = subprocess.Popen(stdout=subprocess.PIPE, *popenargs, **kwargs)
    output, unused_err = process.communicate()
    retcode = process.poll()
    if retcode:
        cmd = kwargs.get("args")
        if cmd is None:
            cmd = popenargs[0]
        raise subprocess.CalledProcessError(retcode, cmd, output=output)
    return output

class CalledProcessError(Exception):
    def __init__(self, returncode, cmd, output=None):
        self.returncode = returncode
        self.cmd = cmd
        self.output = output
    def __str__(self):
        return "Command '%s' returned non-zero exit status %d" % (
            self.cmd, self.returncode)
# overwrite CalledProcessError due to `output` keyword might be not available
subprocess.CalledProcessError = CalledProcessError

另外，可以查看 将系统命令输出捕获为字符串，里面有关于 check_output() 实现的另一个例子。