与返回 stdout 内容的 subprocess.check_call 等效的好方法是什么？

Question

我想要一个与 subprocess.check_call 接口相匹配的好方法 - 即，它在失败时抛出 CalledProcessError ，是同步的，&c - 但相反返回命令的返回代码（如果它确实这样做）返回程序的输出，要么仅是 stdout，要么是 (stdout, stderr) 的元组。

有人有这样做的方法吗？

Answer 1

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() 实现。

Answer 2

我无法在评论中获取格式，所以这是对 JF Sebastian 的回答

我发现这非常有帮助，所以我想我会添加到这个答案中。我希望能够在代码中无缝工作而无需检查版本。这就是我所做的...

我将上面的代码放入一个名为“subprocess_compat.py”的文件中。然后在我使用子进程的代码中我做了。

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

现在，在代码中的任何位置，我都可以使用我想要的参数调用“subprocess.check_output”，并且无论我使用哪个版本的 python，它都可以工作。

Answer 3

在我读了两遍之后，我意识到它已经有十年的历史了，并且大多数答案适用于现已弃用的 python2.7 而不是 python3。

现在我们正在 - 或者应该 - 在 python3 上，似乎 python >= 3.7 的最佳选择是使用多个评论中提到的以下内容：

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

为了节省您搜索更多详细信息，我推荐我找到的答案SethMMorton 在 中提供了精彩的细节回答“如何抑制或捕获 subprocess.run() 的输出？” 正如那里所述，您可以直接访问 stdout、stderr：

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

如果您需要支持 Python 3.6：

但是，您可以通过将 stdout 和 stderr 设置为 PIPE 来轻松“模拟”这一点：

从子进程导入 PIPE

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

此信息来自
威廉·范·昂塞姆的相关问题的回答。

我倾向于直接访问 https://docs.python.org/3/library/ subprocess.html 来刷新我对一般子流程事物的记忆。 （不过，这些示例通常对我来说更容易快速访问。）

Answer 4

该函数以字符串列表的形式返回终端输出。

import subprocess,sys
def output(cmd):
    cmd_l = cmd.split()
    output = subprocess.Popen(cmd_l, stdout=subprocess.PIPE).communicate()[0]
    output = output.decode("utf-8")
    return (output)