如何使用python的subprocess执行命令、交互、等待、是否结束及解析JSON结果

前言

Python的subprocess模块提供了一种在Python中调用外部命令的方法。它允许您在Python程序中启动新进程，连接到它们的输入/输出/错误管道，并等待它们完成。

常用用法

下面是一些subprocess模块的常用用法：

• 运行外部命令并获取输出：

import subprocess

output = subprocess.check_output(["ls", "-l"])
print(output.decode())

• 运行外部命令并获取返回值：

import subprocess

return_code = subprocess.call(["ls", "-l"])
print(return_code)

• 运行外部命令并将输出重定向到文件：

import subprocess

with open("output.txt", "w") as f:
    subprocess.call(["ls", "-l"], stdout=f)

• 运行外部命令并将输入从文件中读取：

import subprocess

with open("input.txt", "r") as f:
    subprocess.call(["grep", "hello"], stdin=f)

• 运行外部命令并将输入从Python程序中提供：

import subprocess

subprocess.call(["grep", "hello"], input=b"hello world
")

• 运行外部命令并捕获标准错误：

import subprocess

try:
    subprocess.check_output(["ls", "-l", "/nonexistent"])
except subprocess.CalledProcessError as e:
    print(e.stderr.decode())

• 运行外部命令并等待它完成：

import subprocess

p = subprocess.Popen(["sleep", "5"])
p.wait()
print("Done")

以上是subprocess模块的一些常用用法，更多详细信息请参考Python官方文档。

创建一个新的进程

Python的subprocess模块中的Popen函数用于创建一个新的进程，并与其进行交互。Popen函数的语法如下：

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)

参数说明：

• args：要执行的命令，可以是一个字符串或一个列表。如果是一个字符串，则会被解释为一个shell命令；如果是一个列表，则第一个元素是要执行的命令，后面的元素是命令的参数。
• bufsize：缓冲区大小，默认为-1，表示使用系统默认值。
• executable：要执行的可执行文件的路径，默认为None，表示使用系统默认的可执行文件。
• stdin、stdout、stderr：分别表示标准输入、标准输出、标准错误输出的文件描述符。默认为None，表示使用父进程的标准输入、标准输出、标准错误输出。
• preexec_fn：在子进程执行前被调用的可执行对象，可以是一个函数或一个可调用对象。默认为None。
• close_fds：如果为True，则在子进程中关闭所有文件描述符。默认为True。
• shell：如果为True，则将args作为一个shell命令执行。默认为False。
• cwd：子进程的当前工作目录。默认为None，表示使用父进程的当前工作目录。
• env：子进程的环境变量。默认为None，表示使用父进程的环境变量。
• universal_newlines：如果为True，则将stdin、stdout、stderr的数据以文本模式处理。默认为False。
• startupinfo：用于指定子进程的一些启动信息，如窗口大小、标题等。默认为None。
• creationflags：用于指定子进程的一些标志，如CREATE_NEW_CONSOLE、CREATE_NEW_PROCESS_GROUP等。默认为0。

Popen函数返回一个Popen对象，可以通过该对象的方法和属性与子进程进行交互，如：

• communicate(input=None, timeout=None)：与子进程进行交互，发送input数据并等待子进程执行完毕。如果timeout不为None，则在指定时间内等待子进程执行完毕。
• poll()：检查子进程是否已经结束，如果已经结束则返回子进程的退出状态码，否则返回None。
• wait(timeout=None)：等待子进程执行完毕，并返回子进程的退出状态码。如果timeout不为None，则在指定时间内等待子进程执行完毕。
• send_signal(signal)：向子进程发送信号。
• terminate()：向子进程发送SIGTERM信号，终止子进程。
• kill()：向子进程发送SIGKILL信号，强制终止子进程。
• pid：子进程的进程ID。
• returncode：子进程的退出状态码。

示例代码：

import subprocess

# 执行一个简单的命令
p = subprocess.Popen('ls -l', shell=True)
p.wait()

# 执行一个带参数的命令
p = subprocess.Popen(['ls', '-l'], stdout=subprocess.PIPE)
output, error = p.communicate()
print(output.decode())

# 执行一个长时间运行的命令，并在指定时间内等待其执行完毕
p = subprocess.Popen('sleep 10', shell=True)
try:
    p.wait(timeout=5)
except subprocess.TimeoutExpired:
    p.kill()

与子进程进行交互

communicate()是subprocess模块中的一个方法，用于与子进程进行交互。它会向子进程的标准输入发送数据，并等待子进程完成任务后获取其标准输出和标准错误输出。

communicate()方法的语法如下：

stdout, stderr = subprocess.communicate(input=None, timeout=None)

其中，input参数是要发送给子进程的数据，可以是字符串或字节流。如果不需要向子进程发送数据，则可以将其设置为None。timeout参数是等待子进程完成任务的超时时间，单位为秒。如果子进程在超时时间内未完成任务，则会抛出TimeoutExpired异常。

communicate()方法会返回一个元组，其中第一个元素是子进程的标准输出，第二个元素是子进程的标准错误输出。如果子进程没有输出，则对应的元素为None。

下面是一个使用communicate()方法的示例：

import subprocess

# 执行命令
p = subprocess.Popen(['ls', '-l'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)

# 获取子进程的输出
stdout, stderr = p.communicate()

# 输出子进程的标准输出和标准错误输出
print(stdout.decode('utf-8'))
print(stderr.decode('utf-8'))

在上面的示例中，我们使用Popen()方法创建了一个子进程，并将其标准输出和标准错误输出分别重定向到管道中。然后，我们使用communicate()方法等待子进程完成任务，并获取其标准输出和标准错误输出。最后，我们将其转换为字符串并输出。

执行结果解析成json格式

可以使用Python的json模块将subprocess执行结果解析成json格式。

假设subprocess执行的命令是获取系统信息的命令，如下所示：

import subprocess

cmd = "systeminfo"
result = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)

执行结果保存在result变量中，可以使用json模块将其解析成json格式，如下所示：

import json

output = result.stdout.decode('utf-8')
json_output = json.loads(output)

其中，result.stdout是subprocess执行结果的标准输出，使用decode方法将其转换成字符串类型。然后使用json.loads方法将字符串解析成json格式。

解析后的json格式可以按照需要进行处理和使用。

检查子进程是否已经结束

在subprocess中，poll()方法用于检查子进程是否已经结束。如果子进程已经结束，poll()方法会返回子进程的退出状态码。如果子进程还在运行，poll()方法会返回None。

下面是一个使用poll()方法的示例：

import subprocess

# 启动子进程
p = subprocess.Popen(['ls', '-l'])

# 检查子进程是否已经结束
while p.poll() is None:
    print('子进程还在运行...')
    
# 子进程已经结束，获取退出状态码
print('子进程已经结束，退出状态码为：', p.returncode)

在上面的示例中，我们启动了一个子进程来执行ls命令，然后使用poll()方法检查子进程是否已经结束。如果子进程还在运行，就会一直输出“子进程还在运行…”，直到子进程结束。当子进程结束后，我们使用returncode属性获取子进程的退出状态码，并输出到控制台。

等待子进程结束

在subprocess模块中，wait()方法用于等待子进程结束并返回状态码。它会阻塞当前进程，直到子进程结束为止。

wait()方法的语法如下：

status = subprocess.Popen.wait(self, timeout=None, endtime=None)

其中，timeout参数表示等待子进程结束的最长时间，单位为秒；endtime参数表示等待子进程结束的最晚时间，是一个时间戳。

如果子进程已经结束，wait()方法会立即返回状态码；如果子进程还在运行，wait()方法会阻塞当前进程，直到子进程结束为止。

wait()方法返回的状态码是一个整数，表示子进程的退出状态。如果子进程正常结束，状态码为0；如果子进程异常结束，状态码为一个非零值，具体的值表示异常的类型。

判断是否执行成功

在Python中，可以使用subprocess模块的returncode属性来判断子进程是否执行成功。如果子进程成功执行，returncode属性的值为0；如果子进程执行失败，returncode属性的值为非零。可以通过以下代码来实现：

import subprocess

# 执行命令
result = subprocess.run(['ls', '-l'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)

# 判断是否执行成功
if result.returncode == 0:
    print('执行成功')
else:
    print('执行失败')

在上面的代码中，我们使用subprocess.run()方法执行了一个ls -l命令，并将结果保存在result变量中。然后，我们通过判断result.returncode的值来判断子进程是否执行成功。如果returncode的值为0，则表示执行成功；否则，表示执行失败。

总结

到此这篇关于如何使用python的subprocess执行命令、交互、等待、是否结束及解析JSON结果的文章就介绍到这了,更多相关python subprocess模块用法内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论