subprocess 模塊允許我們啟動一個新進(jìn)程,并連接到它們的輸入/輸出/錯誤管道,從而獲取返回值。
使用 subprocess 模塊
subprocess 模塊首先推薦使用的是它的 run 方法,更高級的用法可以直接使用 Popen 接口。
run 方法語法格式如下:
subprocess.run(args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None)
- args:表示要執(zhí)行的命令。必須是一個字符串,字符串參數(shù)列表。
- stdin、stdout 和 stderr:子進(jìn)程的標(biāo)準(zhǔn)輸入、輸出和錯誤。其值可以是 subprocess.PIPE、subprocess.DEVNULL、一個已經(jīng)存在的文件描述符、已經(jīng)打開的文件對象或者 None。subprocess.PIPE 表示為子進(jìn)程創(chuàng)建新的管道。subprocess.DEVNULL 表示使用 os.devnull。默認(rèn)使用的是 None,表示什么都不做。另外,stderr 可以合并到 stdout 里一起輸出。
- timeout:設(shè)置命令超時時間。如果命令執(zhí)行時間超時,子進(jìn)程將被殺死,并彈出 TimeoutExpired 異常。
- check:如果該參數(shù)設(shè)置為 True,并且進(jìn)程退出狀態(tài)碼不是 0,則彈 出 CalledProcessError 異常。
- encoding: 如果指定了該參數(shù),則 stdin、stdout 和 stderr 可以接收字符串?dāng)?shù)據(jù),并以該編碼方式編碼。否則只接收 bytes 類型的數(shù)據(jù)。
- shell:如果該參數(shù)為 True,將通過操作系統(tǒng)的 shell 執(zhí)行指定的命令。
run 方法調(diào)用方式返回 CompletedProcess 實例,和直接 Popen 差不多,實現(xiàn)是一樣的,實際也是調(diào)用 Popen,與 Popen 構(gòu)造函數(shù)大致相同,例如:
實例
>>> subprocess.run(["ls", "-l", "/dev/null"])
crw-rw-rw- 1 root wheel 3, 2 5 4 13:34 /dev/null
CompletedProcess(args=[‘ls’, ‘-l’, ‘/dev/null’], returncode=0)
returncode: 執(zhí)行完子進(jìn)程狀態(tài),通常返回狀態(tài)為0則表明它已經(jīng)運行完畢,若值為負(fù)值 “-N”,表明子進(jìn)程被終。
簡單實例:
實例
def runcmd(command):
ret = subprocess.run(command,shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE,encoding="utf-8",timeout=1)
if ret.returncode == 0:
print("success:",ret)
else:
print("error:",ret)
runcmd(["dir","/b"])#序列參數(shù)
runcmd("exit 1")#字符串參數(shù)
輸出結(jié)果如下:
success: CompletedProcess(args=['dir', '/b'], returncode=0, stdout='test.pyn', stderr='') error: CompletedProcess(args='exit 1', returncode=1, stdout='', stderr='')
Popen() 方法
Popen 是 subprocess的核心,子進(jìn)程的創(chuàng)建和管理都靠它處理。
構(gòu)造函數(shù):
class subprocess.Popen(args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=True, 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)
常用參數(shù):
- args:shell命令,可以是字符串或者序列類型(如:list,元組)
- bufsize:緩沖區(qū)大小。當(dāng)創(chuàng)建標(biāo)準(zhǔn)流的管道對象時使用,默認(rèn)-1。
0:不使用緩沖區(qū)
1:表示行緩沖,僅當(dāng)universal_newlines=True時可用,也就是文本模式
正數(shù):表示緩沖區(qū)大小
負(fù)數(shù):表示使用系統(tǒng)默認(rèn)的緩沖區(qū)大小。 - stdin, stdout, stderr:分別表示程序的標(biāo)準(zhǔn)輸入、輸出、錯誤句柄
- preexec_fn:只在 Unix 平臺下有效,用于指定一個可執(zhí)行對象(callable object),它將在子進(jìn)程運行之前被調(diào)用
- shell:如果該參數(shù)為 True,將通過操作系統(tǒng)的 shell 執(zhí)行指定的命令。
- cwd:用于設(shè)置子進(jìn)程的當(dāng)前目錄。
- env:用于指定子進(jìn)程的環(huán)境變量。如果 env = None,子進(jìn)程的環(huán)境變量將從父進(jìn)程中繼承。
創(chuàng)建一個子進(jìn)程,然后執(zhí)行一個簡單的命令:
實例
>>> p = subprocess.Popen(‘ls -l’, shell=True)
>>> total 164
-rw-r–r– 1 root root 133 Jul 4 16:25 admin-openrc.sh
-rw-r–r– 1 root root 268 Jul 10 15:55 admin-openrc-v3.sh
…
>>> p.returncode
>>> p.wait()
0
>>> p.returncode
這里也可以使用 p = subprocess.Popen([‘ls’, ‘-cl’]) 來創(chuàng)建子進(jìn)程。
Popen 對象方法
- poll(): 檢查進(jìn)程是否終止,如果終止返回 returncode,否則返回 None。
- wait(timeout): 等待子進(jìn)程終止。
- communicate(input,timeout): 和子進(jìn)程交互,發(fā)送和讀取數(shù)據(jù)。
- send_signal(singnal): 發(fā)送信號到子進(jìn)程 。
- terminate(): 停止子進(jìn)程,也就是發(fā)送SIGTERM信號到子進(jìn)程。
- kill(): 殺死子進(jìn)程。發(fā)送 SIGKILL 信號到子進(jìn)程。
實例
import subprocess
def cmd(command):
subp = subprocess.Popen(command,shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE,encoding="utf-8")
subp.wait(2)
if subp.poll() == 0:
print(subp.communicate()[1])
else:
print("失敗")
cmd("java -version")
cmd("exit 1")
輸出結(jié)果如下:
java version "1.8.0_31" Java(TM) SE Runtime Environment (build 1.8.0_31-b13) Java HotSpot(TM) 64-Bit Server VM (build 25.31-b07, mixed mode) 失敗
參考文章:
https://blog.csdn.net/weixin_42547344/article/details/80894760
https://blog.csdn.net/maosijunzi/article/details/80138458