python之subprocess

python之执行shell命令

python 执行shell命令，且执行完后将shell端的输出返回

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

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)

• 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 构造函数大致相同，例如:

实例
#执行ls -l /dev/null 命令
>>> subprocess.run(["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",表明子进程被终。

实例
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(["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的核心，子进程的创建和管理都靠它处理。

构造函数：

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 subprocess
>>> p = subprocess.Popen('ls -l', shell=True)
>>> total 164
-rw-r--r--  1 root root   133 Jul  4 16:25 admin-openrc.sh
-rw-r--r--  1 root root   268 Jul 10 15:55 admin-openrc-v3.sh
...
>>> p.returncode
>>> p.wait()
0
>>> p.returncode

这里也可以使用 p = subprocess.Popen(['ls', '-cl']) 来创建子进程。

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")
输出结果如下：

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

简单实例：

subprocess#

import subprocess

# 要执行的命令
command = "ls -lrt"

# 执行命令
process = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)

# 等待命令执行完成
process.wait()

# 获取命令的输出和错误信息
output = process.stdout.read()
error = process.stderr.read()

# 将输出和错误信息解码为字符串
output = output.decode(encoding="gbk")
error = error.decode(encoding="gbk")

# 返回命令的输出和错误信息
result = {"output": output, "error": error}
print(result)

​ 在这段代码中，我们使用 subprocess.run() 方法执行了 ls -l 命令，并将结果保存在 output 变量中。然后，我们调用了 stdout.decode() 方法将输出解码为字符串，并打印结果。
注意，在调用 subprocess.run() 时，我们传入了两个参数：shell=True 和 stdout=subprocess.PIPE。shell=True 表示要使用 shell 来执行命令，而 stdout=subprocess.PIPE 则表示将命令的标准输出保存在 output.stdout 中。

process.wait()#

process.wait() 方法用来等待一个子进程执行完毕。它会阻塞当前线程，直到子进程结束。

例如，如果我们使用如下代码来启动一个子进程：

import subprocess

# 启动一个子进程，执行命令 'sleep 5'
process = subprocess.Popen(['sleep', '5'])

# 等待子进程执行完毕
process.wait()

在这个例子中，我们启动了一个子进程，并让它执行 'sleep 5' 命令。这个命令会让子进程挂起 5 秒钟。接着，我们使用 process.wait() 方法等待子进程执行完毕。这个方法会阻塞当前线程，直到子进程结束，然后才会继续执行后面的代码。

process.communicate(timeout=20)#

​ 如果想设置执行超时时间，需要使用

output, error = process.communicate(timeout=20)

这段代码用来启动一个子进程，并与该进程通信。

process.communicate() 方法会在子进程执行完毕后返回两个值：子进程的输出和错误信息。

这段代码中的 timeout 参数指定了最长等待时间，单位是秒。如果在规定时间内子进程还未执行完毕，那么将会抛出一个 TimeoutExpired 异常。

例如，如果我们使用如下代码来执行一个子进程：

import subprocess

# 启动一个子进程，执行命令 'sleep 5'
process = subprocess.Popen(['sleep', '5'])

# 等待子进程执行完毕，最长等待时间为 20 秒
try:
    output, error = process.communicate(timeout=20)
except subprocess.TimeoutExpired:
    print('TimeoutExpired')

os.system()

import os

# 要执行的命令
command = "ls -l"

# 执行命令
output = os.system(command)

# 输出结果
print(output)

os.system() 方法执行了 ls -l 命令，并将结果保存在 output 变量中。然后，我们打印了 output 的值。
虽然使用 os.system() 方法可以执行 shell 命令，但它没有 subprocess.run() 方法那么强大。例如，os.system() 方法无法将命令的标准输出保存在变量中，因此无法对输出进行进一步的处理。
因此，如果您需要对命令的输出进行进一步的处理，建议使用 subprocess 模块。如果只需要执行命令，则可以使用 os.system() 方法。

如果要从性能的角度考虑，推荐使用 subprocess 模块来执行 shell 命令。相比于其他方法，subprocess 模块能够更快地执行命令，并且可以将命令的标准输出保存在变量中，方便进一步的处理。