python3之subprocess常見方法使用

一、常見subprocess方法

1、subprocess.getstatusoutput(cmd)

官方解釋：

Return (exitcode, output) of executing cmd in a shell.Execute the string 'cmd' in a shell with 'check_output' andreturn a 2-tuple (status, output). The locale encoding is usedto decode the output and process newlines.

cmd可以直接執行shell命令，而不需要cmd命令以列表輸入----subprocess.getstatusoutput("cat /proc/meminfo")

返回值包含cmd的執行狀態和執行結果，可以直接賦值給某個變量

實例：

[](javascript:void(0)😉

>>> ret = subprocess.getoutput('ls -l')
>>> print(ret)
總用量 160
drwxr-xr-x  2 wader wader   4096 12月  7  2015 公共的
drwxr-xr-x  2 wader wader   4096 12月  7  2015 模板
drwxr-xr-x  2 wader wader   4096 12月  7  2015 視頻
drwxr-xr-x  2 wader wader   4096 12月  7  2015 圖片
drwxr-xr-x  2 wader wader   4096 12月  7  2015 文檔
drwxr-xr-x  2 wader wader   4096  4月 13  2016 下載
drwxr-xr-x  2 wader wader   4096 12月  7  2015 音樂
drwxr-xr-x  7 wader wader   4096  5月 26  2016 桌面
>>> retcode, output = subprocess.getstatusoutput('ls -l')
>>> print(retcode)
0
>>> print(output)
總用量 160
drwxr-xr-x  2 wader wader   4096 12月  7  2015 公共的
drwxr-xr-x  2 wader wader   4096 12月  7  2015 模板
drwxr-xr-x  2 wader wader   4096 12月  7  2015 視頻
drwxr-xr-x  2 wader wader   4096 12月  7  2015 圖片
drwxr-xr-x  2 wader wader   4096 12月  7  2015 文檔
drwxr-xr-x  2 wader wader   4096  4月 13  2016 下載
drwxr-xr-x  2 wader wader   4096 12月  7  2015 音樂
drwxr-xr-x  7 wader wader   4096  5月 26  2016 桌面
>>> retcode, output = subprocess.getstatusoutput('ls -l /test')
>>> print(retcode)
2
>>> print(output)
ls: 無法訪問/test: 沒有那個文件或目錄

[](javascript:void(0)😉

2、subprocess.getoutput(cmd)

官方解釋：

Return output (stdout or stderr) of executing cmd in a shell.Like getstatusoutput(), except the exit status is ignored and the returnvalue is a string containing the command's outputcmd可以直接執行shell命令，而不需要cmd命令以列表輸入---subprocess.getoutput("cat /proc/meminfo")返回值包含cmd的執行結果，可以直接賦值給某個變量功能和getstatusoutput類似

3、subprocess.run(*popenargs, input=None, timeout=None, check=False, **kwargs))

Run command with arguments and return a CompletedProcess instance.   執行傳入命令參數后，返回CompletedProcess實例
The returned instance will have attributes args, returncode, stdout andstderr. By default, stdout and stderr are not captured, and those attributeswill be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them.check等於True的時候，當執行狀態不是0時，會拋出CalledProcessError異常提示傳入命令參數時，需要以多個命令拆分按照列表形式傳入：subprocess.run(['df', '-h'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True)如果傳入參數同時傳入shell=True，則傳入一個字符串args,shell命令而不是待執行的shell命令序列實例：

[](javascript:void(0)😉

>>> subprocess.run(["ls", "-l"])  # doesn't capture output
CompletedProcess(args=['ls', '-l'], returncode=0)

>>> subprocess.run("exit 1", shell=True, check=True)
Traceback (most recent call last):
  ...
subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1

>>> subprocess.run(["ls", "-l", "/dev/null"], stdout=subprocess.PIPE)
CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n')

[](javascript:void(0)😉

4、subprocess.call()

官方解釋：

Run command with arguments. Wait for command to complete ortimeout, then return the returncode attribute

傳入shell命令參數格式subprocess.check_call([``"ls"``, ``"-l"``])

如果傳入參數同時傳入shell=True，則可以傳入一個字符串shell命令而不是待執行的shell命令列表--subprocess.check_call("exit 1", shell=True)返回參數僅返回執行狀態碼，可通過把結果復制給某個變量查看，如果直接在linux下python編譯器執行該命令會直接顯示命令執行的結果 實例：

[](javascript:void(0)😉

>>> subprocess.call(['ls',  '-l'])
總用量 160
drwxr-xr-x  2 wader wader   4096 12月  7  2015 公共的
drwxr-xr-x  2 wader wader   4096 12月  7  2015 模板
drwxr-xr-x  2 wader wader   4096 12月  7  2015 視頻
drwxr-xr-x  2 wader wader   4096 12月  7  2015 圖片
drwxr-xr-x  2 wader wader   4096 12月  7  2015 文檔
drwxr-xr-x  2 wader wader   4096  4月 13  2016 下載
drwxr-xr-x  2 wader wader   4096 12月  7  2015 音樂
drwxr-xr-x  7 wader wader   4096  5月 26  2016 桌面
0
>>> subprocess.call('ls -l', shell=True)
總用量 160
drwxr-xr-x  2 wader wader   4096 12月  7  2015 公共的
drwxr-xr-x  2 wader wader   4096 12月  7  2015 模板
drwxr-xr-x  2 wader wader   4096 12月  7  2015 視頻
drwxr-xr-x  2 wader wader   4096 12月  7  2015 圖片
drwxr-xr-x  2 wader wader   4096 12月  7  2015 文檔
drwxr-xr-x  2 wader wader   4096  4月 13  2016 下載
drwxr-xr-x  2 wader wader   4096 12月  7  2015 音樂
drwxr-xr-x  7 wader wader   4096  5月 26  2016 桌面
0
>>> subprocess.call(['ls',  '-l'], stdout=subprocess.DEVNULL)
0
>>> subprocess.call(['ls',  '-l', '/test'])
ls: 無法訪問/test: 沒有那個文件或目錄
2

[](javascript:void(0)😉

5、subprocess.check_call()

官方解釋：

Run command with arguments.  Wait for command to complete.  Ifthe exit code was zero then return, otherwise raiseCalledProcessError.  The CalledProcessError object will have thereturn code in the returncode attribute.

check_call基本和call功能一樣，只是增加了返回狀態碼校驗，如果執行狀態碼是0，則返回0，否則拋出異常

實例：

[](javascript:void(0)😉

>>> subprocess.check_call(['ls',  '-l'])
總用量 160
drwxr-xr-x  2 wader wader   4096 12月  7  2015 公共的
drwxr-xr-x  2 wader wader   4096 12月  7  2015 模板
drwxr-xr-x  2 wader wader   4096 12月  7  2015 視頻
drwxr-xr-x  2 wader wader   4096 12月  7  2015 圖片
drwxr-xr-x  2 wader wader   4096 12月  7  2015 文檔
drwxr-xr-x  2 wader wader   4096  4月 13  2016 下載
drwxr-xr-x  2 wader wader   4096 12月  7  2015 音樂
drwxr-xr-x  7 wader wader   4096  5月 26  2016 桌面
0
>>> subprocess.check_call('ls -l', shell=True)
總用量 160
drwxr-xr-x  2 wader wader   4096 12月  7  2015 公共的
drwxr-xr-x  2 wader wader   4096 12月  7  2015 模板
drwxr-xr-x  2 wader wader   4096 12月  7  2015 視頻
drwxr-xr-x  2 wader wader   4096 12月  7  2015 圖片
drwxr-xr-x  2 wader wader   4096 12月  7  2015 文檔
drwxr-xr-x  2 wader wader   4096  4月 13  2016 下載
drwxr-xr-x  2 wader wader   4096 12月  7  2015 音樂
drwxr-xr-x  7 wader wader   4096  5月 26  2016 桌面
0
>>> subprocess.check_call('ls -l /test', shell=True)
ls: 無法訪問/test: 沒有那個文件或目錄
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/lib/python3.4/subprocess.py", line 557, in check_call
    raise CalledProcessError(retcode, cmd)
subprocess.CalledProcessError: Command 'ls -l /test' returned non-zero exit status 2

[](javascript:void(0)😉

6、subprocess.check_output()

官方解釋：

Run command with arguments and return its output.If the exit code was non-zero it raises a CalledProcessError.  TheCalledProcessError object will have the return code in the returncodeattribute and output in the output attribute.執行命令，如果狀態碼是0，則返回執行結果，否則拋出異常--subprocess.check_output(["ls", "-l"])
如果傳入參數同時傳入shell=True，則可以傳入一個字符串shell命令而不是待執行的shell命令列表--
subprocess.check_call("exit 1", shell=True)
返回值包含cmd的執行結果，可以直接賦值給某個變量實例：

[](javascript:void(0)😉

>>> ret = subprocess.check_output(['ls',  '-l'])
>>> print(ret)
b' \xe5\x85\xac\xe5\x85\xb1\xe7\x9a\x84\ndrwxr-xr-x  2 wader wader   4096 12\xe6\x9c\x88  7  2015 \xe6\xa8\xa1\xe6\x9d\xbf\ndrwxr-xr-x  2 wader wader   4096 12\xe6\x9c\x88  7  2015 \xe8\xa7\x86\xe9\xa2\x91\ndrwxr-xr-x  2 wader wader   4096 12\xe6\x9c\x88  7  2015 \xe5\x9b\xbe\xe7\x89\x87\ndrwxr-xr-x  2 wader wader   4096 12\xe6\x9c\x88  7  2015 \xe6\x96\x87\xe6\xa1\xa3\ndrwxr-xr-x  2 wader wader   4096  4\xe6\x9c\x88 13  2016 \xe4\xb8\x8b\xe8\xbd\xbd\ndrwxr-xr-x  2 wader wader   4096 12\xe6\x9c\x88  7  2015 \xe9\x9f\xb3\xe4\xb9\x90\ndrwxr-xr-x  7 wader wader   4096  5\xe6\x9c\x88 26  2016 \xe6\xa1\x8c\xe9\x9d\xa2\n'
>>> ret = subprocess.check_output(['ls',  '-l'], universal_newlines=True)
>>> print(ret)
總用量 160
drwxr-xr-x  2 wader wader   4096 12月  7  2015 公共的
drwxr-xr-x  2 wader wader   4096 12月  7  2015 模板
drwxr-xr-x  2 wader wader   4096 12月  7  2015 視頻
drwxr-xr-x  2 wader wader   4096 12月  7  2015 圖片
drwxr-xr-x  2 wader wader   4096 12月  7  2015 文檔
drwxr-xr-x  2 wader wader   4096  4月 13  2016 下載
drwxr-xr-x  2 wader wader   4096 12月  7  2015 音樂
drwxr-xr-x  7 wader wader   4096  5月 26  2016 桌面

[](javascript:void(0)😉

二、subprocess.Popen()類--用於執行復雜的系統命令

該類用於在一個新的進程中執行一個子程序。前面我們提到過，上面介紹的這些函數都是基於subprocess.Popen類實現的，通過使用這些被封裝后的高級函數可以很方面的完成一些常見的需求。由於subprocess模塊底層的進程創建和管理是由Popen類來處理的，因此，當我們無法通過上面哪些高級函數來實現一些不太常見的功能時就可以通過subprocess.Popen類提供的靈活的api來完成。

1、subprocess.Popen的構造函數

[](javascript:void(0)😉

def __init__(self, args, bufsize=-1, executable=None,
                 stdin=None, stdout=None, stderr=None,
                 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
                 shell=False, cwd=None, env=None, universal_newlines=False,
                 startupinfo=None, creationflags=0,
                 restore_signals=True, start_new_session=False,
                 pass_fds=(), *, encoding=None, errors=None)

[](javascript:void(0)😉

構造函數詳細參數說明和其他實現過程可以參考對應subprocess庫文件

參數說明：

• args： 要執行的shell命令，可以是字符串，也可以是命令各個參數組成的序列。當該參數的值是一個字符串時，該命令的解釋過程是與平台相關的，因此通常建議將args參數作為一個序列傳遞。
• bufsize： 指定緩存策略，0表示不緩沖，1表示行緩沖，其他大於1的數字表示緩沖區大小，負數 表示使用系統默認緩沖策略。
• stdin, stdout, stderr： 分別表示程序標准輸入、輸出、錯誤句柄。
• preexec_fn： 用於指定一個將在子進程運行之前被調用的可執行對象，只在Unix平台下有效。
• close_fds： 如果該參數的值為True，則除了0,1和2之外的所有文件描述符都將會在子進程執行之前被關閉。
• shell： 該參數用於標識是否使用shell作為要執行的程序，如果shell值為True，則建議將args參數作為一個字符串傳遞而不要作為一個序列傳遞。
• cwd： 如果該參數值不是None，則該函數將會在執行這個子進程之前改變當前工作目錄。
• env： 用於指定子進程的環境變量，如果env=None，那么子進程的環境變量將從父進程中繼承。如果env!=None，它的值必須是一個映射對象。
• universal_newlines： 如果該參數值為True，則該文件對象的stdin，stdout和stderr將會作為文本流被打開，否則他們將會被作為二進制流被打開。
• startupinfo和creationflags： 這兩個參數只在Windows下有效，它們將被傳遞給底層的CreateProcess()函數，用於設置子進程的一些屬性，如主窗口的外觀，進程優先級等。

2. subprocess.Popen類的實例可調用的方法

Popen.poll()	用於檢查子進程（命令）是否已經執行結束，沒結束返回None，結束后返回狀態碼。
Popen.wait(timeout=None)	等待子進程結束，並返回狀態碼；如果在timeout指定的秒數之后進程還沒有結束，將會拋出一個TimeoutExpired異常。
Popen.communicate(input=None, timeout=None)	該方法可用來與進程進行交互，比如發送數據到stdin，從stdout和stderr讀取數據，直到到達文件末尾。
Popen.send_signal(signal)	發送指定的信號給這個子進程。
Popen.terminate()	停止該子進程。
Popen.kill()	殺死該子進程。

關於communicate()方法的說明：

• 該方法中的可選參數 input 應該是將被發送給子進程的數據，或者如沒有數據發送給子進程，該參數應該是None。input參數的數據類型必須是字節串，如果universal_newlines參數值為True，則input參數的數據類型必須是字符串。
• 該方法返回一個元組(stdout_data, stderr_data)，這些數據將會是字節穿或字符串（如果universal_newlines的值為True）。
• 如果在timeout指定的秒數后該進程還沒有結束，將會拋出一個TimeoutExpired異常。捕獲這個異常，然后重新嘗試通信不會丟失任何輸出的數據。但是超時之后子進程並沒有被殺死，為了合理的清除相應的內容，一個好的應用應該手動殺死這個子進程來結束通信。
• 需要注意的是，這里讀取的數據是緩沖在內存中的，所以，如果數據大小非常大或者是無限的，就不應該使用這個方法

3. subprocess.Popen使用實例

實例1、

[](javascript:void(0)😉

>>> import subprocess
>>>
>>> p = subprocess.Popen('df -Th', stdout=subprocess.PIPE, shell=True)
>>> print(p.stdout.read())
Filesystem     Type      Size  Used Avail Use% Mounted on
/dev/vda1      ext4       40G   12G   26G  31% /
devtmpfs       devtmpfs  3.9G     0  3.9G   0% /dev
tmpfs          tmpfs     3.9G     0  3.9G   0% /dev/shm
tmpfs          tmpfs     3.9G  386M  3.5G  10% /run
tmpfs          tmpfs     3.9G     0  3.9G   0% /sys/fs/cgroup
tmpfs          tmpfs     783M     0  783M   0% /run/user/0
tmpfs          tmpfs     783M     0  783M   0% /run/user/1000

[](javascript:void(0)😉

實例2

[](javascript:void(0)😉

>>> obj = subprocess.Popen(["python"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
>>> obj.stdin.write('print(1) \n')
>>> obj.stdin.write('print(2) \n')
>>> obj.stdin.write('print(3) \n')
>>> out,err = obj.communicate()
>>> print(out)
1
2
3

>>> print(err)

[](javascript:void(0)😉

實例3

>>> obj = subprocess.Popen(["python"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
>>> out,err = obj.communicate(input='print(1) \n')
>>> print(out)
1

>>> print(err)

實例4

實現類似df -Th | grep data命令的功能，實際上就是實現shell中管道的共功能

[](javascript:void(0)😉

>>> 
>>> p1 = subprocess.Popen(['df', '-Th'], stdout=subprocess.PIPE)
>>> p2 = subprocess.Popen(['grep', 'data'], stdin=p1.stdout, stdout=subprocess.PIPE)
>>> out,err = p2.communicate()
>>> print(out)
/dev/vdb1      ext4      493G  4.8G  463G   2% /data
/dev/vdd1      ext4     1008G  420G  537G  44% /data1
/dev/vde1      ext4      985G  503G  432G  54% /data2

>>> print(err)
None

[](javascript:void(0)😉

三、總結

那么我們到底該用哪個模塊、哪個函數來執行命令與系統及系統進行交互呢？下面我們來做個總結：

1、如果你的應用使用的Python 2.4以上，但是是Python 3.5以下的版本，Python官方給出的建議是使用subprocess.call()函數。Python 2.5中新增了一個subprocess.check_call()函數，Python 2.7中新增了一個subprocess.check_output()函數，這兩個函數也可以按照需求進行使用

2、如果你的應用使用的是Python 3.5及以上的版本（目前應該還很少），Python官方給出的建議是盡量使用subprocess.run()函數

3、當subprocess.call()、subprocess.check_call()、subprocess.check_output()和subprocess.run()這些高級函數無法滿足需求時，我們可以使用subprocess.Popen類來實現我們需要的復雜功能

不過經過個人試驗認為getoutput、getstatusoutput方法使用比較便捷，subprocess適合個性化的執行

參考鏈接：https://www.cnblogs.com/yyds/p/7288916.html