Python模块之subprocess用法实例详解

引言

在Python编程中，我们经常需要调用其他外部程序来完成一些特定的任务。而Python的subprocess模块就是用来在Python脚本中调用外部程序的工具。本文将详细介绍subprocess模块的用法，并通过示例代码展示其实际应用场景。

什么是subprocess模块？

subprocess模块是Python标准库中的一个模块，它提供了一个简单的接口来创建和执行新的进程。通过subprocess模块，我们可以在Python脚本中调用其他外部程序，并与其进行交互。这对于需要与其他外部程序进行集成的项目非常有用。

subprocess模块的常用函数

subprocess模块提供了多个函数来执行外部程序，下面是一些常用的函数：

  1. subprocess.call(command, args=0, ...): 运行指定的命令，并等待其执行完成。返回值为命令的返回值。
  2. subprocess.check_call(command, args=0, ...): 运行指定的命令，并等待其执行完成。如果命令的返回值不为0，则会抛出CalledProcessError异常。
  3. subprocess.check_output(command, args=0, ...): 运行指定的命令，并等待其执行完成。返回值为命令的输出结果。
  4. subprocess.Popen(command, args=0, ...): 运行指定的命令，但不等待其执行完成。可以通过返回的Popen对象来控制进程的行为。

使用subprocess模块调用外部程序

下面通过几个示例代码，来演示如何使用subprocess模块调用外部程序。

示例一：执行简单的命令

import subprocess

# 执行简单的命令
subprocess.call('ls')

在上面的代码中，我们使用subprocess.call()函数来执行ls命令。call()函数会等待命令执行完成，并返回命令的返回值。

示例二：执行带参数的命令

import subprocess

# 执行带参数的命令
subprocess.call(['ls', '-l'])

在上面的代码中，我们使用subprocess.call()函数来执行带参数的ls命令。参数以列表的形式传递给call()函数。

示例三：获取命令的输出结果

import subprocess

# 获取命令的输出结果
output = subprocess.check_output('ls')
print(output)

在上面的代码中，我们使用subprocess.check_output()函数来执行ls命令，并将命令的输出结果保存到output变量中。然后，我们打印出output的值，即命令的输出结果。

示例四：与外部程序进行交互

import subprocess

# 与外部程序进行交互
proc = subprocess.Popen('python', stdin=subprocess.PIPE, stdout=subprocess.PIPE)

# 向外部程序发送数据，并获取返回结果
output, error = proc.communicate(b'print("Hello, World!")')

print(output.decode())

在上面的代码中，我们使用subprocess.Popen()函数创建一个新的进程，并与外部的Python解释器进行交互。我们通过communicate()方法向外部程序发送数据，并获取返回的结果。然后，我们打印出返回的结果。

序列图

下面是一个使用subprocess模块调用外部程序的序列图：

sequenceDiagram
    participant PythonScript as Python脚本
    participant ExternalProgram as 外部程序

    PythonScript ->> ExternalProgram: 调用外部程序
    ExternalProgram -->> PythonScript: 执行结果

流程图

下面是一个使用subprocess模块调用外部程序的流程图：

flowchart TD
    A[开始] --> B[调用外部程序]
    B --> C[执行命令]
    C --> D[返回结果]
    D --> E[结束]

结论

通过本文的介绍，我们了解了subprocess模块的用法，并通过示例代码展示了其实际应用场景。