python模块之subprocess模块级方法

37次阅读

共计 3507 个字符,预计需要花费 9 分钟才能阅读完成。

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()
raise
subprocess.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 0
subprocess.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).stdout

subprocess 模块还提供了 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 = 0
except CalledProcessError as ex:
data = ex.output
exitcode = ex.returncode
if data[-1:] == ‘\n’:
data = data[:-1]
return exitcode, data
subprocess.getoutput(cmd)
与 getstatusoutput()类似,但结果只返回 output。

正文完
 0