当前位置： 技术文章>> 如何在 Python 中使用 subprocess 执行外部命令？
文章标题：如何在 Python 中使用 subprocess 执行外部命令？
在Python中，`subprocess`模块是执行外部命令和程序的标准方式，它提供了丰富的接口来启动新进程、连接到它们的输入/输出/错误管道，并获取它们的返回码。使用`subprocess`可以让我们在Python脚本中无缝地集成和扩展系统级的功能，无论是简单的命令执行还是复杂的进程间通信。接下来，我将详细阐述如何在Python中利用`subprocess`模块执行外部命令，并通过一些示例来加深理解。
### 引入`subprocess`模块
首先，要在Python脚本中使用`subprocess`模块，你需要通过`import`语句引入它。这个步骤是基础的，因为它允许你访问该模块提供的所有函数和类。
```python
import subprocess
```
### 使用`subprocess.run()`执行命令
在Python 3.5及以上版本中，`subprocess.run()`是推荐用于执行外部命令的函数。它提供了一个高级接口，可以简化命令执行和结果处理的过程。
#### 基本用法
`subprocess.run()`函数的基本语法如下：
```python
subprocess.run(args, *, stdin=None, input=None, stdout=None, stderr=None, shell=False, text=False, timeout=None, check=False, **other_popen_kwargs)
```
- `args`：命令及其参数，通常是一个字符串列表，如`['ls', '-l']`。如果是单个字符串且`shell=True`，则通过shell执行。
- `stdin`、`stdout`、`stderr`：分别用于子进程的标准输入、标准输出和标准错误输出。可以设置为`subprocess.PIPE`、文件对象或`None`。
- `shell`：是否通过shell执行命令。如果`args`是一个字符串，则必须设置为`True`（但出于安全考虑，推荐使用列表形式的`args`并设置`shell=False`）。
- `text`：是否在stdout和stderr上使用文本模式（Python 3.7+）。如果是`True`，则输出将作为字符串处理；如果是`False`（默认值），则输出为字节序列。
- `timeout`：设置命令执行的最长时间（秒）。如果命令超时，将抛出`subprocess.TimeoutExpired`异常。
- `check`：如果设置为`True`，并且命令执行后返回非零退出状态，将抛出`CalledProcessError`异常。
#### 示例
以下是一个使用`subprocess.run()`执行`ls -l`命令的示例，并捕获其输出：
```python
import subprocess
# 执行ls -l命令，捕获输出
result = subprocess.run(['ls', '-l'], stdout=subprocess.PIPE, text=True)
# 打印命令的输出
print(result.stdout)
# 检查命令是否成功执行
if result.returncode == 0:
print("命令执行成功")
else:
print(f"命令执行失败，退出码：{result.returncode}")
```
### 使用`subprocess.Popen()`进行更细粒度的控制
对于需要更细粒度控制子进程的场景（比如同时读写子进程的输入输出），可以使用`subprocess.Popen()`类。
#### 基本用法
`subprocess.Popen()`的构造函数提供了大量的参数来定制子进程的行为，但基本用法如下：
```python
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=None, startupinfo=None, creationflags=0, restore_signals=True, start_new_session=False, pass_fds=(), *, encoding=None, errors=None, text=None)
```
其中许多参数与`subprocess.run()`相似，但`Popen`提供了更多的灵活性和控制力。
#### 示例
以下是一个使用`subprocess.Popen()`执行`grep`命令并实时读取输出的示例：
```python
import subprocess
# 创建Popen对象执行grep命令
# 假设我们正在搜索文件"example.txt"中包含"hello"的行
process = subprocess.Popen(['grep', 'hello', 'example.txt'], stdout=subprocess.PIPE, text=True)
# 逐行读取输出
for line in process.stdout:
print(line, end='') # end=''防止输出额外的换行符
# 等待子进程完成
process.wait()
# 检查命令是否成功执行
if process.returncode == 0:
print("搜索成功")
else:
print(f"搜索失败，退出码：{process.returncode}")
```
### 注意事项与最佳实践
- **安全性**：当`shell=True`时，应特别注意命令注入的风险。如果命令字符串包含来自不可信源的输入，攻击者可能注入恶意命令。尽可能使用列表形式的`args`并设置`shell=False`。
- **错误处理**：利用`subprocess.run()`的`check`参数或捕获`CalledProcessError`异常来处理命令执行失败的情况。
- **输出编码**：在Python 3中，`subprocess`的文本模式（通过设置`text=True`或`universal_newlines=True`）会处理编码问题，但在某些情况下，你可能需要手动指定编码。
- **资源管理**：使用`with`语句或确保在不再需要时关闭`Popen`对象，以避免资源泄露。
### 总结
`subprocess`模块是Python中执行外部命令的强大工具，通过`subprocess.run()`和`subprocess.Popen()`，我们可以灵活地启动新进程、与之交互并获取其输出。无论你的需求是简单的命令执行还是复杂的进程管理，`subprocess`都能提供合适的解决方案。在你的编程实践中，合理利用`subprocess`模块可以极大地扩展Python脚本的功能和适用范围。
在探索和学习`subprocess`模块的过程中，如果你遇到了任何具体的问题或想要更深入地了解某个方面，不妨访问我的码小课网站，那里有丰富的教程和示例代码，可以帮助你更好地掌握这一强大的工具。