【python】-subprocess模块：用来生成新进程、连接到它们的输入/输出/错误管道，并获取它们的返回码

阿寻寻

已于 2023-12-12 16:47:00 修改

阅读量1.1k

点赞数 22

文章标签： python windows 服务器

于 2023-12-12 16:44:57 首次发布

本文链接：https://blog.csdn.net/weixin_46453070/article/details/134952826

版权

subprocess模块

1、基本用法
2、参数说明
3、高级用法
4、注意事项
5、项目示例要求：我做了一个平台，从这个平台传一些参数到服务器，服务器linux执行shell文件打印出来的日志，怎么反显到这个平台上

Python 中的 subprocess 模块是用来生成新进程、连接到它们的输入/输出/错误管道，并获取它们的返回码的。这个模块可以用来替换一些旧的模块和函数，比如： os.system、 os.spawn*、 os.popen*、 popen2.* 和 commands.* 等。使用 subprocess 模块可以更安全地执行和管理子进程。

1、基本用法

subprocess 模块主要提供了一个名为 subprocess.run() 的函数，用于执行指定的命令并等待它完成：

import subprocess

result = subprocess.run(['ls', '-l'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
print("返回码：", result.returncode)
print("有标准输出：\n", result.stdout)
print("有标准错误：\n", result.stderr)

在这个例子中，subprocess.run() 执行了 ls -l 命令，并捕获了它的标准输出和标准错误。

2、参数说明

args：要执行的命令和参数，可以是字符串也可以是参数列表。
stdout、stderr：这些参数用于指定如何处理命令的标准输出和标准错误。subprocess.PIPE 表示将输出和错误捕获到相应的管道中。
text：如果设为 True，则以文本模式而非二进制模式操作文件。
check：如果设为 True，且执行的命令返回非零退出状态，则会抛出 subprocess.CalledProcessError 异常。
encoding：用于解码子进程输出的编码。

3、高级用法

除了 run() 函数之外，subprocess 模块还提供了更高级的功能，如 Popen 类，用于更复杂的用例，比如持续交互、定向输入输出等。

import subprocess

# 使用 Popen
with subprocess.Popen(['grep', 'some_string'], stdin=subprocess.PIPE, stdout=subprocess.PIPE, text=True) as proc:
    output, _ = proc.communicate('Here we have some text\nand some more text')
    print(output)

在这个例子中，我们用 Popen 创建了一个 grep 进程，并通过 communicate() 方法向它发送文本，并读取输出。

4、注意事项

安全性：直接从外部输入构造命令或参数时要特别小心，以避免安全漏洞，如命令注入。
异常处理：当使用 check=True 或处理进程输出时，应妥善处理可能抛出的异常。
资源管理：确保正确管理进程资源，例如使用 with 语句或确保进程正确关闭。

subprocess 是一个强大而灵活的模块，能够处理从简单到复杂的多种子进程创建和管理任务。

5、项目示例要求：我做了一个平台，从这个平台传一些参数到服务器，服务器linux执行shell文件打印出来的日志，怎么反显到这个平台上

要实现从一个平台传递参数到服务器，并且将服务器上执行 Shell 脚本后产生的日志反映回平台上，你需要实现一个基本的客户端-服务器架构。这通常包括以下几个步骤：

1. 平台与服务器间的通信：

平台需要能够通过网络向服务器发送请求。这通常通过HTTP/HTTPS请求实现，可以使用诸如 REST API 的方式来实现。
服务器需要一个监听这些请求的服务（比如一个Web服务器），并根据请求的内容执行相应的 Shell 脚本。

2. 执行 Shell 脚本：

服务器收到请求后，基于传来的参数执行相应的 Shell 脚本。
Shell 脚本的执行结果（日志）需要被捕获。这可以通过将标准输出（STDOUT）和标准错误（STDERR）重定向到一个文件或直接作为响应数据来实现。
在服务器上执行 Shell 脚本

假设你已经有一个 Shell 脚本 script.sh，你希望在服务器上执行它，并捕获其输出。

在 Python 中，你可以使用 subprocess 模块来执行 Shell 脚本并捕获其输出：

import subprocess

def run_shell_script():
    try:
        # 执行 Shell 脚本并捕获输出
        result = subprocess.run(['./script.sh'], check=True, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
        return result.stdout
    except subprocess.CalledProcessError as e:
        # 如果脚本执行出错，返回错误信息
        return e.stderr

3. 将日志数据发送回平台：

执行完 Shell 脚本后，服务器需要将日志数据作为响应发送回请求的平台。
这通常意味着将日志文件的内容读取到内存，然后作为HTTP响应的一部分发送回去。
将执行结果发送回客户端

接下来，你需要将这个执行结果作为 HTTP 响应发送回客户端。使用 Flask 创建一个简单的 API 可以实现这一点：

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/run-script', methods=['GET'])
def run_script():
    output = run_shell_script()
    return jsonify({"output": output})

if __name__ == '__main__':
    app.run(debug=True)

这个 Flask 应用将创建一个 /run-script 的端点，当这个端点被请求时，它会执行 run_shell_script 函数，该函数运行 Shell 脚本并返回其输出。然后，输出以 JSON 格式发送回客户端。

部署服务器

你需要在服务器上部署这个 Flask 应用。这涉及到设置服务器、可能的端口转发、安装 Flask 和任何依赖等步骤。

安全注意事项

输入验证：确保处理从客户端接收的所有输入，避免潜在的安全漏洞（例如，注入攻击）。
错误处理：确保你的应用能够优雅地处理错误（例如，Shell 脚本执行失败）并将错误信息反馈给客户端。
限制访问：确保只有授权的用户可以触发脚本执行。这可能涉及到身份验证机制。
通过这种方式，你的客户端（平台）可以通过向 Flask 应用发送 HTTP 请求来触发 Shell 脚本的执行，并获取脚本执行的结果。

4. 平台上显示日志：

一旦平台收到来自服务器的响应，它需要解析响应内容并在用户界面上适当地显示日志信息。

5. 错误处理：

在整个过程中，错误处理非常关键。这包括网络错误、执行脚本错误等，并且需要将这些错误信息反馈给用户。

技术实现举例：

服务器端：使用如 Node.js, Python (Flask 或 Django) 等后端技术，监听来自平台的HTTP请求，执行 Shell 脚本，并将输出作为响应返回。
Shell 脚本执行：使用诸如 subprocess（Python）来执行 Shell 脚本并捕获输出。
客户端（平台）：可以是一个Web应用或者桌面应用，使用 AJAX 或其他方法发送 HTTP 请求，并接收响应来显示日志。