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


Posted in Python onMarch 26, 2019

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(包含stderrstdout)是使用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。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
python基于BeautifulSoup实现抓取网页指定内容的方法
Jul 09 Python
关于Python正则表达式 findall函数问题详解
Mar 22 Python
Linux下python与C++使用dlib实现人脸检测
Jun 29 Python
实例讲解Python爬取网页数据
Jul 08 Python
Pytorch中的variable, tensor与numpy相互转化的方法
Oct 10 Python
关于Python 常用获取元素 Driver 总结
Nov 24 Python
pycharm设置当前工作目录的操作(working directory)
Feb 14 Python
PyQt5+python3+pycharm开发环境配置教程
Mar 24 Python
python使用pymongo与MongoDB基本交互操作示例
Apr 09 Python
使用python创建生成动态链接库dll的方法
May 09 Python
Python3通过chmod修改目录或文件权限的方法示例
Jun 08 Python
手把手教你实现PyTorch的MNIST数据集
Jun 28 Python
详解Python数据可视化编程 - 词云生成并保存(jieba+WordCloud)
Mar 26 #Python
Python实现的矩阵转置与矩阵相乘运算示例
Mar 26 #Python
深度辨析Python的eval()与exec()的方法
Mar 26 #Python
详解Python locals()的陷阱
Mar 26 #Python
python 为什么说eval要慎用
Mar 26 #Python
Python eval的常见错误封装及利用原理详解
Mar 26 #Python
Python骚操作之动态定义函数
Mar 26 #Python
You might like
PHP字符串word末字符实现大小写互换的方法
2014/11/10 PHP
curl 出现错误的调试方法(必看)
2017/02/13 PHP
权威JavaScript 中的内存泄露模式
2007/08/13 Javascript
js弹出的对话窗口永远保持居中显示
2012/12/15 Javascript
如何让DIV可编辑、可拖动示例代码
2013/09/18 Javascript
javascript实现复选框超过限制即弹出警告框的方法
2015/02/25 Javascript
javascript关于运动的各种问题经典总结
2015/04/27 Javascript
javascript实现日期时间动态显示示例代码
2015/09/08 Javascript
JavaScript基于对象去除数组重复项的方法
2016/10/09 Javascript
angularjs ui-router中路由的二级嵌套
2017/03/10 Javascript
JS+HTML5 FileReader对象用法示例
2017/04/07 Javascript
js案例之鼠标跟随jquery版(实例讲解)
2017/07/21 jQuery
JavaScript实现简单评论功能
2017/08/17 Javascript
AngularJS select加载数据选中默认值的方法
2018/02/28 Javascript
Vue 中mixin 的用法详解
2018/04/23 Javascript
vscode配置vue下的es6规范自动格式化详解
2019/03/20 Javascript
JavaScript原生数组函数实例汇总
2020/10/14 Javascript
Python实现列表转换成字典数据结构的方法
2016/03/11 Python
Python HTTP客户端自定义Cookie实现实例
2017/04/28 Python
python实现感知器算法详解
2017/12/19 Python
使用pandas read_table读取csv文件的方法
2018/07/04 Python
python通过tcp发送xml报文的方法
2018/12/28 Python
Django 导出项目依赖库到 requirements.txt过程解析
2019/08/23 Python
python 实现从高分辨图像上抠取图像块
2020/01/02 Python
django的403/404/500错误自定义页面的配置方式
2020/05/21 Python
Python开发.exe小工具的详细步骤
2021/01/27 Python
CSS3 transform的skew属性值图文详解
2014/07/21 HTML / CSS
css3 中的新特性加强记忆详解
2016/04/16 HTML / CSS
阿联酋航空丹麦官方网站:Emirates DK
2019/08/25 全球购物
三项教育活动实施方案
2014/03/30 职场文书
2014年小学图书室工作总结
2014/12/09 职场文书
北京大学中文系教授推荐的10本小说
2019/08/08 职场文书
导游词之天下银坑景区
2019/11/21 职场文书
Python常用配置文件ini、json、yaml读写总结
2021/07/09 Python
Python实战之大鱼吃小鱼游戏的实现
2022/04/01 Python
动画《平凡职业成就世界最强》宣布制作OVA
2022/04/01 日漫