python模块之subprocess模块级方法的使用

港控/mmm° 2022-11-08 15:29 254阅读 0赞

**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异常。

<table> 
 <tbody> 
 <tr> 
 <td> 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 </td> 
 <td> <code># 源码</code> &nbsp; <code>def</code> <code>run(</code><code>*</code><code>popenargs, </code><code>input</code><code>=</code><code>None</code><code>, capture_output</code><code>=</code><code>False</code><code>, timeout</code><code>=</code><code>None</code><code>, check</code><code>=</code><code>False</code><code>, </code><code>*</code><code>*</code><code>kwargs):</code> <code>&nbsp;&nbsp;</code><code>if</code> <code>input</code> <code>is</code> <code>not</code> <code>None</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>'stdin'</code> <code>in</code> <code>kwargs:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>ValueError(</code><code>'stdin and input arguments may not both be used.'</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>kwargs[</code><code>'stdin'</code><code>] </code><code>=</code> <code>PIPE</code> <code>&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;</code><code>if</code> <code>capture_output:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>(</code><code>'stdout'</code> <code>in</code> <code>kwargs) </code><code>or</code> <code>(</code><code>'stderr'</code> <code>in</code> <code>kwargs):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>ValueError(</code><code>'stdout and stderr arguments may not be used '</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'with capture_output.'</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>kwargs[</code><code>'stdout'</code><code>] </code><code>=</code> <code>PIPE</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>kwargs[</code><code>'stderr'</code><code>] </code><code>=</code> <code>PIPE</code> <code>&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;</code><code>with Popen(</code><code>*</code><code>popenargs, </code><code>*</code><code>*</code><code>kwargs) as process:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>try</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>stdout, stderr </code><code>=</code> <code>process.communicate(</code><code>input</code><code>, timeout</code><code>=</code><code>timeout)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>except</code> <code>TimeoutExpired:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>process.kill()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>stdout, stderr </code><code>=</code> <code>process.communicate()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>TimeoutExpired(process.args, timeout, output</code><code>=</code><code>stdout,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>stderr</code><code>=</code><code>stderr)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>except</code><code>: </code><code># Including KeyboardInterrupt, communicate handled that.</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>process.kill()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code># We don't call process.wait() as .__exit__ does that for us.</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>retcode </code><code>=</code> <code>process.poll()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>check </code><code>and</code> <code>retcode:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>CalledProcessError(retcode, process.args,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>output</code><code>=</code><code>stdout, stderr</code><code>=</code><code>stderr)</code> <code>&nbsp;&nbsp;</code><code>return</code> <code>CompletedProcess(process.args, retcode, stdout, stderr)</code> </td> 
 </tr> 
 </tbody> 
</table>

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管道缓冲区，子进程将因不能从管道读取数据而导致阻塞。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code># 源码</code> <code>def</code> <code>call(</code><code>*</code><code>popenargs, timeout</code><code>=</code><code>None</code><code>, </code><code>*</code><code>*</code><code>kwargs):</code> <code>&nbsp;&nbsp;</code><code>with Popen(</code><code>*</code><code>popenargs, </code><code>*</code><code>*</code><code>kwargs) as p:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>try</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>p.wait(timeout</code><code>=</code><code>timeout)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>except</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>p.kill()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>p.wait()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> </td> 
 </tr> 
 </tbody> 
</table>

**subprocess.check\_call()**

运行并等待args参数指定的指令完成，返回0状态码或抛出CalledProcessError异常，该异常的cmd和returncode属性可以查看执行异常的指令和状态码。

参数：(\*popenargs, \*\*kwargs)。全部参数传递给call()函数。

注意事项同call()

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code># 源码</code> <code>def</code> <code>check_call(</code><code>*</code><code>popenargs, </code><code>*</code><code>*</code><code>kwargs):</code> <code>&nbsp;&nbsp;</code><code>retcode </code><code>=</code> <code>call(</code><code>*</code><code>popenargs, </code><code>*</code><code>*</code><code>kwargs)</code> <code>&nbsp;&nbsp;</code><code>if</code> <code>retcode:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>cmd </code><code>=</code> <code>kwargs.get(</code><code>"args"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>cmd </code><code>is</code> <code>None</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>cmd </code><code>=</code> <code>popenargs[</code><code>0</code><code>]</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>CalledProcessError(retcode, cmd)</code> <code>&nbsp;&nbsp;</code><code>return</code> <code>0</code> </td> 
 </tr> 
 </tbody> 
</table>

**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属性访问。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code># 源码</code> &nbsp; <code>def</code> <code>check_output(</code><code>*</code><code>popenargs, timeout</code><code>=</code><code>None</code><code>, </code><code>*</code><code>*</code><code>kwargs):</code> <code>&nbsp;&nbsp;</code><code>if</code> <code>'stdout'</code> <code>in</code> <code>kwargs:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>ValueError(</code><code>'stdout argument not allowed, it will be overridden.'</code><code>)</code> &nbsp; <code>&nbsp;&nbsp;</code><code>if</code> <code>'input'</code> <code>in</code> <code>kwargs </code><code>and</code> <code>kwargs[</code><code>'input'</code><code>] </code><code>is</code> <code>None</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># Explicitly passing input=None was previously equivalent to passing an</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># empty string. That is maintained here for backwards compatibility.</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>kwargs[</code><code>'input'</code><code>] </code><code>=</code> <code>'</code><code>' if kwargs.get('</code><code>universal_newlines</code><code>', False) else b'</code><code>'</code> &nbsp; <code>&nbsp;&nbsp;</code><code>return</code> <code>run(</code><code>*</code><code>popenargs, stdout</code><code>=</code><code>PIPE, timeout</code><code>=</code><code>timeout, check</code><code>=</code><code>True</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>*</code><code>*</code><code>kwargs).stdout</code> </td> 
 </tr> 
 </tbody> 
</table>

subprocess模块还提供了python2.x版本中commands模块的相关函数。

**subprocess.getstatusoutput(cmd)**

实际上是调用`check_output()`函数，在shell中执行string类型的cmd指令，返回`(exitcode, output)`形式的元组，output(包含`stderr`和`stdout`)是使用locale encoding解码的字符串，并删除了结尾的换行符。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code># 源码</code> <code>try</code><code>:</code> <code>&nbsp;&nbsp;</code><code>data </code><code>=</code> <code>check_output(cmd, shell</code><code>=</code><code>True</code><code>, universal_newlines</code><code>=</code><code>True</code><code>, stderr</code><code>=</code><code>STDOUT)</code> <code>&nbsp;&nbsp;</code><code>exitcode </code><code>=</code> <code>0</code> <code>except</code> <code>CalledProcessError as ex:</code> <code>&nbsp;&nbsp;</code><code>data </code><code>=</code> <code>ex.output</code> <code>&nbsp;&nbsp;</code><code>exitcode </code><code>=</code> <code>ex.returncode</code> <code>if</code> <code>data[</code><code>-</code><code>1</code><code>:] </code><code>=</code><code>=</code> <code>'\n'</code><code>:</code> <code>&nbsp;&nbsp;</code><code>data </code><code>=</code> <code>data[:</code><code>-</code><code>1</code><code>]</code> <code>return</code> <code>exitcode, data</code> </td> 
 </tr> 
 </tbody> 
</table>

**subprocess.getoutput(cmd)**

与`getstatusoutput()`类似，但结果只返回output。