python:subprocess模块

844 阅读3分钟

简介

subprocess模块允许我们启动一个新进程,并连接到它们的输入/输出/错误管道,从而获取返回值。

使用subprocess模块

subprocess模块首先推荐使用的是它的run方法,
更高级的用法可以直接使用Popen接口。

run()方法

run 方法语法格式如下:
subprocess.run( args, 
                *, 
                stdin=None, 
                input=None, 
                stdout=None, 
                stderr=None,
                capture_output=False, 
                shell=False, 
                cwd=None, 
                timeout=None, 
                check=False, 
                encoding=None, 
                errors=None, 
                text=None, 
                env=None, 
                universal_newlines=None )

可见run()函数有很多的参数,下面详细介绍几个重要的参数。
<1>args:表示要执行的命令。必须是一个字符串,字符串参数列表。
<2>stdin、stdout 和 stderr:子进程的标准输入、标准输出和标准错误。
   其值可以是 subprocess.PIPE、subprocess.DEVNULL、一个已经存在的文件描述符、已经打开的文件对象或者 None。
   subprocess.PIPE 表示为子进程创建新的管道。
   subprocess.DEVNULL 表示使用 os.devnull。默认使用的是 None,表示什么都不做。
   另外,stderr 可以合并到 stdout 里一起输出。
                        
<3>timeout:设置命令超时时间。如果命令执行时间超过timeout,
           子进程将被杀死,并弹出 TimeoutExpired 异常。
<4>check:如果该参数设置为 True,并且进程退出状态码不是0,则弹出 CalledProcessError 异常。  
<5>encoding: 如果指定了该参数,则 stdin、stdout 和 stderr 可以接收字符串数据,并以该编码方式编码。否则只接收 bytes 类型的数据。
<6>shell:如果该参数为 True,将通过操作系统的shell执行指定的命令。

举一个例子:
   import subprocess
   subprocess.run(["ls", "-l", "/dev/null"]) 
   # 该run()函数只传入了一个参数,就是args,而且该参数是以列表的形式传入的。
   
returncode: 执行完子进程状态,通常返回状态为0则表明它已经运行完毕,若值为负值 "-N",表明子进程被终。

再举一个例子
   import subprocess
   def runcmd(command):
      ret =subprocess.run(command, # 子进程要执行的命令
                          shell=True, # 执行的是shell的命令
                          stdout=subprocess.PIPE,
                          stderr=subprocess.PIPE,
                          encoding="utf-8",
                          timeout=1)
   if ret.returncode == 0: # returncode属性是run()函数返回结果的状态。
       print("success:",ret)
   else:
       print("error:",ret)


   runcmd(["dir","/b"])#序列参数
   runcmd("exit 1")#字符串参数

Popen()方法

Popen 是 subprocess的核心,子进程的创建和管理都靠它处理。
语法如下:
class subprocess.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=False, 
                        startupinfo=None, 
                        creationflags=0,
                        restore_signals=True, 
                        start_new_session=False, 
                        pass_fds=(),
                        *, 
                        encoding=None, 
                        errors=None )
                        
常用参数:
args:shell命令,可以是字符串或者序列类型(如:list,元组)
bufsize:缓冲区大小。当创建标准流的管道对象时使用,默认是-1。
         0代表不使用缓冲区
         1:表示行缓冲,仅当universal_newlines=True时可用,也就是文本模式
         正数:表示缓冲区大小
         负数:表示使用系统默认的缓冲区大小。
stdin, stdout, stderr:分别表示程序的标准输入、输出、错误句柄
preexec_fn:只在 Unix 平台下有效,用于指定一个可执行对象(callable object),它将在子进程运行之前被调用
shell:如果该参数为 True,将通过操作系统的 shell 执行指定的命令。
cwd:用于设置子进程的当前目录。
env:用于指定子进程的环境变量。如果 env = None,子进程的环境变量将从父进程中继承。

创建一个子进程,然后执行一个简单的命令。
   import time
   import subprocess
   p = subprocess.Popen('ls -l', shell=True)

   #Popen的对象所具有的方法:
   #       poll(): 检查进程是否终止,如果终止则返回 returncode,否则返回 None。
   #       wait(timeout): 等待子进程终止。
   #       communicate(input,timeout): 和子进程交互,发送和读取数据。
   #       send_signal(singnal): 发送信号到子进程 。
   #       terminate(): 停止子进程,也就是发送SIGTERM信号到子进程。
   #       kill(): 杀死子进程。发送 SIGKILL 信号到子进程。
 
   def f(command):
       # 创建一个子进程,并且执行
       subprocess = subprocess.Popen(command,
                               shell=True,
                               stdout=subprocess.PIPE,
                               stderr=subprocess.PIPE,
                               encoding="utf-8")
       # 这里是用wait()方法,等待子进程结束。
       subprocess.wait(2)
       if subprocess.poll() == 0:
          print(subprocess.communicate()[1])
       else:
          print("失败")
     
    f("java -version")
    f("exit 1")