当前位置： 技术文章>> Python 中如何使用 subprocess 执行命令？

文章标题：Python 中如何使用 subprocess 执行命令？
  • 文章分类: 后端
  • 8983 阅读

在Python中，subprocess模块是执行外部命令和程序的一个强大工具。它允许你启动新的进程，连接到它们的输入/输出/错误管道，并获取它们的返回码。这种能力对于脚本编写、自动化任务以及与系统其他部分的交互来说至关重要。下面，我将详细探讨如何在Python中使用subprocess模块来执行命令，并通过实际例子展示其用法。

一、subprocess模块基础

subprocess模块提供了多种创建新进程的方式，但最常用的几种是Popen类、run()函数（Python 3.5+引入），以及call()和check_call()、check_output()等便捷函数。这些函数和类提供了灵活性和控制力，让开发者能够根据需要执行外部命令。

1. 使用Popen类

Popen类是subprocess模块的核心，它用于创建新的进程。你可以通过它指定要执行的命令、启动进程的参数、标准输入/输出/错误流的重定向等。

import subprocess

# 使用Popen执行命令
process = subprocess.Popen(['ls', '-l'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
# 等待命令执行完成，并获取输出
stdout, stderr = process.communicate()

# 检查命令是否成功执行
if process.returncode == 0:
    print("命令执行成功，输出如下：")
    print(stdout.decode())
else:
    print("命令执行失败，错误信息如下：")
    print(stderr.decode())

在这个例子中，我们使用Popen执行了ls -l命令，并捕获了它的标准输出和标准错误输出。communicate()方法用于等待进程结束，并获取所有输出。注意，这里我们通过decode()方法将字节串转换成了字符串，因为stdout和stderr返回的是字节数据。

2. 使用run()函数

run()函数是Python 3.5及更高版本中引入的，它提供了一个更高级别的接口来执行外部命令并获取结果。run()函数封装了Popen的许多功能，并返回一个CompletedProcess实例，其中包含了命令的返回码、标准输出和标准错误输出。

import subprocess

# 使用run()执行命令
result = subprocess.run(['ls', '-l'], capture_output=True, text=True)

# 检查命令是否成功执行
if result.returncode == 0:
    print("命令执行成功，输出如下：")
    print(result.stdout)
else:
    print("命令执行失败，错误信息如下：")
    print(result.stderr)

在这个例子中，capture_output=True参数表示捕获命令的标准输出和标准错误输出，而text=True参数则指定将这些输出作为文本（而非字节串）返回。这样，你就不需要手动调用decode()方法了。

二、进阶用法

1. 管道和重定向

在Unix-like系统中，管道（|）是一种将一个命令的输出作为另一个命令输入的方式。在Python中，你可以通过Popen类的stdin、stdout和stderr参数来实现类似的功能。

# 使用Popen实现管道
p1 = subprocess.Popen(['ls', '-l'], stdout=subprocess.PIPE)
p2 = subprocess.Popen(['grep', 'python'], stdin=p1.stdout, stdout=subprocess.PIPE)

# 等待p2完成
p2.wait()

# 读取p2的输出
output = p2.communicate()[0]
print(output.decode())

# 注意：确保父进程关闭了子进程的stdout管道
# p1.stdout.close()  # 在这个例子中其实不需要，因为p2会读取完p1的输出

在这个例子中，ls -l命令的输出被直接传递给了grep python命令，实现了类似于ls -l | grep python的管道效果。

2. 异步执行

Popen对象是非阻塞的，这意味着你可以启动一个进程，并在等待它完成的同时继续执行其他任务。这在需要并行处理多个任务时非常有用。

# 异步执行命令
processes = []
for cmd in [['ls', '-l'], ['grep', 'python'], ['echo', 'Hello, subprocess!']]:
    process = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    processes.append(process)

# 等待所有进程完成
for process in processes:
    process.wait()

# 处理每个进程的输出（这里省略了具体的输出处理逻辑）

3. 环境和工作目录

在执行外部命令时，有时需要指定特定的环境变量或工作目录。Popen和run()都允许你这样做。

# 使用run()指定环境变量和工作目录
env = os.environ.copy()
env['MY_VAR'] = 'some_value'

result = subprocess.run(['./my_script.sh'], env=env, cwd='/path/to/working/directory', capture_output=True, text=True)

# 检查并处理结果（省略）

三、安全注意事项

当使用subprocess执行外部命令时，需要注意安全问题，特别是当命令或参数中包含来自不可信源的数据时。以下是一些最佳实践：

  1. 使用列表形式传递命令和参数：这有助于防止shell注入攻击，因为列表中的每个元素都被视为单独的参数，而不是一个由shell解释的字符串。

  2. 避免使用shell=True：除非绝对必要，否则应避免在Popen或run()中使用shell=True。当shell=True时，命令会被shell解释，这增加了安全风险。

  3. 清理输入：如果命令或参数来自不可信的源，应确保在传递给subprocess之前进行清理和验证。

四、结语

subprocess模块是Python中执行外部命令的强大工具，它提供了灵活性和控制力，让开发者能够轻松地与系统其他部分进行交互。通过了解Popen类和run()函数等关键组件的用法，你可以编写出功能强大且安全的自动化脚本。同时，要注意遵守最佳实践，确保你的代码既高效又安全。希望这篇文章能帮助你更好地理解和使用subprocess模块，在自动化任务和脚本编写中发挥出更大的作用。在探索更多高级功能时，不妨访问我的码小课网站，那里有更多的学习资源和技术分享等待着你。

推荐文章