使用 Python 执行 Shell 命令并获取输出的完整指南
在开发过程中，我们常常需要执行一些系统命令或脚本。这些命令可以用 shell 脚本写成，也可以是各种命令行工具。Python 提供了几种方法来实现这个功能，尤其是通过 subprocess 模块实现。本文将详细介绍如何在 Python 中执行 shell 命令并获取输出，分步讲解整个流程，以及每一步所需的代码示例。
流程概述
我们将通过以下步骤实现这个目标：
| 步骤 | 描述 |
|---|---|
| 1 | 导入所需的模块 |
| 2 | 使用 subprocess.run() 执行命令 |
| 3 | 处理输出 |
| 4 | 错误处理 |
| 5 | 测试和验证 |
接下来，我们将逐步深入每一个步骤，讲解所需代码以及相关注释。
1. 导入所需的模块
在 Python 中，我们需要使用 subprocess 模块来执行 shell 命令。首先，我们需要导入该模块。
import subprocess # 导入 subprocess 模块，用于执行外部命令
2. 使用 subprocess.run() 执行命令
现在我们需要使用 subprocess.run() 方法来执行 shell 命令，以下是执行命令的代码示例：
result = subprocess.run(['echo', 'Hello, World!'], # 执行 shell 命令 'echo Hello, World!'
capture_output=True, # 捕获输出
text=True) # 将输出以文本方式返回
代码解析
subprocess.run()是一个方便的方法，用于执行外部命令。- 第一个参数是一个列表，包含我们要执行的命令和参数。在这个例子中，我们想要运行
echo Hello, World!。 capture_output=True表示我们希望捕获命令的标准输出和错误输出。text=True参数表示我们希望输出以字符串形式返回，而不是字节。
3. 处理输出
执行命令后，我们需要处理命令的输出，以便在 Python 程序中进行使用：
# 输出命令的标准输出
print("标准输出: ", result.stdout) # 打印标准输出
# 输出命令的错误输出
if result.stderr: # 检查是否有错误输出
print("错误输出: ", result.stderr) # 打印错误输出
代码解析
result.stdout包含我们命令的标准输出。result.stderr包含命令的错误输出。如果一切正常，通常不会有错误输出。
4. 错误处理
在执行命令时，有可能出现错误或异常情况。我们可以通过捕获异常来处理这些情况：
try:
result.check_returncode() # 检查命令的返回值，如果非零则抛出异常
except subprocess.CalledProcessError as e:
print(f"命令失败，返回码: {e.returncode}") # 打印错误代码信息
代码解析
check_returncode()方法会检查命令的返回状态，如果返回码非零，会抛出CalledProcessError异常。- 捕获异常后，我们能够获取到命令失败的原因，并进行相应处理。
5. 测试和验证
最后，我们可以将所有代码合并，并进行测试：
import subprocess # 导入 subprocess 模块
try:
result = subprocess.run(['echo', 'Hello, World!'], # 执行命令
capture_output=True, # 捕获输出
text=True) # 文本输出
print("标准输出: ", result.stdout) # 打印输出
if result.stderr: # 检查是否有错误输出
print("错误输出: ", result.stderr)
result.check_returncode() # 检查返回码
except subprocess.CalledProcessError as e:
print(f"命令失败，返回码: {e.returncode}") # 打印错误信息
状态图
在上述步骤中，我们可以用 Mermaid 的状态图来展示执行过程的状态：
stateDiagram
[*] --> 开始
开始 --> 导入模块
导入模块 --> 执行命令
执行命令 --> 处理输出
处理输出 --> 错误处理
错误处理 --> 结束
结束 --> [*]
序列图
接下来，我们也可以用 Mermaid 的序列图表示命令执行的交互过程：
sequenceDiagram
participant User
participant Python
User->>Python: 执行 shell 命令
Python->>Shell: 运行命令
Shell-->>Python: 返回标准输出和错误输出
Python->>User: 输出结果
总结
通过本指南，你学习了如何在 Python 中执行 shell 命令并获取输出。整个过程包括导入模块、执行命令、处理输出、错误处理及最终测试。希望这篇文章能帮助你在实际项目中更好地运用 Python 与系统命令的结合，提高你的开发效率。
如果你在使用过程中遇到问题，欢迎留言交流！
