日常运维中常用subprocess模块的方法技巧

Python 子进程模块：掌握外部命令的执行

在运维工作的日常流程中，我们经常需要执行各种外部命令，例如文件操作、系统配置和脚本执行等。Python 的 subprocess 模块为这一任务提供了强大的支持，本文将深入探讨该模块的使用方法，包括命令执行、重定向输入输出、超时处理、异常捕获和实例演示，以帮助您掌握外部命令的执行。

1. 执行外部命令

subprocess 模块最基本的功能是执行外部命令。您可以使用 subprocess.Popen() 函数来执行命令，并将命令的输出存储在变量中。例如，以下代码演示了如何执行 ls 命令并获取其输出：

import subprocess

output = subprocess.Popen('ls', stdout=subprocess.PIPE).communicate()[0]
print(output)

2. 重定向命令的输入输出

subprocess 模块还允许您将命令的输入输出重定向到文件或管道中。通过将 stdout 或 stdin 参数设置为文件对象，您可以将命令的输出或输入重定向到指定的目的地。以下代码演示了如何将 ls 命令的输出重定向到 output.txt 文件中：

import subprocess

with open('output.txt', 'w') as f:
    subprocess.Popen('ls', stdout=f).communicate()

3. 设置命令超时

在某些情况下，您可能希望限制外部命令的执行时间。subprocess 模块提供了 timeout 参数，允许您设置命令的超时时间。如果命令在指定时间内没有完成执行，则会引发 subprocess.TimeoutExpired 异常。以下代码演示了如何设置 ls 命令的超时时间为 10 秒：

import subprocess

try:
    output = subprocess.Popen('ls', stdout=subprocess.PIPE, timeout=10).communicate()[0]
    print(output)
except subprocess.TimeoutExpired:
    print('Command timed out')

4. 捕获异常

在执行外部命令时，可能会发生各种异常。subprocess 模块允许您使用 try/except 块捕获这些异常，以便进行适当的处理。以下代码演示了如何捕获 ls 命令执行过程中发生的任何异常：

import subprocess

try:
    output = subprocess.Popen('ls', stdout=subprocess.PIPE).communicate()[0]
    print(output)
except Exception as e:
    print('Error: {}'.format(e))

5. 实例演示

以下是一个使用 subprocess 模块执行外部命令的完整示例：

import subprocess

# 执行 ls 命令并获取其输出
output = subprocess.Popen('ls', stdout=subprocess.PIPE).communicate()[0]
print(output)

# 将 ls 命令的输出重定向到 output.txt 文件中
with open('output.txt', 'w') as f:
    subprocess.Popen('ls', stdout=f).communicate()

# 设置 ls 命令的超时时间为 10 秒
try:
    output = subprocess.Popen('ls', stdout=subprocess.PIPE, timeout=10).communicate()[0]
    print(output)
except subprocess.TimeoutExpired:
    print('Command timed out')

# 捕获 ls 命令执行过程中发生的任何异常
try:
    output = subprocess.Popen('ls', stdout=subprocess.PIPE).communicate()[0]
    print(output)
except Exception as e:
    print('Error: {}'.format(e))

结论

subprocess 模块是 Python 中执行外部命令的强大工具，通过掌握本文介绍的方法，您可以高效地管理外部进程，实现各种自动化和运维任务。

常见问题解答

1. 如何获取命令的退出码？
   使用 subprocess.Popen() 函数的 returncode 属性获取命令的退出码。

2. 如何在命令执行过程中传递环境变量？
   使用 subprocess.Popen() 函数的 env 参数传递环境变量。

3. 如何捕获命令执行过程中的错误输出？
   使用 subprocess.Popen() 函数的 stderr 参数捕获错误输出。

4. 如何将多个命令连接在一起执行？
   使用 subprocess.PIPE 将前一个命令的输出传递给后一个命令作为输入。

5. 如何使用 subprocess 模块执行交互式命令？
   使用 subprocess.Popen() 函数的 stdin、stdout 和 stderr 参数提供交互式输入和输出。