使用subprocess模块

调用子进程的推荐方法是将run()函数用于它可以处理的所有用例。对于更高级的用例，可以直接使用Popen接口.

run()函数在Python 3.5中添加;如果你需要保持与旧版本的兼容性，请参阅较旧的高级API section.

subprocess.run (args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None )

运行args描述的命令。等待命令完成，然后返回CompletedProcess实例

上面显示的参数仅仅是最常见的参数，如下所述频繁使用的参数（因此在缩写签名中仅使用关键字表示法）。完整的函数签名在很大程度上与Popen构造函数的签名相同 – 该函数的大多数参数都传递给该接口。（timeout, input,check，和capture_output不是。）

如果capture_output是真的，stdout和stderr将被捕获。使用时，内部Popen使用stdout=PIPE和stderr=PIPE自动创建对象。stdout和stderr参数也可能不被使用.

timeout参数传递给Popen.communicate()。如果timeoutexpires，子进程将被终止并等待。在子进程终止后，TimeoutExpired异常将被重新提升.

input参数传递给Popen.communicate()并因此传递给子进程的stdin。如果使用它必须是字节序列，或者如果指定encoding或errors或者text为真，则为字符串。使用时，内部Popen使用stdin=PIPE自动创建对象，并且stdin参数也可能不被使用.

如果check为真，则进程退出非零退出代码，将引发CalledProcessError异常。thatexception的属性包含参数，退出代码，stdout和stderr，如果它们被捕获的话.

如果指定encoding或errors，或text是true，stdin，stdout和stderr的文件对象在文本模式下使用指定的encoding和errors或io.TextIOWrapper default打开.universal_newlines参数相同到text并提供向后兼容性。默认情况下，文件对象以二进制模式打开.

如果env不是None，它必须是定义新进程的环境变量的映射;这些用于代替继承当前进程环境的defaultbehavior。它直接传递给Popen.

示例：

>>> subprocess.run(["ls", "-l"])  # doesn"t capture outputCompletedProcess(args=["ls", "-l"], returncode=0)>>> subprocess.run("exit 1", shell=True, check=True)Traceback (most recent call last):  ...subprocess.CalledProcessError: Command "exit 1" returned non-zero exit status 1>>> subprocess.run(["ls", "-l", "/dev/null"], capture_output=True)CompletedProcess(args=["ls", "-l", "/dev/null"], returncode=0,stdout=b"crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n", stderr=b"")

版本3.5中的新版.

版本3.6：添加了encoding和errors参数

在版本3.7中更改：添加了text参数，作为universal_newlines更易理解的别名。添加了capture_output参数

class subprocess.CompletedProcess

来自run()的返回值，表示已完成的进程.

args

用于启动进程的参数。这可能是一个列表或一个字符串.

returncode

退出子进程的状态。通常，退出状态为0表示它成功运行.

负值-N表示孩子被信号终止N（仅限POSIX）.

stdout

从子进程捕获的stdout。一个字节序列，或一个字符串，如果run()被调用，带有编码，错误或text = True .None如果没有捕获stdout .

如果你运行了这个过程使用stderr=subprocess.STDOUT，stdout和stder将合并到这个属性中，stderr将None.

stderr

从子进程中捕获stderr。一个字节序列，或一个字符串，如果run()被调用，编码，错误或文本=真.None如果没有捕获stderr.

check_returncode(）

如果returncode非零，请在版本3.5中添加CalledProcessError.

新增.

subprocess.DEVNULL

可用作stdin, stdout或stderr参数Popen的特殊值，表示将使用特殊文件os.devnull .

版本3.3.

subprocess.PIPE

中的新功能可用作stdin, stdout或stderr参数Popen并表示应打开标准流的管道。对Popen.communicate().

subprocess.STDOUT

最有用的特殊值可以用作stderr的Popen并指示标准错误应该与标准输出相同的句柄.

exception subprocess.SubprocessError

此模块中所有其他异常的基类.

3.3版本中的新功能

exception subprocess.TimeoutExpired

的子类SubprocessError，等待子进程时超时到期时引发.

cmd

用于生成子进程的命令.

timeout

在几秒钟内完成.

output

如果被run()要么check_output()。除此以外， None.

stdout

输出的别名，与stderr.

stderr

子进程的Stderr输出如果被run()。除此以外， None.

3.3版本中的新功能

在版本3.5中更改：stdout和stderr属性添加

exception subprocess.CalledProcessError

的子类SubprocessError，当一个进程由check_call()要么 check_output()返回非零退出状态.

returncode

退出子进程的状态。如果由于信号过程退出，这将是负信号.

cmd

用于生成子进程的命令.

output

如果run()或check_output()捕获了子进程的输出。否则，None.

stdout

输出的别名，与stderr.

stderr

子进程的Stderr输出如果被run()捕获。否则，None.

在版本3.5中更改：stdout和stderr属性添加

安全注意事项

与其他一些popen函数不同，此实现永远不会轻易调用系统shell。这意味着所有字符（包括shell元字符）都可以安全地传递给子进程。如果通过shell=True显式调用shell，则应用程序负责确保所有空格和元字符被适当地引用以避免出现问题injectionvul​​nerabilities.

使用shell=True时，可以使用shlex.quote()函数来正确地转义将用于构造shell命令的字符串中的空格和shell元字符.

Popen Objects

Popen类的实例有以下方法：

Popen.poll（）

检查子进程是否有终止。设置并返回returncode属性。否则，返回None.

Popen.wait（timeout=None）

等待子进程终止。设置并返回returncode属性

如果进程在timeout秒后没有终止，则引发TimeoutExpired异常。抓住这个例外是安全的并且重新等待.

注意

使用stdout=PIPE或stderr=PIPE时会出现死锁，并且子进程会为管道生成足够的输出，以便阻止等待OS管道缓冲区接受更多数据。使用Popen.communicate()使用烟斗时要避免这种情况.

注意

该函数使用繁忙循环（非阻塞调用和短暂睡眠）实现。使用 asyncio异步等待模块：见asyncio.create_subprocess_exec.

改版3.3：timeout已添加.

Popen.communicate (input=None, timeout=None)

与流程交互：将数据发送到stdin。从stdout和stderr读取数据，直到达到文件结尾。等待进程终止。可选input参数应该是要发送到子进程的数据，或None，如果没有数据应该发送给子进程。如果流打开了intext模式，input必须是一个字符串。否则，它必须是bytes.

communicate()返回一个元组(stdout_data, stderr_data)。如果在文本模式下打开流，数据将是字符串;否则，字节.

请注意，如果要将数据发送到进程的stdin，则需要使用stdin=PIPE创建Popen对象。同样，要在结果元组中获取除None以外的任何内容，你需要给stdout=PIPE和/或stderr=PIPE也是

如果在timeout秒之后进程没有终止，则会引发TimeoutExpired异常。捕获此异常并重新进行通信不会丢失任何输出.

如果超时到期，子进程不会被杀死，所以为了正确地执行tocleanup，一个行为良好的应用程序应该杀死子进程并完成通信：

proc = subprocess.Popen(...)try:    outs, errs = proc.communicate(timeout=15)except TimeoutExpired:    proc.kill()    outs, errs = proc.communicate()

注意

读取的数据缓冲在内存中，因此如果数据量很大或无限制，请不要使用此方法.

在版本3.3中更改：timeout已添加.

Popen.send_signal（signal）

发出信号signal对孩子

注意

在Windows上，SIGTERM是terminate()。CTRL_C_EVENT和CTRL_BREAK_EVENT可以发送到以creationflags参数包括CREATE_NEW_PROCESS_GROUP .

Popen.terminate（）

阻止孩子。在Posix OS上，该方法将SIGTERM发送给子节点。在Windows上，调用Win32 API函数TerminateProcess()来阻止孩子.

Popen.kill ()

杀死孩子。在Posix操作系统上，该函数将SIGKILL发送给子。在Windows上kill()是terminate().

的别名以下属性也可用：

Popen.args

args参数因为它传递给Popen – 程序参数的序列或者单个字符串.

新版本3.3.

Popen.stdin

如果stdin参数是PIPE，此属性是open()返回的可写流对象。如果指定了encoding或errors参数或universal_newlines参数是True，则流是文本流，否则它是字节流。如果stdin参数不是PIPE，则此属性为None.

Popen.stdout

如果stdout参数为PIPE，则此属性为可读流对象由open()返回。从流中读取提供来自子进程的输出。如果我们指定的encoding或errors参数或universal_newlines参数是True，流是文本流，否则是字节流。如果stdout参数不是PIPE，则此属性为None.

Popen.stderr

如果stderr参数为PIPE，则此属性为可读流对象由open()返回。从子进程读取流提供的错误输出。如果指定了encoding或errors参数或者universal_newlines参数是True，则流是文本流，否则它是字节流。如果stderr参数不是PIPE，这个属性是None.

Popen.pid

子进程的进程ID .

请注意，如果你设置shell True的参数，这是生成的shell的进程ID。

Popen.returncode

子返回码，由poll()和wait()设置（并间接地communicate()）。一个None值表示该过程尚未终止.

负值-N表示孩子被信号终止N（仅限POSIX）.

Windows Popen Helpers

STARTUPINFO类和以下常量仅在Windows上可用。

class subprocess.STARTUPINFO（*, dwFlags=0, hStdInput=None, hStdOutput=None, hStdError=None, wShowWindow=0, lpAttributeList=None）

WindowsSTARTUPINFOstructure的部分支持用于Popen创建。可以通过将它们作为仅关键字参数传递来设置以下属性.

在版本3.7中更改：添加了仅关键字参数支持.

dwFlags

确定的位字段是否在进程创建窗口时使用了某些STARTUPINFO属性.

si = subprocess.STARTUPINFO()si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW

hStdInput

如果dwFlags指定STARTF_USESTDHANDLES，则此属性是进程的标准输入句柄。如果没有指定STARTF_USESTDHANDLES，则标准输入的默认值是键盘缓冲区.

hStdOutput

如果dwFlags指定STARTF_USESTDHANDLES，此属性是进程的标准输出句柄。否则，该属性被忽略，标准输出的默认值是控制台窗口的缓冲区.

hStdError

如果dwFlags指定STARTF_USESTDHANDLES，此属性是进程的标准错误句柄。否则，此属性被赋值，标准错误的默认值是控制台窗口的缓冲区.

wShowWindow

如果dwFlags指定STARTF_USESHOWWINDOW，此属性可以是可以在其中指定的任何值显示窗口函数的nCmdShow参数，SW_SHOWDEFAULT除外。否则，此属性isignored.

SW_HIDE是为此属性提供的。使用Popen调用shell=True.

lpAttributeList

时使用它STARTUPINFOEX中给出的进程创建的附加属性字典，请参阅参考资料过程说明

支持的属性：

handle_list

将继承的句柄序列。close_fds必须是真的ifnon-empty.

句子必须暂时由os.set_handle_inheritable()传递到Popen构造函数，否则OSError将出现Windows错误ERROR_INVALID_PARAMETER（87）.

警告

在多线程进程中，请谨慎使用，以便在将此功能与对继承os.system()等句柄的其他进程创建函数的并发调用相结合时，避免泄漏标记为可继承的句柄。这也适用于tostandard handle redirection，它暂时创建了inheritablehandles。

新版本3.7.

旧的高级API

在Python 3.5之前，这三个函数包含高级API tosubprocess。你现在可以在很多情况下使用run()，但很多现有的代码都会调用这些函数.

subprocess.call (args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None)

运行args描述的命令。等命令完成，然后返回returncode属性

这相当于：

run(...).returncode

（除了input和check参数不支持）

上面显示的论点仅仅是最常见的。完整的函数签名在很大程度上与Popen构造函数的签名相同 – 此函数传递除timeout直接进入那个界面

注意

不使用 stdout=PIPE要么 stderr=PIPE有这个功能。子进程将阻塞，如果它为管道生成足够的输出以填充OS管道缓冲区，因为没有读取管道.

更改版本3.3：timeout被加上.

subprocess.check_call (args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None )

带着争吵的命令。等待命令完成。如果返回码为零则返回，否则提高CalledProcessError。CalledProcessError对象将在returncode属性中返回代码

这相当于：

run(..., check=True)

（除了input不支持参数）

上面显示的参数仅仅是最常见的参数。完整的函数签名与Popen构造函数的签名大致相同 – 这个函数将除timeout以外的所有提供的参数直接传递给该接口.

注意

请勿使用stdout=PIPE或stderr=PIPE此功能。子进程将阻塞，如果它为管道生成足够的输出以填充OS管道缓冲区，因为没有读取管道.

更改版本3.3：timeout已添加.

subprocess.check_output（args, *, stdin=None, stderr=None, shell=False, cwd=None, encoding=None, errors=None, universal_newlines=None, timeout=None, text=None）

用参数运行命令并返回其输出.

如果返回码非零，则会引发CalledProcessError。CalledProcessError对象将在returncode属性和output属性中的任何输出

这相当于：

run(..., check=True, stdout=PIPE).stdout

上面显示的参数仅仅是最常见的参数。完整函数签名大致相同就像run()-most参数直接传递给该接口。但是，不支持显式传递input=None继承父标准输入文件句柄.

默认情况下，此函数将数据作为编码字节返回。输出数据的执行编码可能取决于被调用的命令，因此通常需要在应用程序级别处理对文本的解码.

如上所述在universal_newlines中经常使用的参数True为了捕获结果中的标准错误，可以通过将设置为.

来覆盖此行为，使用stderr=subprocess.STDOUT：

>>> subprocess.check_output(...     "ls non_existent_file; exit 0",...     stderr=subprocess.STDOUT,...     shell=True)"ls: non_existent_file: No such file or directory\n"

版本3.1.

在版本3.3中更改：timeout已添加.

在版本3.4中更改：添加了对input关键字参数的支持.

更改版本3.6：encoding和errors已添加。见run()详情.

版本3.7：text新添加为universal_newlines.

更易读的别名用subprocess模块替换旧函数

在本节中，“a变为b”表示b可以用作替代a

在下面的例子中，我们假设相关函数已经从subprocess模块导入

output=`mycmd myarg`

output = check_output(["mycmd", "myarg"])

output=`dmesg | grep hda`

p1 = Popen(["dmesg"], stdout=PIPE)p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)p1.stdout.close()  # Allow p1 to receive a SIGPIPE if p2 exits.output = p2.communicate()[0]

output=`dmesg | grep hda`

output=check_output("dmesg | grep hda", shell=True)

sts = os.system("mycmd" + " myarg")# becomessts = call("mycmd" + " myarg", shell=True)

try:    retcode = call("mycmd" + " myarg", shell=True)    if retcode < 0:        print("Child was terminated by signal", -retcode, file=sys.stderr)    else:        print("Child returned", retcode, file=sys.stderr)except OSError as e:    print("Execution failed:", e, file=sys.stderr)

pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")==>pid = Popen(["/bin/mycmd", "myarg"]).pid

retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")==>retcode = call(["/bin/mycmd", "myarg"])

os.spawnvp(os.P_NOWAIT, path, args)==>Popen([path] + args[1:])

os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)==>Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})

(child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize)==>p = Popen(cmd, shell=True, bufsize=bufsize,          stdin=PIPE, stdout=PIPE, close_fds=True)(child_stdin, child_stdout) = (p.stdin, p.stdout)

(child_stdin, child_stdout, child_stderr) = os.popen3(cmd, mode, bufsize)==>p = Popen(cmd, shell=True, bufsize=bufsize,          stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)(child_stdin, child_stdout, child_stderr) = (p.stdin, p.stdout, p.stderr)

(child_stdin, child_stdout_and_stderr) = os.popen4(cmd, mode, bufsize)==>p = Popen(cmd, shell=True, bufsize=bufsize,          stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True)(child_stdin, child_stdout_and_stderr) = (p.stdin, p.stdout)

pipe = os.popen(cmd, "w")...rc = pipe.close()if rc is not None and rc >> 8:    print("There were some errors")==>process = Popen(cmd, stdin=PIPE)...process.stdin.close()if process.wait() != 0:    print("There were some errors")

(child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode)==>p = Popen("somestring", shell=True, bufsize=bufsize,          stdin=PIPE, stdout=PIPE, close_fds=True)(child_stdout, child_stdin) = (p.stdout, p.stdin)

(child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize, mode)==>p = Popen(["mycmd", "myarg"], bufsize=bufsize,          stdin=PIPE, stdout=PIPE, close_fds=True)(child_stdout, child_stdin) = (p.stdout, p.stdin)

Legacy Shell Invocation Functions

该模块还提供了2.x commands模块。这些操作隐式调用系统shell，并且上述有关安全性和异常处理一致性的保证都不适用于这些函数.

subprocess.getstatusoutput (cmd )

返回(exitcode, output)在shell中执行cmd

在cmd的shell中执行字符串Popen.check_output()并返回2元组(exitcode, output)。使用语言环境编码;请参阅经常使用的参数了解更多细节.

从输出中删除尾随换行符。该命令的退出代码可以解释为子进程的返回码。例：

>>> subprocess.getstatusoutput("ls /bin/ls")(0, "/bin/ls")>>> subprocess.getstatusoutput("cat /bin/junk")(1, "cat: /bin/junk: No such file or directory")>>> subprocess.getstatusoutput("/bin/junk")(127, "sh: /bin/junk: not found")>>> subprocess.getstatusoutput("/bin/kill $$")(-15, "")

可用性：POSIX＆amp;Windows.

在版本3.3.4中更改：添加了Windows支持.

该函数现在返回（exitcode，output）而不是（状态，输出），就像在Python 3.3.3及更早版本中那样。exitcode与returncode.

subprocess.getoutput（cmd）

在shell中执行cmd的返回输出（stdout和stderr）具有相同的值

//喜欢getstatusoutput()，除了退出代码被忽略，returnvalue是一个包含命令输出的字符串。示例：

>>> subprocess.getoutput("ls /bin/ls")"/bin/ls"

可用性：POSIX＆amp;Windows.

更改版本3.3.4： Windows支持添加

注意