Subprocess

常量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，此属性值为Nonestdout：与Popen.stdin相近，但stream对象是可读的stderr：与Popen.stdout相近pid：子进程进程号。如果设置了shell=True，pid表示派生shell的进程号returncode：子进程返回码，None表示进程未终止。负数-N表示进程被信号N终止(仅限POSIX)。CompletedProcessrun()函数运行的返回值，表示进程执行完成。属性args：传入run()函数的第一个参数，list或string类型returncode：子进程退出码。如果为负数，表示进程因为某个信号退出stdout：捕获的子进程的标准输出，默认为byte类型，如果run()函数调用时指定了encoding或errors，或设置了text=True则为string类型。如果未捕获标准输出返回Nonestderr：捕获的子进程的标准错误，默认为byte类型，如果run()函数调用时指定了encoding或errors，或设置了text=True则为string类型。如果未捕获标准错误返回None方法check_returncode()：如果returncode非0，抛出CalledProcessError异常异常subprocess.SubprocessErrorsubprocess模块的异常基类subprocess.TimeoutExpired子进程执行超时。属性cmd：指令timeout：秒为单位的时间output：run()或check_output()函数捕获到的子进程的输出，否则为Nonestdout：output属性别名stderr：run()函数捕获到的子进程的错误输出，否则为Nonesubprocess.CalledProcessErrorcheck_call()或check_output()函数返回非0状态码时抛出。属性returncode：子进程退出码。如果为负数，表示进程因为某个信号退出cmd：同TimeoutExpiredoutput：同TimeoutExpiredstdout：同TimeoutExpiredstderr：同TimeoutExpired

subprocess.run()运行并等待args参数指定的指令完成，返回CompletedProcess实例。参数：(*popenargs, input=None, capture_output=False, timeout=None, check=False, **kwargs)。除input, capture_output, timeout, check，其他参数与Popen构造器参数一致。capture_output：如果设置为True，表示重定向stdout和stderr到管道，且不能再传递stderr或stdout参数，否则抛出异常。input：input参数将作为子进程的标准输入传递给Popen.communicate()方法，必须是string(需要指定encoding或errors参数，或者设置text为True)或byte类型。非None的input参数不能和stdin参数一起使用，否则将抛出异常，构造Popen实例的stdin参数将指定为subprocess.PIPE。timeout：传递给Popen.communicate()方法。check：如果设置为True，进程执行返回非0状态码将抛出CalledProcessError异常。# 源码def run(*popenargs, input=None, capture_output=False, timeout=None, check=False, **kwargs): if input is not None: if ‘stdin’ in kwargs: raise ValueError(‘stdin and input arguments may not both be used.’) kwargs[‘stdin’] = PIPE if capture_output: if (‘stdout’ in kwargs) or (‘stderr’ in kwargs): raise ValueError(‘stdout and stderr arguments may not be used ’ ‘with capture_output.’) kwargs[‘stdout’] = PIPE kwargs[‘stderr’] = PIPE with Popen(*popenargs, **kwargs) as process: try: stdout, stderr = process.communicate(input, timeout=timeout) except TimeoutExpired: process.kill() stdout, stderr = process.communicate() raise TimeoutExpired(process.args, timeout, output=stdout, stderr=stderr) except: # Including KeyboardInterrupt, communicate handled that. process.kill() # We don’t call process.wait() as .exit does that for us. raise retcode = process.poll() if check and retcode: raise CalledProcessError(retcode, process.args, output=stdout, stderr=stderr) return CompletedProcess(process.args, retcode, stdout, stderr)python3.5版本前，call(), check_all(), checkoutput()三种方法构成了subprocess模块的高级API。subprocess.call()运行并等待args参数指定的指令完成，返回执行状态码(Popen实例的returncode属性)。参数：(*popenargs, timeout=None, **kwargs)。与Popen构造器参数基本相同，除timeout外的所有参数都将传递给Popen接口。调用call()函数不要使用stdout=PIPE或stderr=PIPE，因为如果子进程生成了足量的输出到管道填满OS管道缓冲区，子进程将因不能从管道读取数据而导致阻塞。# 源码def call(*popenargs, timeout=None, **kwargs): with Popen(*popenargs, **kwargs) as p: try: return p.wait(timeout=timeout) except: p.kill() p.wait() raisesubprocess.check_call()运行并等待args参数指定的指令完成，返回0状态码或抛出CalledProcessError异常，该异常的cmd和returncode属性可以查看执行异常的指令和状态码。参数：(*popenargs, **kwargs)。全部参数传递给call()函数。注意事项同call()# 源码def check_call(*popenargs, **kwargs): retcode = call(*popenargs, **kwargs) if retcode: cmd = kwargs.get(“args”) if cmd is None: cmd = popenargs[0] raise CalledProcessError(retcode, cmd) return 0subprocess.check_output()运行并等待args参数指定的指令完成，返回标准输出(CompletedProcess实例的stdout属性)，类型默认是byte字节，字节编码可能取决于执行的指令，设置universal_newlines=True可以返回string类型的值。如果执行状态码非0，将抛出CalledProcessError异常。参数：(*popenargs, timeout=None, **kwargs)。全部参数传递给run()函数，但不支持显示地传递input=None继承父进程的标准输入文件句柄。要在返回值中捕获标准错误，设置stderr=subprocess.STDOUT；也可以将标准错误重定向到管道stderr=subprocess.PIPE，通过CalledProcessError异常的stderr属性访问。# 源码def check_output(*popenargs, timeout=None, **kwargs): if ‘stdout’ in kwargs: raise ValueError(‘stdout argument not allowed, it will be overridden.’) if ‘input’ in kwargs and kwargs[‘input’] is None: # Explicitly passing input=None was previously equivalent to passing an # empty string. That is maintained here for backwards compatibility. kwargs[‘input’] = ’’ if kwargs.get(‘universal_newlines’, False) else b’’ return run(*popenargs, stdout=PIPE, timeout=timeout, check=True, **kwargs).stdoutsubprocess模块还提供了python2.x版本中commands模块的相关函数。subprocess.getstatusoutput(cmd)实际上是调用check_output()函数，在shell中执行string类型的cmd指令，返回(exitcode, output)形式的元组，output(包含stderr和stdout)是使用locale encoding解码的字符串，并删除了结尾的换行符。# 源码try: data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT) exitcode = 0except CalledProcessError as ex: data = ex.output exitcode = ex.returncodeif data[-1:] == ‘\n’: data = data[:-1]return exitcode, datasubprocess.getoutput(cmd)与getstatusoutput()类似，但结果只返回output。 ...