使用Python subprocess模块执行外部命令

Python 笔记

一、什么是subprocess模块

Python的subprocess模块可以让我们方便地在Python程序中执行外部命令。如果我们需要在Python中调用其他的应用程序，或者需要在Python中自动化一些系统命令，subprocess模块就可以派上用场。

简单地说，subprocess模块就是一个方便的接口，可以让我们在Python程序中运行其他操作系统的命令行程序，并且可以控制子进程的输入输出和状态。

二、subprocess模块的常用函数

subprocess模块提供了很多函数，这里介绍其中几个常用的函数。

subprocess.run()是Python 3.5引入的一个新函数，它是一个高层次的函数，用于运行一条shell命令并等待其完成。使用该函数可以快速地对外部命令进行调用。

以下代码展示了如何使用subprocess.run()来运行外部命令。

import subprocess

result = subprocess.run(['/bin/ls', '-l'], stdout=subprocess.PIPE)

print(result.stdout.decode())

在上面的代码中，我们用subprocess.run()函数来运行外部命令/bin/ls -l，等待退出，并捕获标准输出。subprocess.PIPE指定子进程标准输出被捕获，并且可以用stdout属性访问。

subprocess.call()是一个低级别的函数，可以向操作系统调用指定的程序，并等待其退出。调用成功时，返回退出状态码，否则返回None。

以下代码展示了如何使用subprocess.call()来运行外部命令，并等待执行完成。

import subprocess

retcode = subprocess.call(['ls', '-l'])

print('Returned value:', retcode)

在上面的代码中，我们在Python程序中使用subprocess.call()来运行外部命令ls -l，等待处理完成，然后输出返回值。

三、使用subprocess模块的注意事项

在使用subprocess模块时，需要注意以下几点。

默认情况下，subprocess调用外部命令时是不会获取到输出结果的。我们可以使用subprocess.PIPE将子进程的标准输出捕获，并使用stdout属性访问。

可以使用subprocess.STDOUT标准输出常量将错误输出重定向到标准输出中。

当传递输入给外部程序时，一定要确保输入数据是可信的。否则，可能会导致安全漏洞。

如果你需要向程序发送用于文件名或命令行选项的参数，一定要对它们进行适当的转义处理。使用shlex.quote()来转义参数。

以下是一个例子，展示了将变量作为外部命令的参数时，为它们进行转义处理的正确方式。

import subprocess
import shlex
 
s = 'hello world'

args = shlex.split('grep %s /etc/passwd' % shlex.quote(s))

result = subprocess.run(args,
                        stdout=subprocess.PIPE,
                        stderr=subprocess.PIPE,
                        text=True) 

print(result.stdout)

当系统命令需要请求输入密码时，可以使用subprocess模块的pty模块来实现。pty模块是Python的伪终端模块，可以模拟终端。下面是一个例子，演示如何在Python中使用subprocess模块来手动输入密码：

import subprocess
import pty
import time

def input_password():
    
    os.write(1, "Please input your password: ".encode())
    
    # turn off echoing
    attrs = termios.tcgetattr(fd)
    attrs[3] = attrs[3] & ~termios.ECHO
    
    try:
        termios.tcsetattr(fd, termios.TCSADRAIN, attrs)
        password = os.read(fd, 100)
        os.write(1, '\n'.encode())
    finally:
        attrs[3] = attrs[3] | termios.ECHO
        termios.tcsetattr(fd, termios.TCSADRAIN, attrs)

    return password.decode().strip()

fd, _ = pty.openpty()

child = subprocess.Popen('sudo some_command', stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)

password = input_password()

child.stdin.write((password+'\n').encode())
child.stdin.flush()

output, stderr = child.communicate()

print(output.decode())

如果需要在Python中运行多个命令，则需要使用bash，并将需要运行的多个命令传递给该bash。

以下是一个使用subprocess调用多个命令的例子。

import subprocess

process = subprocess.Popen(['/bin/bash'], stdin=subprocess.PIPE, stdout=subprocess.PIPE)

# Run multiple commands
process.stdin.write('ls\n'.encode())
process.stdin.write('echo "Hello world"\n'.encode())

output, error = process.communicate()

print(output.decode())

四、总结

使用Python subprocess模块执行外部命令可以方便地调用其他应用程序或自动化一些系统命令。我们介绍了subprocess模块的常用函数，包括subprocess.run()和subprocess.call()的用法，以及一些使用subprocess的注意事项，如输入和输出、防止安全漏洞、手动输入密码、多个命令等。

在开发Python应用程序过程中，如有需要，千万不要忘记使用subprocess模块的强大功能。