Python3 subprocess模块简介

  • subprocess 模块简介
  • run 方法
  • Popen() 方法
  • Popen 对象方法


subprocess 模块简介

subprocess模块主要用于创建子进程，并连接它们的输入、输出和错误管道，获取它们的返回状态。换句话来说呢，就是通过这个模块，我们可以在Python代码中执行操作系统级别的命令，比如：ifconfig,du -sh,sudo等等。

subprocess模块优先推荐使用run方法，更加高级的方法可以直接使用Popen接口。

run 方法

run 方法的使用格式如下：

#coding:utf-8
import subprocess

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

run 方法调用方式返回 CompletedProcess实例，和直接Popen差不多，实现是一样的，实际也是调用Popen，与Popen构造函数的方法大致相同。例如：

#coding:utf-8
#执行ls -l /dev/null 命令
import subprocess
subprocess.sun(['ls','-l','/dev/null'])
crw-rw-rw- 1 root wheel 3, 2 5 4 13:34 /dev/null
 CompletedProcess(args=[‘ls’, ‘-l’, ‘/dev/null’], returncode=0)


returncode: 执行完子进程状态，通常返回状态为0则表明它已经运行完毕，若值为负值 “-N”,表明子进程被终。

简单实例：

#coding:utf-8
import subprocess

def runcmd(command):
    ret = subprocess.run(command,shell=Ture,stdout=subprcess.PIPE,encoding='utf-8',timeout=1)
    if ret.returncode == 0:
        print('success:%'% ret)
    else:
        print('error:%'% ret)
if __name__ == "__main__":
    runcmd(["dir","/b"])#序列参数
    runcmd("exit 1")#字符串参数

输出结果如下：

success: CompletedProcess(args=[‘dir’, ‘/b’], returncode=0, stdout=‘test.py\n’, stderr=’’)
 error: CompletedProcess(args=‘exit 1’, returncode=1, stdout=’’, stderr=’’)

Popen() 方法

Popen 是subprocess的核心，子进程的创建和管理都靠它处理。
构造函数如下

#coding:utf-8
import subprocess
def runcmd(command):
    ret = subprocess.Popen(args,bufsize==-1,executable=None,stdin=None,stdout=None,stderr=None,prexec_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)

常用参数：

  1. args: shell命令,可以是字符串，或者序列类型（如：list，元组）。
  2. bufsize:缓冲区大小。当创建标准流的管道对象时使用，默认-1.
    0：不使用缓冲区
    1：表示行缓冲，仅当universal_newlines=True时可用，也就是文本模 式。
    正数：表示缓冲区大小。
    负数：表示使用系统默认的缓冲区大小。
  3. stdin,stdout,stderr: 分别表示程序的标准输入、输出、错误句柄。
  4. preexec_fn：只在 Unix 平台下有效，用于指定一个可执行对象（callable object），它将在子进程运行之前被调用。
  5. cwd：用于设置子进程的当前目录。
  6. 6.env：用于指定子进程的环境变量。如果 env = None，子进程的环境变量将从父进程中继承。
  7. shell：如何设置为Ture，将通过操作系统的shell执行指定命令。

创建一个子进程，然后执行一个简单的命令:

#coding:utf-8
import subprocess
p = subprocess.Popen('ls -l',shell=True)
p = subprocess.Popen(['ls','-cl'])

Popen 对象方法

  1. poll():检查进程是否终止，如果终止返回returncode，否则返回 None。
  2. wait(timeout):等待子进程终止。
  3. communicate(input,timeout):和子进程交互，发送和读取数据。
  4. send_signal(singnal):发送信号到子进程。
  5. terminate():停止子进程，也就是发送SIGTERM信号到子进程
  6. kill():杀死子进程。发送SIGKILL信号到子进程。
#coding:utf-8
import subprocess
import time
def runcmd(command):
    subp = subprocess.Popen(command,shell=True,stdout=subprocess.PIPE,encoding='uf-8')
    subp.wait(2)
    if subp.poll() == 0:
        print:(subp.communicate()[1])
    else:
        print:('失败')

if __name__ == "__main__":
    cmd("java -version")
    cmd("exit 1")

输出结果如下：

java version “1.8.0_31”
Java™ SE Runtime Environment (build 1.8.0_31-b13)
Java HotSpot™ 64-Bit Server VM (build 25.31-b07, mixed mode)

失败