Python 之 subprocess 模块教程

前言

subprocess模块是Python标准库中的一个模块，用于创建和管理子进程。subprocess 模块允许我们启动一个新进程，并连接到它们的输入/输出/错误管道，从而获取返回值。使用上比 os.system(cmd) 更友好。

常用函数

subprocess.run(command)

subprocess.run(command, shell=True, stdin=None, stdout=subprocess.PIPE, stderr=subprocess.PIPE, encoding=“utf-8”, timeout=1,check=False )

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

import subprocess
def runcmd(command):
    ret = subprocess.run(command,shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE,encoding="utf-8",timeout=1)
    if ret.returncode == 0:
        print("success:",ret)
    else:
        print("error:",ret)

subprocess.getoutput()

subprocess.getoutput() 和 subprocess.getstatusoutput() 函数是来自 Python 2.x 的 commands 模块的两个遗留函数。它们隐式的调用系统shell，并且不保证其他函数所具有的安全性和异常处理的一致性。它们从Python 3.3.4开始才支持Windows平台。

import subprocess
def runcmd(command):
    subprocess.getoutput(command)
 	#subprocess.getstatusoutput(command)

subprocess.call()

执行指定的命令，返回命令执行状态，其功能类似于os.system(cmd)。call()和check_call()函数返回的是命令执行的状态码，而不是CompletedProcess类实例，所以对于它们而言，stdout和stderr不适合赋值为subprocess.PIPE；

import subprocess
def runcmd(command):
    subprocess.call(command)
	#subprocess.check_call(command)

subprocess.Popen

Popen 是 subprocess的核心，子进程的创建和管理都靠它处理。上面介绍的call(), run() 等函数都是基于subprocess.Popen类实现的。

构造函数

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)

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

Popen 对象方法

1. poll() : 检查进程是否终止，如果终止返回 returncode，否则返回 None。
2. wait(timeout) : 等待子进程终止。
3. communicate(input,timeout) : 和子进程交互，发送和读取数据。
4. send_signal(singnal) : 发送信号到子进程 。
5. terminate() : 停止子进程,也就是发送SIGTERM信号到子进程。
6. kill() : 杀死子进程。发送 SIGKILL 信号到子进程。

import time
import subprocess

def runcmd(command):
    subp = subprocess.Popen(command,shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE,encoding="utf-8")
    subp.wait(2)
    if subp.poll() == 0:
        print(subp.communicate()[1])
    else:
        print("失败")


runcmd("ls -l")

参考

subprocess — Subprocess managemen