Python中使用subprocess庫創建附加進程

Posted on by

前言

subprocess庫提供瞭一個API創建子進程並與之通信。這對於運行生產或消費文本的程序尤其有好處，因為這個API支持通過新進行的標準輸入和輸出通道來回傳數據。

本篇，將詳細介紹Python創建附加進行的庫：subprocess。

run(運行外部命令)

subprocess庫本身可以替換os.system()，os.spawnv()等函數。現在我們來通過subprocess庫運行一個外部命令，但不采用os.system()。示例如下：

import subprocess

completed = subprocess.run('whoami')
print(completed.returncode)

這裡我們運行瞭一個windows系統常用的whoami命令，返回當前用戶的名稱，輸出如下：

subprocess.run

這裡，我們使用瞭subprocess.run調用瞭子進程運行windows命令。它返回一個CompletedProcess實例，它包含瞭與進行有關的信息。returncode為子進程的退出狀態碼。通常情況下，退出狀態碼為0則表示進程成功運行瞭；一個負值-N表示這個子進程被信號N終止瞭。

該函數還有許多參數，比如shell，默認值為False表示直接運行命令，如果主動賦值為True則會創建一個中間shell進程，由這個進程運行命令。

import subprocess

completed = subprocess.run('echo 123',shell=True)
print(completed.returncode)

比如這裡，我們打印123。

該庫還有一個call()函數，subprocess.run有一個check參數，如果沒有設置該參數，等價於調用瞭call()函數。check默認值為False。

對於run()函數啟動的進程，它的標準輸入輸出通道會綁定到父進程的輸入輸出。這說明調用程序無法捕獲命令的輸出。不過，我們可以通過為stdout和stderr參數傳入PIPE來捕獲輸出，以備以後處理。

import subprocess

completed = subprocess.run('whoami',stdout=subprocess.PIPE)
print(completed.returncode)
print(len(completed.stdout))
print(completed.stdout.decode('UTF-8'))

運行之後，效果如下：

效果

如果設置run()函數的參數check=True與stdout為PIPE，等價於調用瞭check_output()函數。

通過Shell返回消息

本例會通過一個子shell運行命令，在命令返回錯誤碼並退出之前，將詳細輸入到控制臺。實例如下：

import subprocess

try:
    completed = subprocess.run(
        'echoa 123',
        shell=True,
        stdout=subprocess.PIPE,
        stderr=subprocess.PIPE, )
except subprocess.CalledProcessError as err:
    print("ERROR:", err)
else:
    print("else")
    print(completed.returncode)
    print(len(completed.stdout))
    print(completed.stdout.decode('UTF-8'))
    print(len(completed.stderr))
    print(completed.stderr.decode('gbk'))

運行之後，效果如下：

錯誤輸出

這裡我們輸入瞭一個錯誤的命令，可以看到因為命令錯誤，並沒有輸出命令的執行結果，0和64中間就是completed.stdout，為空。而命令將錯誤消息返回瞭。這是因為我們設置瞭stdout與stderr為subprocess.PIPE，表明這些通道要開放。這樣我們才能獲取子shell運行的結果獲取所運行的錯誤提示。（讀者可以將命令改正確後可以發現錯誤消息沒有瞭，正確執行結果會輸出。這就是subprocess庫創建進程的通信機制）

需要註意的是，如果需要抑制輸出效果，可以將stdout與stderr設置為subprocess.DEVNULL。不過改瞭之後，上面代碼肯定會報錯，因為管道關閉，通信也就關閉瞭。也就是沒有這些參數瞭。

直接處理管道

subprocess庫還有一個非常重要的類Popen，它是用來建立其他API的底層API，對更復雜的進程交互很有用。

比如run()，call()，check_call()和check_output()函數都是Popen類的包裝器。直接使用Popen可以更好的控制如何運行命令以及如何處理輸入和輸出流。Popen的構造函數利用參數建立新進程，使父進程可以通過管道與之通信。

下面，我們來分別介紹進程間通信的方式。

與進程的單項通信

要運行一個進程並讀取它的所有輸出，可以設置stdout為PIPE並調用communicate()函數。示例如下：

import subprocess

prc = subprocess.Popen('whoami', stdout=subprocess.PIPE)
stdout_value = prc.communicate()[0].decode('utf-8')
print(repr(stdout_value))

如上面代碼所示，Popen會在內部管理數據讀取。運行之後，效果如下：

Popen

如果你需要調用一個管道，並完成寫數據的操作，可以設置stdin為PIPE。

import subprocess

prc = subprocess.Popen(["cmd", "/c", 'type', '-'], stdin=subprocess.PIPE)
prc.communicate('stdin'.encode('UTF-8'))

與進程的雙向通信

要完成進程的雙向通信，可以直接將stdin與stdout都設置為PIPE即可。示例如下：

import subprocess

cmd = "cmd /c type E:/Project/debug.log"
cmd.encode('utf-8')
prc = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE)
msg = 'stdin'.encode('UTF-8')
stdout_value = prc.communicate(msg)[0].decode('utf-8')
print(repr(stdout_value))

至於如果命令行錯誤需要捕獲錯誤消息，可以直接將stderr也設置為PIPE。

連接管道段

在Linux系統中，我們可以將多個命令連接成一個管線，即可以把它們的輸入輸出串聯在一起。通過Popen我們也可以完成類似的操作，隻需要將一個Popen實例的stdout屬性被用左管線中下一個Popen實例的stdin參數即可。至於最後肯定還是要設置為PIPE，畢竟我們還是要獲取多個管道段消息結果，示例如下：

import subprocess

cmd1 = "cmd /c type E:/Project/debug.log"
proc1 = subprocess.Popen(cmd1, stdout=subprocess.PIPE, encoding='utf-8')

cmd2 = "tree /F | findstr 拒絕訪問"
proc2 = subprocess.Popen(cmd1, stdout=subprocess.PIPE, stdin=proc1.stdout, encoding='utf-8')

result = proc2.stdout

for line in result:
    print(line.decode('utf-8').strip())

sys的命令交互

在我們學習Python時，一般使用input()進行用戶輸入數據。但是其實sys庫也可以進行輸入輸出判斷，但它涉及的是進程間的交互，示例如下：

import sys

sys.stderr.write('開始\n')
sys.stderr.flush()

while True:
    next_line = sys.stdin.readline()
    sys.stderr.flush()
    if next_line.strip() == "9599":
        break
    sys.stdout.write(next_line)
    sys.stdout.flush()
sys.stderr.write('結束\n')
sys.stderr.flush()

運行之後，效果如下：

os

到此這篇關於Python中使用subprocess庫創建附加進程的文章就介紹到這瞭,更多相關Python附加進程內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：