Python模組學習 —- subprocess 建立子進程

文章目錄

• subprocess.Popen(args, bufsize=0, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=False, shell=False, cwd=None, env=None, universal_newlines=False, startupinfo=None, creationflags=0)
• subprocess.PIPE
• subprocess.STDOUT

　　最近，我們老大要我寫一個守護者程式，對伺服器處理序進行守護。如果伺服器不幸掛掉了，守護者能即時的重啟應用程式。上網Google了一下，發現Python有很幾個模組都可以建立進程。最終我選擇使用subprocess模組，因為在Python手冊中有這樣一段話:

　　This module intends to replace several other, older modules and functions, such as: os.system、os.spawn*、os.popen*、popen2.*、commands.*

　　subprocess被用來替換一些老的模組和函數，如：os.system、os.spawn*、os.popen*、popen2.*、commands.*。可見，subprocess是被推薦使用的模組。

 

下面是一個很簡單的例子，建立一個新進程，執行app1.exe，傳入相當的參數，並列印出進程的傳回值：

import subprocess</p><p>returnCode = subprocess.call('app1.exe -a -b -c -d')<br />print 'returncode:', returnCode</p><p>#----- 結果 --------<br />#Python is powerful<br />#app1.exe<br />#-a<br />#-b<br />#-c<br />#-d<br />returncode: 0

app1.exe是一個非常簡單的控制台程式，它只列印出傳入的參數，代碼如下：

 #include <iostream><br />using namespace std;</p><p>int main(int argc, const char *argv[])<br />{<br /> cout << "Python is powerful" << endl;<br /> for (int i = 0; i < argc; i++)<br /> {<br /> cout << argv[i] << endl;<br /> }</p><p> return 0;<br />}

　　閑話少說，下面開始詳細介紹subprocess模組。subprocess模組中只定義了一個類: Popen。可以使用Popen來建立進程，並與進程進行複雜的互動。它的建構函式如下：

subprocess.Popen(args, bufsize=0, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=False, shell=False, cwd=None, env=None, universal_newlines=False, startupinfo=None, creationflags=0)

　　參數args可以是字串或者序列類型（如：list，元組），用於指定進程的可執行檔及其參數。如果是序列類型，第一個元素通常是可執行檔的路徑。我們也可以顯式的使用executeable參數來指定可執行檔的路徑。在windows作業系統上，Popen通過調用CreateProcess()來建立子進程,CreateProcess接收一個字串參數，如果args是序列類型，系統將會通過list2cmdline()函數將序列類型轉換為字串。
　　參數bufsize：指定緩衝。我到現在還不清楚這個參數的具體含義，望各個大牛指點。
　　參數executable用於指定可執行程式。一般情況下我們通過args參數來設定所要啟動並執行程式。如果將參數shell設為True，executable將指定程式使用的shell。在windows平台下，預設的shell由COMSPEC環境變數來指定。
　　參數stdin, stdout, stderr分別表示程式的標準輸入、輸出、錯誤控制代碼。他們可以是PIPE，檔案描述符或檔案對象，也可以設定為None，表示從父進程繼承。
　　參數preexec_fn只在Unix平台下有效，用於指定一個可執行對象（callable object），它將在子進程運行之前被調用。
　　參數Close_sfs：在windows平台下，如果close_fds被設定為True，則新建立的子進程將不會繼承父進程的輸入、輸出、錯誤管道。我們不能將close_fds設定為True同時重新導向子進程的標準輸入、輸出與錯誤(stdin, stdout, stderr)。
　　如果參數shell設為true，程式將通過shell來執行。
　　參數cwd用於設定子進程的目前的目錄。
　　參數env是字典類型，用於指定子進程的環境變數。如果env = None，子進程的環境變數將從父進程中繼承。
　　參數Universal_newlines:不同作業系統下，文本的分行符號是不一樣的。如：windows下用'/r/n'表示換，而Linux下用'/n'。如果將此參數設定為True，Python統一把這些分行符號當作'/n'來處理。
　　參數startupinfo與createionflags只在windows下用效，它們將被傳遞給底層的CreateProcess()函數，用於設定子進程的一些屬性，如：主視窗的外觀，進程的優先順序等等。 

subprocess.PIPE

　　在建立Popen對象時，subprocess.PIPE可以初始化stdin, stdout或stderr參數。表示與子進程通訊的標準流。

subprocess.STDOUT

　　建立Popen對象時，用於初始化stderr參數，表示將錯誤通過標準輸出資料流輸出。 

 

Popen的方法：

Popen.poll() 

　　用於檢查子進程是否已經結束。設定並返回returncode屬性。

Popen.wait() 

　　等待子進程結束。設定並返回returncode屬性。

Popen.communicate(input=None)

　　與子進程進行互動。向stdin發送資料，或從stdout和stderr中讀取資料。選擇性參數input指定發送到子進程的參數。Communicate()返回一個元組：(stdoutdata, stderrdata)。注意：如果希望通過進程的stdin向其發送資料，在建立Popen對象的時候，參數stdin必須被設定為PIPE。同樣，如果希望從stdout和stderr擷取資料，必須將stdout和stderr設定為PIPE。

Popen.send_signal(signal) 

　　向子進程發送訊號。

Popen.terminate()

　　停止(stop)子進程。在windows平台下，該方法將調用Windows API TerminateProcess（）來結束子進程。

Popen.kill()

　　殺死子進程。

Popen.stdin 

　　如果在建立Popen對象是，參數stdin被設定為PIPE，Popen.stdin將返回一個檔案對象用於策子進程發送指令。否則返回None。

Popen.stdout 

　　如果在建立Popen對象是，參數stdout被設定為PIPE，Popen.stdout將返回一個檔案對象用於策子進程發送指令。否則返回None。

Popen.stderr 

　　如果在建立Popen對象是，參數stdout被設定為PIPE，Popen.stdout將返回一個檔案對象用於策子進程發送指令。否則返回None。

Popen.pid 

　　擷取子進程的進程ID。

Popen.returncode 

　　擷取進程的傳回值。如果進程還沒有結束，返回None。

 下面是一個非常簡單的例子，來示範supprocess模組如何與一個控制項台應用程式進行互動。

 import subprocess</p><p>p = subprocess.Popen("app2.exe", stdin = subprocess.PIPE, /<br /> stdout = subprocess.PIPE, stderr = subprocess.PIPE, shell = False)</p><p>p.stdin.write('3/n')<br />p.stdin.write('4/n')<br />print p.stdout.read()</p><p>#---- 結果 ----<br />input x:<br />input y:<br />3 + 4 = 7

app2.exe也是一個非常簡單的控制台程式，它從介面上接收兩個數值，執行加操作，並將結果列印到控制台上。代碼如下：

 #include <iostream><br />using namespace std;</p><p>int main(int argc, const char *artv[])<br />{<br /> int x, y;<br /> cout << "input x: " << endl;<br /> cin >> x;<br /> cout << "input y: " << endl;<br /> cin >> y;<br /> cout << x << " + " << y << " = " << x + y << endl;</p><p> return 0;<br />}

 

　　supprocess模組提供了一些函數，方便我們用於建立進程。

subprocess.call(*popenargs, **kwargs)

　　運行命令。該函數將一直等待到子進程運行結束，並返回進程的returncode。文章一開始的例子就示範了call函數。如果子進程不需要進行互動,就可以使用該函數來建立。

subprocess.check_call(*popenargs, **kwargs) 

　　與subprocess.call(*popenargs, **kwargs)功能一樣，只是如果子進程返回的returncode不為0的話，將觸發CalledProcessError異常。在異常對象中，包括進程的returncode資訊。

 

　　subprocess模組的內容就這麼多。在Python手冊中，還介紹了如何使用subprocess來替換一些老的模組，老的函數的例子。趕興趣的朋友可以看一下。

 

參考文檔：

subprocess — Subprocess management

PyMoTW:subprocess