python subprocess实时输出

原创

mob64ca12eab427 2024-09-27 05:15:36 ©著作权

文章标签 子进程 python 标准输出 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12eab427的原创作品，请联系作者获取转载授权，否则将追究法律责任

使用 Python 的 subprocess 模块实现实时输出

作为一名新手开发者，你的首个挑战之一可能是如何实时输出来自子进程的结果。在 Python 中，这个需求可以通过 subprocess 模块轻松实现。这篇文章将引导你逐步理解如何做到这一点，并提供必要的代码示例。

流程概述

为了实现实时输出，我们将按照以下步骤进行操作：

步骤	描述
1. 导入模块	导入所需的 Python 模块
2. 创建子进程	使用 `subprocess.Popen()` 创建一个子进程
3. 实时读取输出	使用标准输出流（stdout）实时读取子进程输出
4. 处理输出	根据需要处理输出来进行其他操作
5. 关闭子进程	等待子进程结束并整理资源

步骤详细讲解

1. 导入模块

首先，我们需要导入 subprocess 模块，也可能需要用到 sys 模块来处理标准输出。在 Python 中，模块的导入是非常基础且重要的步骤。

import subprocess  # 导入 subprocess 模块用于创建和管理子进程
import sys          # 导入 sys 模块以便处理标准输出

2. 创建子进程

我们使用 subprocess.Popen() 方法来创建一个新的子进程。这个方法允许我们设定一些参数，比如需要执行的命令和选项。

# 创建一个子进程，执行 'ping' 命令并实时输出
process = subprocess.Popen(
    ['ping', '127.0.0.1'],    # 要执行的命令和参数
    stdout=subprocess.PIPE,    # 将标准输出重定向到管道
    stderr=subprocess.PIPE,     # 将标准错误重定向到管道
    text=True,                  # 使用文本模式而不是字节模式
    bufsize=1                   # 设定缓冲区大小
)

上述代码中：

stdout=subprocess.PIPE 表示我们希望捕获输出。
stderr=subprocess.PIPE 表示我们希望捕获错误输出。
text=True 表示我们希望处理字符串而不是字节。
bufsize=1 使得输出流是行缓冲的，便于实时读取。

3. 实时读取输出

我们使用一个循环来实时读取输出数据。通过 iter() 函数，这个循环可以不断获取输出，直到子进程完成。

# 实时读取子进程的标准输出
try:
    for line in iter(process.stdout.readline, ''):
        sys.stdout.write(f'Received: {line}')  # 输出接收到的每一行
        sys.stdout.flush()  # 刷新输出缓冲区，确保立刻显示
except Exception as e:
    print(f'An error occurred: {e}')
finally:
    process.stdout.close()  # 确保关闭标准输出管道

在这里：

iter(process.stdout.readline, '') 会不断读取每一行，直到返回一个空字符串。
sys.stdout.flush() 是确保输出能实时显示到控制台。

4. 处理输出

在处理子进程的输出时，你可以根据需要对数据进行不同的处理，比如解析内容、过滤信息等。下面是一个基本的示例，假设我们只对 "Reply" 开头的行感兴趣。

try:
    for line in iter(process.stdout.readline, ''):
        if 'Reply' in line:
            sys.stdout.write(f'Received Reply: {line}')  # 只处理包含 'Reply' 的行
            sys.stdout.flush()
except Exception as e:
    print(f'An error occurred while processing output: {e}')
finally:
    process.stdout.close()

5. 关闭子进程

一旦子进程完成，我们需要等待其结束。这可以通过 process.wait() 方法实现。

process.wait()  # 等待子进程完成

状态图

我们通过 Mermaid 语法创建一个简单的状态图来表示这个过程：

stateDiagram-v2
    [*] --> ImportModules
    ImportModules --> CreateProcess
    CreateProcess --> ReadOutput
    ReadOutput --> ProcessOutput
    ProcessOutput --> CloseProcess
    CloseProcess --> [*]

整体代码示例

将上述所有步骤组合在一起，我们得到了一个完整的程序示例：

import subprocess  # 导入 subprocess 模块
import sys          # 导入 sys 模块

# 创建一个子进程，需根据实际情况修改命令
process = subprocess.Popen(
    ['ping', '127.0.0.1'],
    stdout=subprocess.PIPE,
    stderr=subprocess.PIPE,
    text=True,
    bufsize=1
)

try:
    # 实时读取和处理输出
    for line in iter(process.stdout.readline, ''):
        if 'Reply' in line:  # 处理包含 'Reply' 的行
            sys.stdout.write(f'Received Reply: {line}')
            sys.stdout.flush()
except Exception as e:
    print(f'An error occurred: {e}')
finally:
    process.stdout.close()  # 关闭标准输出管道

process.wait()  # 等待子进程完成