如何使用 Python 的 subprocess 获取输出内容和返回码
在 Python 中，有时我们需要调用外部命令并获取它们的输出内容和返回码。为了实现这个功能，我们可以使用 subprocess 模块。本文将向您展示如何完成这一过程，步骤清晰明确，适合刚入行的小白。
流程概述
按照以下步骤来实现我们的目标：
| 步骤 | 描述 |
|---|---|
| 1 | 导入 subprocess 模块 |
| 2 | 使用 subprocess.run() 调用命令 |
| 3 | 获取输出内容 |
| 4 | 获取返回码 |
| 5 | 处理输出内容和返回码 |
详细步骤及代码实现
1. 导入 subprocess 模块
首先，我们需要导入 subprocess 模块，以便能够使用其功能。
import subprocess # 导入 subprocess 模块
2. 使用 subprocess.run() 调用命令
接下来，我们可以使用 subprocess.run() 方法执行我们想要的命令。这里我们以运行一个简单的 echo 命令为例。
result = subprocess.run(['echo', 'Hello, World!'],
capture_output=True, # 捕获输出
text=True) # 以文本格式返回输出
3. 获取输出内容
执行命令后，我们可以从 result 对象中获取输出内容。输出内容会存储在 stdout 属性中。
output = result.stdout # 获取标准输出内容
print("输出内容:", output) # 打印输出内容
4. 获取返回码
此外，您还可以获取命令的返回码，通过 returncode 属性来判断命令是否成功执行（返回码为0表示成功）。
return_code = result.returncode # 获取返回码
print("返回码:", return_code) # 打印返回码
5. 处理输出内容和返回码
最后，您可以根据输出内容和返回码进行相应的处理。例如：
if return_code == 0:
print("命令成功执行")
else:
print("命令执行失败，返回码:", return_code)
完整代码示例
将以上步骤整合，您将得到以下完整代码示例：
import subprocess # 导入 subprocess 模块
result = subprocess.run(['echo', 'Hello, World!'],
capture_output=True,
text=True)
output = result.stdout # 获取标准输出内容
print("输出内容:", output) # 打印输出内容
return_code = result.returncode # 获取返回码
print("返回码:", return_code) # 打印返回码
if return_code == 0:
print("命令成功执行")
else:
print("命令执行失败，返回码:", return_code)
甘特图展示
以下是用 Mermaid 语法展示的甘特图，帮助您查看整个执行过程：
gantt
title Python subprocess 流程
dateFormat YYYY-MM-DD
section 步骤
导入模块 :done, des1, 2023-02-01, 1d
调用命令 :active, des2, after des1, 2d
获取输出内容 : des3, after des2, 1d
获取返回码 : des4, after des3, 1d
处理输出和返回码 : des5, after des4, 1d
总结
通过以上步骤和代码示例，您应该能够掌握如何使用 Python 的 subprocess 模块获取外部命令的输出内容和返回码。您可以根据实际需要调整命令和处理逻辑，灵活运用这一强大的模块。希望对您学习 Python 编程有所帮助！如有问题，欢迎随时问我！
