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异常。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
# 源码 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管道缓冲区,子进程将因不能从管道读取数据而导致阻塞。
1
2
3
4
5
6
7
8
9
|
# 源码 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()
1
2
3
4
5
6
7
8
9
|
# 源码 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属性访问。
1
2
3
4
5
6
7
8
9
10
11
12
13
|
# 源码 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解码的字符串,并删除了结尾的换行符。
1
2
3
4
5
6
7
8
9
10
|
# 源码 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。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。
原文链接:https://segmentfault.com/a/1190000018658746