subprocess源碼解讀

subprocess模塊源碼介紹

• 介紹

  subprocess生成新的進(jìn)程,連接input/output管道,并獲取返回碼.

• 常用函數(shù)	subprocess.run()	執(zhí)行指定命令完成并返回一個(gè)包含執(zhí)行結(jié)果的CompletedProcess類(lèi)的實(shí)例。.
  call()	執(zhí)行指定的命令，返回命令執(zhí)行狀態(tài)
  check_call()	執(zhí)行指定的命令，如果執(zhí)行成功則返回狀態(tài)碼，否則拋出異常
  check_output()	執(zhí)行指定的命令，如果執(zhí)行狀態(tài)碼為0則返回命令執(zhí)行結(jié)果，否則拋出異常
  getoutput(cmd)	接收字符串格式的命令，執(zhí)行命令并返回執(zhí)行結(jié)果
  getstatusoutput(cmd)	執(zhí)行cmd命令，返回一個(gè)元組(命令執(zhí)行狀態(tài),命令執(zhí)行結(jié)果輸出)

• 參數(shù)說(shuō)明

  • args: 執(zhí)行的shell命令(字符串序列),shell參數(shù)值應(yīng)該為T(mén)rue.
  • shell: shell為T(mén)rue,指定命令通過(guò)shell執(zhí)行.
  • check: 為T(mén)rue,且執(zhí)行命令的進(jìn)程以非0狀態(tài)碼退出，則會(huì)拋出一個(gè)CalledProcessError的異常.
  • stdout,stderr:
  • run() 函數(shù)不捕獲命令執(zhí)行結(jié)果的正常和錯(cuò)誤輸出.向獲取這些內(nèi)容傳遞subprocess.PIPE，然后可以通過(guò)返回的CompletedProcess類(lèi)實(shí)例的stdout和stderr屬性或捕獲相應(yīng)的內(nèi)容；
  • call()和check_call()函數(shù)返回的是命令執(zhí)行狀態(tài)碼.
  • check_output() 返回執(zhí)行命令結(jié)果.在結(jié)果中捕獲錯(cuò)誤信息，可以執(zhí)行stderr=subprocess.STDOUT。
  • input: 該參數(shù)值是字節(jié)序列.
  • universal_newlines: 影響的是輸入與輸出的數(shù)據(jù)格式.

• subprocess.CompletedProcess類(lèi)介紹

  表示的是一個(gè)已結(jié)束進(jìn)程的狀態(tài)信息.包含屬性如下:

  • args: 加載該進(jìn)程的參數(shù).
  • returncode 子進(jìn)程的退出狀態(tài)碼.
  • stdout: 從子進(jìn)程捕獲的stdout.一個(gè)字節(jié)序列. 指定universal_newlines=True，則該屬性值是一個(gè)字符串.
  • stderr: 從子進(jìn)程捕獲的stderr。值是一個(gè)字節(jié)序列或一個(gè)字符串。
  • check_returncode(): 如果returncode是一個(gè)非0值，則該方法會(huì)拋出一個(gè)CalledProcessError異常。.

• 示例

  • run()

    
    In [2]: subprocess.run(["ls","-l"])
    -rw-r--r-- 1 liyuanjie liyuanjie 1350 12月 15 18:33 wireshark.md
    Out[2]: CompletedProcess(args=['ls', '-l'], returncode=0)

  In [3]: subprocess.run(["ls","-l","/dev/null"],stdout=subprocess.PIPE)
  Out[3]: CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0, stdout=b'
  crw-rw-rw- 1 root root 1, 3 12\xe6\x9c\x88 15 07:51 /dev/null\n')

  
  - call()
  

  In [4]: subprocess.call(['ls','-l'])
  In [5]: subprocess.call('ls -l',shell=True)

  In [6]: subprocess.call(['ls','-l'],stdout=subprocess.DEVNULL)
  Out[6]: 0

  In [7]: subprocess.call(['ls','-l','/services'])

  
  - check_call()
  

  In [9]: subprocess.check_call(['ls','-l'])
  In [10]: subprocess.check_call('ls -l',shell=True)

  In [11]: subprocess.check_call('ls -l /services',shell=True)

  
  - check_output()
  

  In [12]: ret = subprocess.check_output(['ls','-l'])
  In [13]: print(ret) 返回的是字節(jié)序列.

  In [14]: ret = subprocess.check_output(['ls','-l'],universal_newlines=True)
  In [15]: print(ret) 返回的是字符串.

  
  - getoutput()與getstatusoutput()
  

  In [16]: ret = subprocess.getoutput('ls -l')
  In [17]: print(ret)

  正確情況下:
  In [18]: retcode,output = subprocess.getstatusoutput('ls -l')
  In [19]: print(retcode)
  0
  In [20]: print(output)

  錯(cuò)誤情況下:
  In [21]: retcode,output = subprocess.getstatusoutput('ls -l /test')
  In [22]: print(retcode)
  2

  In [23]: print(output)
  ls: cannot access '/test': No such file or directory

subprocess.Popen介紹

該類(lèi)用于在一個(gè)新的進(jìn)程中執(zhí)行一個(gè)子程序.由于subprocess模塊底層的進(jìn)程創(chuàng)建和管理是由Popen類(lèi)來(lái)處理的. 可以通過(guò)subprocess.Popen類(lèi)提供的靈活的api來(lái)完成.

• Popen的構(gòu)造函數(shù)

  參數(shù)說(shuō)明

  • args: shell命令.
  • bufsize: 指定緩存策略,0表示不緩沖,1表示行緩沖.負(fù)數(shù) 表示使用系統(tǒng)默認(rèn)緩沖策略。
  • stdin,stdout,stderr： 分別表示程序標(biāo)準(zhǔn)輸入,輸出,錯(cuò)誤句柄。
  • preexec_fn: 用于指定一個(gè)將在子進(jìn)程運(yùn)行之前被調(diào)用的可執(zhí)行對(duì)象.
  • close_fds: 值為T(mén)rue時(shí),所有文件描述符都將在子進(jìn)程執(zhí)行前關(guān)閉.
  • shell: 標(biāo)識(shí)是否使用shell作為要執(zhí)行的程序.
  • cwd: 該函數(shù)會(huì)在執(zhí)行這個(gè)子進(jìn)程之前改變當(dāng)前工作目錄.
  • env: 用于指定子進(jìn)程的環(huán)境變量.
  • universal_newlines為T(mén)rue時(shí),則該文件對(duì)象的stdin，stdout和stderr將會(huì)作為文本流被打開(kāi)，否則他們將會(huì)被作為二進(jìn)制流被打開(kāi)。

• Popen類(lèi)的實(shí)例可調(diào)用的方法

  Popen.poll()	檢查命令是否已經(jīng)執(zhí)行結(jié)束.
  wait(timeout=None)	等待子進(jìn)程結(jié)束,返回狀態(tài)碼.
  communicate()	與進(jìn)程進(jìn)行交互.
  send_signal(signal)	發(fā)送指定的信號(hào)給這個(gè)子進(jìn)程
  terminate()	停止該子進(jìn)程.
  kill()	殺死該子進(jìn)程.

• 示例

  In [25]: p = subprocess.Popen('df -hT',stdout=subprocess.PIPE,shell=True)
  In [26]: print(p.stdout.read())
  
  In [2]: p1 = subprocess.Popen(['df','-Th'],stdout=subprocess.PIPE)
  In [3]: p2 = subprocess.Popen(['grep','dev'],stdin=p1.stdout,stdout=subprocess.PIPE)
  
  In [4]: out,err = p2.communicate()
  In [5]: print(out)