Python的subprocess模塊是一個(gè)非常強(qiáng)大的工具，用于啟動(dòng)和與外部進(jìn)程進(jìn)行交互。它允許執(zhí)行外部命令、訪問(wèn)系統(tǒng)Shell、管道數(shù)據(jù)、捕獲輸出和錯(cuò)誤信息，以及更多。

本文詳細(xì)介紹 subprocess模塊的各個(gè)方面，包括如何執(zhí)行外部命令、傳遞參數(shù)、處理輸入輸出、錯(cuò)誤處理以及一些高級(jí)應(yīng)用。

1、介紹

subprocess模塊是Python的標(biāo)準(zhǔn)庫(kù)中的一部分，它允許與外部進(jìn)程進(jìn)行交互。這對(duì)于執(zhí)行系統(tǒng)命令、調(diào)用其他可執(zhí)行文件、處理數(shù)據(jù)流以及與其他進(jìn)程通信非常有用。無(wú)論是需要執(zhí)行簡(jiǎn)單的命令還是需要與復(fù)雜的外部程序進(jìn)行交互，subprocess都可以勝任。

在接下來(lái)的內(nèi)容中，我們將學(xué)習(xí)如何使用subprocess模塊來(lái)執(zhí)行外部命令、處理輸入輸出、捕獲錯(cuò)誤信息，并探討一些高級(jí)用法。我們還會(huì)討論一些安全性方面的注意事項(xiàng)，以確保您的程序不受到潛在的安全漏洞的威脅。

2、執(zhí)行外部命令

（1）使用subprocess.run()

subprocess.run()是Python 3.5及更高版本引入的函數(shù)，用于運(yùn)行外部命令并等待其完成。

以下是一個(gè)簡(jiǎn)單的示例，演示如何使用subprocess.run()來(lái)執(zhí)行ls命令并獲取其輸出：

import subprocess

result = subprocess.run(["ls", "-l"], stdout=subprocess.PIPE, text=True)
print(result.stdout)

在上面的示例中，subprocess.run()接受一個(gè)包含命令及其參數(shù)的列表，通過(guò)stdout=subprocess.PIPE參數(shù)捕獲標(biāo)準(zhǔn)輸出，并使用text=True參數(shù)指定輸出為文本。最后，我們打印了result.stdout以獲取ls -l命令的輸出。

（2）使用subprocess.Popen()

subprocess.Popen()提供了更多的靈活性，允許與進(jìn)程進(jìn)行交互，而不僅僅是等待它完成。

以下是一個(gè)使用subprocess.Popen()的示例，演示如何執(zhí)行外部命令并獲取其輸出：

import subprocess

# 執(zhí)行命令
process = subprocess.Popen(["ls", "-l"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)

# 讀取標(biāo)準(zhǔn)輸出和錯(cuò)誤
out, err = process.communicate()

print("標(biāo)準(zhǔn)輸出:")
print(out)

print("標(biāo)準(zhǔn)錯(cuò)誤:")
print(err)

在上面的示例中，首先使用subprocess.Popen()來(lái)啟動(dòng)進(jìn)程，并指定stdout=subprocess.PIPE和stderr=subprocess.PIPE以捕獲標(biāo)準(zhǔn)輸出和標(biāo)準(zhǔn)錯(cuò)誤。然后，使用process.communicate()方法來(lái)等待進(jìn)程完成并獲取其輸出。

（3）指定執(zhí)行路徑

使用cwd參數(shù)來(lái)指定執(zhí)行外部命令的工作目錄。例如，要在特定目錄中執(zhí)行命令，可以這樣做：

import subprocess

result = subprocess.run(["ls", "-l"], stdout=subprocess.PIPE, text=True, cwd="/path/to/directory")
print(result.stdout)

這將在/path/to/directory目錄中執(zhí)行ls -l命令。

（4）傳遞參數(shù)

如果命令需要接受參數(shù)，可以將它們作為列表的一部分傳遞給subprocess.run()或subprocess.Popen()。

例如，要將文件名作為參數(shù)傳遞給命令，可以這樣做：

import subprocess

filename = "example.txt"
result = subprocess.run(["cat", filename], stdout=subprocess.PIPE, text=True)
print(result.stdout)

這將執(zhí)行cat example.txt命令，其中filename是文件名。

3、處理輸入輸出

（1）標(biāo)準(zhǔn)輸入

subprocess模塊還可以將數(shù)據(jù)傳遞給外部命令的標(biāo)準(zhǔn)輸入。要實(shí)現(xiàn)這一點(diǎn)，可以使用stdin參數(shù)，并將其設(shè)置為一個(gè)文件對(duì)象或一個(gè)字節(jié)串。

import subprocess

input_data = "Hello, subprocess!"
result = subprocess.run(["grep", "subprocess"], input=input_data, stdout=subprocess.PIPE, text=True)
print(result.stdout)

在上面的示例中，使用input_data將數(shù)據(jù)傳遞給grep命令的標(biāo)準(zhǔn)輸入，并搜索包含"subprocess"的行。

（2）標(biāo)準(zhǔn)輸出

前面的示例中，已經(jīng)看到如何捕獲外部命令的標(biāo)準(zhǔn)輸出。通過(guò)使用stdout參數(shù)，可以將標(biāo)準(zhǔn)輸出重定向到文件、字節(jié)串或文件對(duì)象。

import subprocess

output_file = open("output.txt", "w")
result = subprocess.run(["ls", "-l"], stdout=output_file, text=True)
output_file.close()

在上面的示例中，我們將ls -l命令的標(biāo)準(zhǔn)輸出重定向到一個(gè)名為output.txt的文件。

（3）標(biāo)準(zhǔn)錯(cuò)誤

與標(biāo)準(zhǔn)輸出類似，subprocess還可以捕獲標(biāo)準(zhǔn)錯(cuò)誤信息。要捕獲標(biāo)準(zhǔn)錯(cuò)誤，請(qǐng)使用stderr參數(shù)。

import subprocess

result = subprocess.run(["ls", "/nonexistent"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
print("標(biāo)準(zhǔn)輸出:")
print(result.stdout)
print("標(biāo)準(zhǔn)錯(cuò)誤:")
print(result.stderr)

在上面的示例中，執(zhí)行l(wèi)s /nonexistent命令，該命令會(huì)產(chǎn)生一個(gè)錯(cuò)誤，并將標(biāo)準(zhǔn)輸出和標(biāo)準(zhǔn)錯(cuò)誤信息捕獲到result.stdout和result.stderr中。

4、錯(cuò)誤處理

執(zhí)行外部命令時(shí)，通常需要處理錯(cuò)誤。以下是一些處理錯(cuò)誤的常用方法：

（1）檢查返回碼

subprocess.run()和subprocess.Popen()返回一個(gè)CompletedProcess或Popen對(duì)象，其中包含有關(guān)命令執(zhí)行的信息，包括返回碼。返回碼為0表示命令成功執(zhí)行，非零返回碼表示發(fā)生錯(cuò)誤。

import subprocess

result = subprocess.run(["ls", "/nonexistent"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
if result.returncode != 0:
    print("命令執(zhí)行失敗。")
    print("標(biāo)準(zhǔn)錯(cuò)誤:")
    print(result.stderr)

在上面的示例中，檢查result.returncode是否為0，如果不是，就表示命令執(zhí)行失敗。

（2）捕獲錯(cuò)誤輸出

有時(shí)，錯(cuò)誤信息可能不僅僅包含在返回碼中，還包含在標(biāo)準(zhǔn)錯(cuò)誤輸出中?？梢圆东@標(biāo)準(zhǔn)錯(cuò)誤輸出并檢查其中的信息。

import subprocess

result = subprocess.run(["ls", "/nonexistent"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
if result.returncode != 0:
    print("命令執(zhí)行失敗。")
    print("錯(cuò)誤信息:")
    print(result.stderr)

在上面的示例中，我們捕獲標(biāo)準(zhǔn)錯(cuò)誤輸出，并在發(fā)生錯(cuò)誤時(shí)打印它。

5、管道和重定向

subprocess還可以創(chuàng)建管道，將一個(gè)命令的輸出連接到另一個(gè)命令的輸入。這在處理復(fù)雜的數(shù)據(jù)處理任務(wù)時(shí)非常有用。

例如，要將一個(gè)命令的輸出傳遞給另一個(gè)命令，可以這樣做：

import subprocess

# 創(chuàng)建第一個(gè)命令的進(jìn)程
process1 = subprocess.Popen(["ls", "/path/to/directory"], stdout=subprocess.PIPE, text=True)

# 創(chuàng)建第二個(gè)命令的進(jìn)程，將第一個(gè)命令的輸出連接到它的輸入
process2 = subprocess.Popen(["grep", "search_term"], stdin=process1.stdout, stdout=subprocess.PIPE, text=True)

# 從第二個(gè)命令的標(biāo)準(zhǔn)輸出中讀取結(jié)果
result = process2.communicate()[0]
print(result)

在上面的示例中，首先創(chuàng)建第一個(gè)命令的進(jìn)程，然后創(chuàng)建第二個(gè)命令的進(jìn)程，并將第一個(gè)命令的輸出連接到第二個(gè)命令的輸入。

6、高級(jí)應(yīng)用

（1）同時(shí)讀寫(xiě)標(biāo)準(zhǔn)輸入輸出

subprocess模塊同時(shí)讀取和寫(xiě)入標(biāo)準(zhǔn)輸入和輸出。這對(duì)于與外部進(jìn)程進(jìn)行雙向通信非常有用。

以下是一個(gè)示例，演示如何使用subprocess進(jìn)行雙向通信：

import subprocess

# 創(chuàng)建命令進(jìn)程
process = subprocess.Popen(["python", "-u"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True, universal_newlines=True)

# 寫(xiě)入數(shù)據(jù)到標(biāo)準(zhǔn)輸入
process.stdin.write("print('Hello from child process')\n")
process.stdin.flush()

# 讀取并打印標(biāo)準(zhǔn)輸出
output, errors = process.communicate()
print("標(biāo)準(zhǔn)輸出:")
print(output)

# 打印標(biāo)準(zhǔn)錯(cuò)誤
print("標(biāo)準(zhǔn)錯(cuò)誤:")
print(errors)

在上面的示例中，創(chuàng)建了一個(gè)子進(jìn)程，然后向其標(biāo)準(zhǔn)輸入寫(xiě)入Python代碼，并捕獲其標(biāo)準(zhǔn)輸出和標(biāo)準(zhǔn)錯(cuò)誤。

（2）超時(shí)處理

subprocess還允許您設(shè)置執(zhí)行命令的超時(shí)時(shí)間，以防止命令運(yùn)行時(shí)間過(guò)長(zhǎng)。要實(shí)現(xiàn)這一點(diǎn)，您可以使用timeout參數(shù)。

例如：

import subprocess

try:
    result = subprocess.run(["sleep", "10"], timeout=5, stdout=subprocess.PIPE, text=True)
    print(result.stdout)
except subprocess.TimeoutExpired:
    print("命令執(zhí)行超時(shí)。")

在上面的示例中，試圖運(yùn)行sleep 10命令，但由于設(shè)置了5秒的超時(shí)時(shí)間，當(dāng)命令運(yùn)行時(shí)間超過(guò)5秒時(shí)，將引發(fā)subprocess.TimeoutExpired異常。

（3）使用Shell命令

默認(rèn)情況下，subprocess不會(huì)使用Shell來(lái)執(zhí)行命令。這是出于安全考慮，以防止?jié)撛诘腟hell注入攻擊。但有些情況下，可能需要使用Shell來(lái)執(zhí)行命令，可以將shell參數(shù)設(shè)置為True。

import subprocess

# 使用Shell執(zhí)行命令
result = subprocess.run("ls -l | grep .txt", shell=True, stdout=subprocess.PIPE, text=True)
print(result.stdout)

在上面的示例中，我們使用Shell來(lái)執(zhí)行l(wèi)s -l | grep .txt命令。

7、安全性注意事項(xiàng)

在執(zhí)行外部命令時(shí)，請(qǐng)務(wù)必小心處理輸入，以防止?jié)撛诘陌踩┒?。避免將不受信任的?shù)據(jù)傳遞給subprocess，以免受到命令注入攻擊。

確保了解正在執(zhí)行的命令及其參數(shù)，以避免潛在的風(fēng)險(xiǎn)。

總結(jié)

Python的subprocess模塊提供了強(qiáng)大的工具，允許與外部進(jìn)程進(jìn)行交互。可以使用它執(zhí)行外部命令、傳遞參數(shù)、處理輸入輸出和錯(cuò)誤信息，以及支持管道和重定向。這為編寫(xiě)需要與外部程序進(jìn)行通信的Python應(yīng)用程序提供了關(guān)鍵的功能。

subprocess模塊是Python中處理外部進(jìn)程交互的重要工具，但在使用時(shí)需要注意安全性問(wèn)題，特別是在處理不受信任的輸入時(shí)。熟練掌握這一模塊，將有助于編寫(xiě)更強(qiáng)大和安全的Python應(yīng)用程序，能夠與外部程序進(jìn)行有效通信。