python如何运行外部程序

Python可以通过多种方式运行外部程序，比如使用subprocess模块、os模块、Popen类等。 其中，使用subprocess模块是最常见和推荐的方法，因为它提供了更强大的功能和更多的选项。下面将详细介绍如何使用subprocess模块来运行外部程序。

一、使用subprocess模块

subprocess模块在Python 3.5版本中被引入，旨在替代旧的os.system、os.spawn和os.popen等函数。subprocess模块提供了多种方法来启动外部程序并与其进行交互。

1、subprocess.run()

subprocess.run()是subprocess模块中最常用的函数之一。它用于运行外部命令，并等待命令完成。

示例代码：

import subprocess
result = subprocess.run(['ls', '-l'], capture_output=True, text=True)
print(result.stdout)

上面的代码运行了ls -l命令，并打印了命令的输出。capture_output=True表示捕获标准输出和标准错误，text=True表示将输出作为字符串处理。

2、subprocess.Popen

对于需要更复杂交互的情况，可以使用subprocess.Popen类。它提供了更细粒度的控制。

示例代码：

import subprocess
process = subprocess.Popen(['ls', '-l'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
print(stdout.decode())

上面的代码使用subprocess.Popen启动了ls -l命令，并捕获了其标准输出和标准错误。communicate()方法用于与进程进行交互，等待命令完成并获取输出。

3、subprocess.call

subprocess.call用于运行外部命令，并等待命令完成，返回命令的退出状态。

示例代码：

import subprocess
returncode = subprocess.call(['ls', '-l'])
print('Return code:', returncode)

上面的代码运行了ls -l命令，并打印了命令的返回码。

二、使用os模块

虽然不推荐，但os模块也可以用来运行外部程序。常见的方法有os.system和os.popen。

1、os.system

os.system用于运行外部命令，但不提供获取输出的功能。

示例代码：

import os
os.system('ls -l')

2、os.popen

os.popen用于运行外部命令，并获取命令的输出。

示例代码：

import os
output = os.popen('ls -l').read()
print(output)

三、处理外部程序的输入和输出

1、传递输入到外部程序

可以通过subprocess.Popen的stdin参数传递输入到外部程序。

示例代码：

import subprocess
process = subprocess.Popen(['grep', 'hello'], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = process.communicate(input='hello world\nhello python\n'.encode())
print(stdout.decode())

上面的代码通过stdin传递输入到grep命令，并捕获其输出。

2、捕获输出和错误信息

可以通过stdout和stderr参数捕获外部程序的输出和错误信息。

示例代码：

import subprocess
process = subprocess.Popen(['ls', '-l', 'non_existent_file'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
print('STDOUT:', stdout.decode())
print('STDERR:', stderr.decode())

上面的代码尝试列出一个不存在的文件，并捕获其错误信息。

四、设置环境变量

可以通过env参数设置外部程序的环境变量。

示例代码：

import subprocess
import os
env = os.environ.copy()
env['MY_VAR'] = 'my_value'
result = subprocess.run(['printenv', 'MY_VAR'], capture_output=True, text=True, env=env)
print(result.stdout)

上面的代码设置了一个环境变量MY_VAR，并通过printenv命令打印其值。

五、超时控制

可以通过timeout参数设置命令的超时时间。

示例代码：

import subprocess
try:
    result = subprocess.run(['sleep', '5'], timeout=2)
except subprocess.TimeoutExpired:
    print('Command timed out')

上面的代码尝试运行一个sleep 5命令，并设置超时时间为2秒。由于命令执行时间超过了超时时间，会抛出subprocess.TimeoutExpired异常。

六、使用shell参数

可以通过shell=True参数在shell中运行命令。

示例代码：

import subprocess
result = subprocess.run('ls -l | grep py', shell=True, capture_output=True, text=True)
print(result.stdout)

上面的代码在shell中运行了一个带有管道的命令ls -l | grep py。

七、示例应用场景

1、调用系统命令

在实际应用中，经常需要调用系统命令来执行一些任务，例如备份文件、管理服务等。

示例代码：

import subprocess
def backup_files(src, dest):
    try:
        subprocess.run(['cp', '-r', src, dest], check=True)
        print('Backup successful')
    except subprocess.CalledProcessError:
        print('Backup failed')
backup_files('/path/to/src', '/path/to/dest')

上面的代码定义了一个函数backup_files，用于备份文件。如果命令执行失败，会抛出subprocess.CalledProcessError异常。

2、自动化测试

在自动化测试中，可以通过运行外部程序来测试系统的不同部分。

示例代码：

import subprocess
def run_tests():
    try:
        result = subprocess.run(['pytest', '--maxfail=1', '--disable-warnings'], capture_output=True, text=True, check=True)
        print('Tests passed')
        print(result.stdout)
    except subprocess.CalledProcessError:
        print('Tests failed')
        print(result.stdout)
run_tests()

上面的代码运行了pytest命令来执行测试，并打印了测试结果。

八、错误处理和调试

1、捕获异常

在运行外部程序时，可能会遇到各种错误，需要进行捕获和处理。

示例代码：

import subprocess
try:
    result = subprocess.run(['ls', '-l', 'non_existent_file'], check=True)
except subprocess.CalledProcessError as e:
    print('Error:', e)

上面的代码尝试列出一个不存在的文件，并捕获了subprocess.CalledProcessError异常。

2、调试信息

可以通过设置stderr=subprocess.STDOUT将错误信息重定向到标准输出，方便调试。

示例代码：

import subprocess
result = subprocess.run(['ls', '-l', 'non_existent_file'], stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True)
print(result.stdout)

上面的代码将错误信息重定向到了标准输出，并打印了错误信息。

九、总结

通过上述内容，可以看出Python提供了多种方式来运行外部程序，其中以subprocess模块最为强大和灵活。无论是简单的命令执行，还是复杂的交互、错误处理、环境变量设置等需求，subprocess模块都能很好地满足。 在实际开发中，建议优先使用subprocess模块来运行外部程序，以确保代码的可读性和可维护性。