subprocess

前言

• subprocess模块可以运行子进程并管理它们的输入流与输出流。
• 子进程能够跟Python解释器所在的进程并行，从而充分利用各CPU核心。
• 要开启子进程，最简单的办法就是调用run函数，另外也可以通过Popen类实现类似UNIX管道的高级用法。调用communicate方法时可以指定timeout参数，让我们有机会把陷入死锁或已经卡住的子进程关掉。
• 替代其他几个老的模块或者函数，比如：os.system os.spawn* os.popen* popen2.* commands.*

核心内容

run

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

subprocess.run(args, *, input=None,
stdin=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)

参数说明：

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

返回值

• run 方法调用方式返回 CompletedProcess 实例，和直接 Popen 差不多，实现是一样的，实际也是调用 Popen，与 Popen 构造函数大致相同
• returncode: 执行完子进程状态，通常返回状态为0则表明它已经运行完毕，若值为负值 “-N”,表明子进程被终。

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)

runcmd(["ls","/"])#序列参数
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，子进程的环境变量将从父进程中继承。

Popen 对象方法

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

import time
import subprocess

def cmd(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("失败")
cmd("java -version")
cmd("exit 1")

参考文档

1. https://www.runoob.com/w3cnote/python3-subprocess.html
2. https://blog.csdn.net/maosijunzi/article/details/80138458
3. https://blog.csdn.net/ll641058431/article/details/84930394