常量
subprocess.DEVNULL:可传递给 stdin, stdout, stderr 参数的特殊值,意味着将使用特殊文件 os.devnull 重定向输入输出
subprocess.PIPE:可传递给 stdin, stdout, stderr 参数的特殊值,意味着使用管道重定向输入输出
subprocess.STDOUT:可传递给 stderr 参数的特殊值,表示重定向标准错误到标准输出
Popen
在一个新的进程中执行子程序。
构造参数
(args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=True, shell=False, cwd=None, env=None, universal_newlines=None, startupinfo=None, creationflags=0, restore_signals=True, start_new_session=False, pass_fds=(), *, encoding=None, errors=None, text=None)
args:字符串或序列。如果是序列,则 args 中的第一个元素是要执行的程序;如果是字符串,解释执行与平台有关,在 POSIX 系统 args 将被解释为要执行的程序的名称或路径(前提是不传递任何参数给程序)。
shell:指定是否使用 shell 作为要执行的程序。如果设置为 True,更推荐和字符串类型的 args 参数使用。在 POSIX 系统,shell=True 默认使用 /bin/sh 作为 shell。如果 args 为字符串,该字符串表示要通过 shell 执行的命令;如果 args 为序列,第一个元素指定要执行的程序,其他元素视为参数。在 Windows 系统,shell=True 默认使用 COMSPEC 环境变量指定的 shell,一般是 C:\WINDOWS\system32\cmd.exe。唯一需要指定 shell=True 的场景是要执行的指令是 shell 内置的,如 dir, copy。
bufsize:创建 stdin/stdout/stderr 管道文件对象时作为对应的参数传递给 open()函数。0:不始用缓冲 1:使用行缓冲其他正整数:缓冲大小负整数(默认):使用系统默认值
executable:使用 shell=True 的场景很少。shell=True 时,在 POSIX 系统上此参数表示指定一个新的 shell 程序替换默认 shell/bin/sh。
stdin/stdout/stderr:分别指定程序执行的标准输入,标准输出,标准错误。可选值包括 PIPE,DEVNULL,已存在的文件描述符(正整数),已存在的文件对象,None。子进程文件句柄继承自父进程。除此之外,stderr 还可以是 STDOUT, 表示标准错误输出重定向到标准输出。
preexec_fn:限于 POSIX 系统,设置一个可调用对象,先于子进程中的程序执行。
close_fds:如果为 False,文件描述符遵循 Inheritance of File Descriptors 中描述的 inheritable 标识。如果为 True,在 POSIX 系统下,在子进程执行前关闭除 0,1,2 外的文件描述符。
pass_fds:限于 POSIX,可选的文件描述符序列,用于在父子进程间保持开放。只要提供了此参数,close_fds 强制设为 True。
cwd:在子进程执行前改变工作目录为 cwd,可以是字符串或 path-like 对象。
restore_signals:限于 POSIX,略
start_new_session:限于 POSIX,略
env:dict 对象,为新进程定义环境变量,替换继承自父进程的变量。在 Windows 下,要运行 side-by-side assembly 必须包含可用的环境变量 SystemRoot。如果指定了 env,就必须提供程序执行依赖的所有环境变量
encoding/errors/text/universal_newlines:stdin/stdout/stderr 默认以二进制模式打开。但如果指定了 encoding/errors 或者 text 为 True,将使用指定的 encoding 和 errors 以文本模式打开 stdin/stdout/stderr。universal_newlines 参数等同于 text,用于后向兼容。
startupinfo:仅限于 Windows,略
creationflags:仅限于 Windows,略
方法
poll():检查子进程是否终止。返回 None 表示未终止,否则设置 returncode 属性并返回。
wait(timeout=None):如果子进程在 timeout 后没有终止,抛出 TimeoutExpired 异常。否则设置 returncode 属性并返回。
communicate(input=None, timeout=None):进程交互:发送数据到 stdin,读取 stdout 或 stderr 的数据知道读取到结束符。返回 (stdout_data, stderr_data) 形式的元组。input 为 None 或要发送到子进程的数据,根据 stream 打开模式的不同,可以是 string 或 byte 类型。如果要和进程的 stdin 交互,创建 Popen 对象时需要指定 stdin=PIPE。类似的,返回的 tuple 如果希望是非 None,需要设置 stdout=PIPE 和 / 或 stderr=PIPE。如果子进程在 timeout 后没有终止,抛出 TimeoutExpired 异常,但子进程并未 kill 掉,一个良好的应用应该 kill 掉子进程并结束交互:
proc = subprocess.Popen(…)
try:
outs, errs = proc.communicate(timeout=15)
except TimeoutExpired:
proc.kill()
outs, errs = proc.communicate()
send_signal(signal):发送信号到子进程
terminate():终止子进程。POSIX 系统上,发送 SIGTERM 信号到子进程,Windows 系统上会调用 TerminateProcess()终止进程
kill():强制终止子进程。POSIX 系统上,发送 SIGKILL 信号到子进程。Windows 系统上 kill()是 terminate()的别名
属性
args:传入 Popen 构造器的第一个参数,list 或 string 类型
stdin:如果传递给 Popen 的 stdin 参数是 PIPE,该属性表示 string 或 byte 类型的可写 stream 对象。如果传递给 Popen 的 stdin 参数不是 PIPE,此属性值为 None
stdout:与 Popen.stdin 相近,但 stream 对象是可读的
stderr:与 Popen.stdout 相近
pid:子进程进程号。如果设置了 shell=True,pid 表示派生 shell 的进程号
returncode:子进程返回码,None 表示进程未终止。负数 - N 表示进程被信号 N 终止(仅限 POSIX)。
CompletedProcess
run()函数运行的返回值,表示进程执行完成。
属性
args:传入 run()函数的第一个参数,list 或 string 类型
returncode:子进程退出码。如果为负数,表示进程因为某个信号退出
stdout:捕获的子进程的标准输出,默认为 byte 类型,如果 run()函数调用时指定了 encoding 或 errors,或设置了 text=True 则为 string 类型。如果未捕获标准输出返回 None
stderr:捕获的子进程的标准错误,默认为 byte 类型,如果 run()函数调用时指定了 encoding 或 errors,或设置了 text=True 则为 string 类型。如果未捕获标准错误返回 None
方法
check_returncode():如果 returncode 非 0,抛出 CalledProcessError 异常
异常
subprocess.SubprocessError
subprocess 模块的异常基类
subprocess.TimeoutExpired
子进程执行超时。
属性
cmd:指令
timeout:秒为单位的时间
output:run()或 check_output()函数捕获到的子进程的输出,否则为 None
stdout:output 属性别名
stderr:run()函数捕获到的子进程的错误输出,否则为 None
subprocess.CalledProcessError
check_call()或 check_output()函数返回非 0 状态码时抛出。
属性
returncode:子进程退出码。如果为负数,表示进程因为某个信号退出
cmd:同 TimeoutExpired
output:同 TimeoutExpired
stdout:同 TimeoutExpired
stderr:同 TimeoutExpired