Python 执行系统命令后获取返回值

1. 简介

在Python中，我们有时候需要执行一些系统命令，比如运行其他程序或者操作系统命令行工具。在执行系统命令后，我们常常需要获取命令的返回值，以便进一步处理或者判断命令的执行结果。本文将详细介绍如何在Python中执行系统命令，并获取其返回值。

2. 使用 subprocess 模块执行系统命令

在Python中，我们可以使用 subprocess 模块来执行系统命令。这个模块提供了一种更高级、更便捷的方式来执行外部命令，并且还支持更多的功能，比如获取命令的返回值、输入和输出流的重定向等。

2.1 使用 subprocess.run 函数执行命令

subprocess.run 函数是 subprocess 模块中执行命令的最简单方法之一。它可以直接执行指定的命令，并且返回一个 CompletedProcess 对象，其中包含了命令的返回值、标准输出、标准错误输出等信息。

下面是一个示例，演示了如何使用 subprocess.run 函数来执行系统命令，并获取其返回值：

import subprocess

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

# 打印返回值
print("返回值:", result.returncode)

# 打印标准输出
print("标准输出:")
print(result.stdout)

# 打印标准错误输出
print("标准错误输出:")
print(result.stderr)

运行以上代码，可以看到输出结果如下：

返回值: 0
标准输出:
.
..
file1.txt
file2.txt
file3.txt

标准错误输出:

在上述示例中，我们使用 subprocess.run 函数执行了 ls -a 命令，然后使用 capture_output=True 参数来捕获命令的标准输出和标准错误输出。设置 text=True 参数可以将输出以文本字符串的形式返回。

CompletedProcess 对象提供了很多属性，可以获取命令的各种信息。比如 returncode 属性可以获取命令的返回值，正常情况下返回值为 0；stdout 属性可以获取命令的标准输出；stderr 属性可以获取命令的标准错误输出。

2.2 使用 subprocess.Popen 类执行命令

除了使用 subprocess.run 函数外，我们还可以使用 subprocess.Popen 类来执行系统命令。相比于 subprocess.run 函数，subprocess.Popen 类提供了更多的灵活性和功能，但使用起来稍微麻烦一些。

下面是一个示例，演示了如何使用 subprocess.Popen 类来执行系统命令，并获取其返回值：

import subprocess

# 执行命令
process = subprocess.Popen(['ls', '-a'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)

# 等待命令执行完成
process.wait()

# 获取命令输出
stdout, stderr = process.communicate()

# 打印返回值
print("返回值:", process.returncode)

# 打印标准输出
print("标准输出:")
print(stdout)

# 打印标准错误输出
print("标准错误输出:")
print(stderr)

运行以上代码，可以看到输出结果和前面使用 subprocess.run 函数的示例相同。

在上述示例中，我们使用 subprocess.Popen 类执行了 ls -a 命令，并将标准输出和标准错误输出通过 stdout=subprocess.PIPE 和 stderr=subprocess.PIPE 参数进行重定向。然后使用 wait 方法等待命令执行完成，communicate 方法获取命令的输出。

3. 常见问题及解决方法

在执行系统命令时，可能会遇到一些常见问题。下面将介绍一些常见问题，并给出解决方法。

3.1 命令没有返回值

有些系统命令并不会返回一个明确的返回值，比如一些操作命令行工具、启动其他程序等。这种情况下，returncode 属性会返回 None。

解决方法：可以通过其他方式来判断命令的执行结果，比如判断输出是否包含特定的字符串、判断文件是否存在等。

3.2 命令执行超时

有时候，执行的系统命令可能会耗费很长时间，或者长时间没有输出结果。为了避免程序一直阻塞在等待命令执行完成的地方，我们可以设置一个超时时间。

解决方法：在使用 subprocess.run 函数时，可以设置 timeout 参数来指定超时时间。如果命令在指定的超时时间内没有执行完成，subprocess.TimeoutExpired 异常将被抛出。

import subprocess

try:
    # 执行命令，超时时间为 5 秒
    result = subprocess.run(['long_running_command'], timeout=5, capture_output=True, text=True)
except subprocess.TimeoutExpired:
    print("命令执行超时")

在使用 subprocess.Popen 类时，可以使用 communicate 方法的 timeout 参数来指定超时时间。如果命令在指定的超时时间内没有执行完成，subprocess.TimeoutExpired 异常将被抛出。

import subprocess

process = subprocess.Popen(['long_running_command'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)

try:
    # 超时时间为 5 秒
    stdout, stderr = process.communicate(timeout=5)
except subprocess.TimeoutExpired:
    print("命令执行超时")

3.3 命令参数带有特殊字符或空格

当命令的参数包含特殊字符或空格时，我们需要对这些参数进行合适的处理，以确保命令能够正确执行。

解决方法：可以使用引号或者转义字符来将特殊字符或空格包裹起来。下面是一个示例：

import subprocess

# 参数中包含空格和特殊字符
argument = 'file name with spaces and &'  # 括号中的内容是参数，不需要包含括号本身

# 使用引号包裹参数
result = subprocess.run(['ls', '-l', argument], capture_output=True, text=True)

# 或者使用转义字符
result = subprocess.run(['ls', '-l', 'file\ name\ with\ spaces\ and\ &'], capture_output=True, text=True)

4. 总结

本文介绍了如何在Python中执行系统命令，并获取其返回值。通过 subprocess 模块提供的函数和类，我们可以方便地执行系统命令，并获取命令的返回值、标准输出和标准错误输出等信息。同时，本文还介绍了使用 subprocess.run 函数和 subprocess.Popen 类的方法，在执行系统命令时的一些常见问题和解决方法。

通过 subprocess.run 函数，我们可以使用简洁的方式执行系统命令，并且获取命令的返回值、标准输出和标准错误输出。通过 capture_output=True 参数，我们可以轻松地捕获命令的输出结果。 subprocess.run 函数还支持设置超时时间，以及其他一些参数。

通过 subprocess.Popen 类，我们可以更加灵活地执行系统命令，并且可以对命令的输入和输出进行更多的控制。可以使用 stdout=subprocess.PIPE 和 stderr=subprocess.PIPE 参数来重定向标准输出和标准错误输出。使用 wait 方法等待命令执行完成，然后使用 communicate 方法获取命令的输出结果。

无论是使用 subprocess.run 函数还是 subprocess.Popen 类，在执行系统命令时都要注意处理一些常见问题，比如命令没有返回值、命令执行超时以及命令参数带有特殊字符或空格等。针对这些问题，本文提供了相应的解决方法。

综上所述，使用 subprocess 模块可以在Python中执行系统命令，并且方便地获取命令的返回值和输出结果。这对于需要和外部命令行工具交互的Python程序非常有用，可以实现更多的功能和灵活性。同时，在执行系统命令时，需要注意处理一些常见问题，以确保程序的稳定性和正确性。