Python subprocess 模块

Python subprocess 模块中文讲解

关键点

功能：subprocess 模块用于在 Python 中创建和管理子进程，执行外部命令，并与它们的输入/输出/错误流交互。
主要接口：推荐使用 subprocess.run() 执行简单命令，subprocess.Popen() 提供更灵活的控制。
线程安全：模块设计确保安全执行外部命令，适合多线程或复杂任务。
注意事项：使用 shell=True 时需谨慎，避免 shell 注入风险。
应用场景：常用于运行系统命令、调用外部程序或处理复杂进程交互。

模块简介

Python 的 subprocess 模块是标准库的一部分，用于启动新的子进程，连接它们的输入、输出和错误管道，并获取返回码。它是替代旧模块（如 os.system 和 os.popen）的现代工具，提供更强大的功能和更高的安全性。

主要功能

执行外部命令：可以运行 shell 命令或其他可执行程序。
输入/输出管理：支持与子进程的 stdin、stdout 和 stderr 交互。
返回码处理：获取命令执行的状态（0 表示成功，非 0 表示失败）。

使用示例

以下是一个简单的示例，展示如何使用 subprocess.run() 执行 ls -l 命令并捕获输出：

import subprocess
result = subprocess.run(['ls', '-l'], capture_output=True, text=True)
print(result.stdout)

安全提示

使用 shell=True 时需小心，尤其是处理用户输入时，建议使用列表形式的 args 参数以避免安全风险。

详细报告

模块概述

Python 的 subprocess 模块是标准库中的一个重要组件，设计用于创建和管理子进程。它允许开发者在 Python 程序中执行外部命令（如 shell 命令或其他可执行程序），并与这些命令的输入、输出和错误流进行交互。该模块自 Python 2.4 引入，旨在替代旧的模块和函数，如 os.system、os.spawn* 和 os.popen*，提供更安全、更灵活的功能。根据 Python 官方文档，subprocess 模块支持在非移动平台（如 Android、iOS 和 WASI）上运行，广泛应用于系统管理、自动化脚本和复杂进程交互。

关键功能与接口

subprocess 模块提供了多种函数和类，以下是主要接口的详细说明：

接口	描述	适用场景
`subprocess.run()`	执行命令并等待完成，返回 `CompletedProcess` 对象，包含返回码、输出和错误信息。	简单命令执行，需捕获输出或检查返回码。
`subprocess.Popen()`	创建子进程，提供灵活控制，允许实时交互。	复杂场景，如需要与子进程的输入/输出流交互。
`subprocess.call()`	执行命令并返回状态码，较老的接口。	简单命令执行，不需捕获输出。
`subprocess.check_call()`	类似 `call()`，但返回非 0 状态码时抛出 `CalledProcessError`。	需要确保命令成功执行的场景。
`subprocess.check_output()`	执行命令并返回标准输出，失败时抛出异常。	需要获取命令输出的场景。

`subprocess.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)
关键参数：
args：要执行的命令，可以是字符串（需 shell=True）或列表（如 ["ls", "-l"]）。
stdin, stdout, stderr：控制输入/输出流，可设置为 subprocess.PIPE（管道）、subprocess.DEVNULL（丢弃）或文件对象。
capture_output：若为 True，自动捕获 stdout 和 stderr（Python 3.7+）。
shell：若为 True，通过 shell 执行命令。
timeout：设置命令超时时间（秒），超时抛出 TimeoutExpired 异常。
check：若为 True，返回非 0 状态码时抛出 CalledProcessError。
text：若为 True，以文本模式处理输入/输出（Python 3.7+）。
返回值：CompletedProcess 对象，包含 args、 returncode、 stdout 和 stderr。
示例：

import subprocess
result = subprocess.run(["dir", "/b"], capture_output=True, text=True)
print(f"success: {result}")

输出示例：success: CompletedProcess(args=['dir', '/b'], returncode=0, stdout='test.py\n', stderr='')

`subprocess.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, encoding=None, errors=None)
关键参数：
args：命令，字符串或列表/元组。
bufsize：缓冲区大小，-1 表示系统默认，0 表示无缓冲，1 表示行缓冲（仅文本模式）。
shell：是否通过 shell 执行。
cwd：设置子进程的工作目录。
env：设置子进程的环境变量，None 表示继承父进程环境。
方法：
poll()：检查进程是否终止，返回 returncode 或 None。
wait(timeout)：等待进程终止，可设置超时。
communicate(input, timeout)：与进程交互，返回 (stdout_data, stderr_data) 元组。
terminate()：发送 SIGTERM 信号。
kill()：发送 SIGKILL 信号。
示例：

import subprocess
process = subprocess.Popen("ls -l", shell=True, stdout=subprocess.PIPE)
output, error = process.communicate()
print(output.decode())

安全注意事项

避免 shell 注入：使用 shell=True 时，需确保输入经过严格验证，建议使用 shlex.quote() 转义用户输入。
优先使用列表形式的 args：如 ["ls", "-l"] 而非 "ls -l"，以提高安全性。
环境变量管理：设置 env 参数时，确保只包含必要变量，避免泄露敏感信息。

应用场景

系统管理：执行 shell 命令，如磁盘统计（df -h）或文件操作。
自动化脚本：批量运行外部工具或脚本。
进程交互：实时读取子进程输出或向其发送输入，如与命令行工具交互。

版本演进

Python 3.5：引入 subprocess.run() 和 CompletedProcess 类。
Python 3.6：添加 encoding 和 errors 参数，支持文本编码。
Python 3.7：添加 capture_output 和 text 参数，简化输出捕获。
Python 3.12：调整 Windows 上 shell=True 的 shell 搜索顺序。

与其他模块对比

模块/方法	优点	缺点
`os.system`	简单，适合快速执行命令	无输出捕获，安全性低
`os.popen`	支持输出捕获	功能有限，安全性较低
`subprocess`	功能强大，安全，灵活	学习曲线稍陡

最佳实践

优先使用 run()：对于简单任务，run() 提供简洁的接口。
使用 Popen 进行复杂交互：如需要实时处理输入/输出流。
设置超时：避免命令无限挂起。
捕获输出：使用 capture_output=True 或 stdout=subprocess.PIPE 获取结果。
异常处理：捕获 CalledProcessError 和 TimeoutExpired 以处理错误。

总结

subprocess 模块是 Python 中管理子进程的首选工具，提供了从简单命令执行到复杂进程交互的全面支持。通过 run() 和 Popen()，开发者可以轻松实现系统命令调用、输出捕获和进程管理，同时保持高安全性和灵活性。

关键引用：