腳本之家服務(wù)器常用軟件

快捷導(dǎo)航

一文搞懂Python中subprocess模塊的使用

更新時(shí)間：2022年11月18日 14:20:12 作者：三爺

subprocess是子流程，即進(jìn)程的意思，該模塊可以啟動(dòng)一個(gè)新進(jìn)程，并連接到它們的輸入/輸出/錯(cuò)誤管道，從而獲取返回值。本文將和大家聊聊subprocess模塊的使用，需要的可以參考一下

簡介

subprocess是子流程，即進(jìn)程的意思，該模塊可以啟動(dòng)一個(gè)新進(jìn)程，并連接到它們的輸入/輸出/錯(cuò)誤管道，從而獲取返回值。

常用方法和接口

1、subprocess.run()

2、subprocess.call()

3、subprocess.check_call()

4、subprocess.getstatusoutput()

5、subprocess.getoutput()

6、subprocess.check_output()

7、subprocess.Popen()

subprocess.run()解析

常用參數(shù)：

args：表示要執(zhí)行的命令。必須是一個(gè)字符串，字符串參數(shù)列表。
stdin、stdout 和 stderr：子進(jìn)程的標(biāo)準(zhǔn)輸入、輸出和錯(cuò)誤。其值可以是 subprocess.PIPE、subprocess.DEVNULL、一個(gè)已經(jīng)存在的文件描述符、已經(jīng)打開的文件對象或者 None。subprocess.PIPE 表示為子進(jìn)程創(chuàng)建新的管道。subprocess.DEVNULL 表示使用 os.devnull。默認(rèn)使用的是 None，表示什么都不做。另外，stderr 可以合并到 stdout 里一起輸出。
timeout：設(shè)置命令超時(shí)時(shí)間。如果命令執(zhí)行時(shí)間超時(shí)，子進(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í)行指定的命令。

subprocess.Popen()解析

Popen 是 subprocess的核心，子進(jìn)程的創(chuàng)建和管理

常用參數(shù)：

args：shell命令，可以是字符串或者序列類型（如：list，元組）

bufsize：緩沖區(qū)大小。當(dāng)創(chuàng)建標(biāo)準(zhǔn)流的管道對象時(shí)使用，默認(rèn)-1。

0：不使用緩沖區(qū)

1：表示行緩沖，僅當(dāng)universal_newlines=True時(shí)可用，也就是文本模式

正數(shù)：表示緩沖區(qū)大小

負(fù)數(shù)：表示使用系統(tǒng)默認(rèn)的緩沖區(qū)大小。

stdin, stdout, stderr：分別表示程序的標(biāo)準(zhǔn)輸入、輸出、錯(cuò)誤句柄

preexec_fn：只在 Unix 平臺下有效，用于指定一個(gè)可執(zhí)行對象（callable object），它將在子進(jìn)程運(yù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)程中繼承。

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)程。

subprocess.run()案例

import subprocess

print(subprocess.run(["pip", "list"]))

subprocess.call()案例

執(zhí)行命令，返回命令的結(jié)果和執(zhí)行狀態(tài)，0或者非0

import subprocess

result1 = subprocess.call(["pip", "list"])
print("*" * 30)
print(result1)  # 0

result2 = subprocess.call(["pip", "list1"])
print("*" * 30)
print(result2)  # -1

# 運(yùn)行結(jié)果
# ******************************
# 0
# ERROR: unknown command "list1" - maybe you meant "list"
# ******************************
# 1

subprocess.check_call()案例

執(zhí)行命令，返回結(jié)果和狀態(tài)，正常為0 ，執(zhí)行錯(cuò)誤則拋出異常

import subprocess

result1 = subprocess.check_call(["pip", "list"])
print("*" * 30)
print(result1)

result2 = subprocess.check_call(["pip", "list2"])
print("*" * 30)
print(result2)

# 運(yùn)行結(jié)果，運(yùn)行錯(cuò)誤，拋出異常。
# ******************************
# 0
#    raise CalledProcessError(retcode, cmd)
# subprocess.CalledProcessError: Command '['pip', 'list2']' returned non-zero exit status 1.

subprocess.getstatusoutput()案例

接受字符串形式的命令，返回一個(gè)元組形式的結(jié)果，第一個(gè)元素是命令執(zhí)行狀態(tài)，第二個(gè)為執(zhí)行結(jié)果。

import subprocess

result1 = subprocess.getstatusoutput("pip --version")
print(result1)

# 返回：第一個(gè)元素0， 第二個(gè)為執(zhí)行結(jié)果
# (0, 'pip 21.1.3 from C:\\lib\\site-packages\\pip (python 3.9)\n')


result2 = subprocess.getstatusoutput("pip -vesi")
print(result2)

# 執(zhí)行失敗的案例
# (2, '\nUsage:   \n  pip <command> [options]\n\nno such option: -e')

subprocess.getoutput()案例

接受字符串形式的命令，放回執(zhí)行結(jié)果

import subprocess

result1 = subprocess.getoutput("pip --version")
print(result1)
# 返回
# pip 21.1.3 from D:\\lib\site-packages\pip (python 3.9)


result2 = subprocess.getoutput("pip -vesi")
print(result2)
# 返回
# Usage:   
#   pip <command> [options]
# 
# no such option: -e

subprocess.check_output()案例

執(zhí)行命令，返回執(zhí)行的結(jié)果，而不是打印

import subprocess

result1 = subprocess.check_output("pip --version")
print(result1)
# 返回
# b'pip 21.1.3 from D:\\lib\\site-packages\\pip (python 3.9)\r\r\n'


result2 = subprocess.check_output("pip -vesi")
print(result2)
# 返回
#     raise CalledProcessError(retcode, process.args,
# subprocess.CalledProcessError: Command 'pip -vesi' returned non-zero exit status 2.

subprocess.Popen()綜合案例

案例中視頻長度代碼，請參考 - Python：獲取視頻時(shí)長 - 實(shí)踐場景

# coding:utf-8
import time
import datetime
import subprocess
from analysis_video import video_duration

file = r"C:\Users\videos\duck.mp4"  # 請根據(jù)實(shí)際情況填寫視頻路徑
video_time = video_duration(file)
print(video_time)
video_pid = subprocess.Popen(f'C:\Program Files\Windows Media Player\wmplayer.exe {file}')


# poll(): 檢查進(jìn)程是否終止，如果終止返回 returncode，否則返回 None。
print(f"now:{datetime.datetime.now()}. - 當(dāng)前返回狀態(tài)：{video_pid.poll()}")
# now:2021-11-28 11:20:48.504796. - 當(dāng)前返回狀態(tài)：None

# 獲取當(dāng)前執(zhí)行子shell的程序的進(jìn)程號
print("當(dāng)前執(zhí)行進(jìn)程號為：{}".format(video_pid.pid))

sleeps = int(video_time) + 2
print(f"根據(jù)視頻時(shí)長等待:{sleeps}秒")
time.sleep(sleeps)

# kill(): 殺死子進(jìn)程。發(fā)送 SIGKILL 信號到子進(jìn)程。
video_pid.kill()
time.sleep(1)
print(f"now:{datetime.datetime.now()}. - 當(dāng)前返回狀態(tài)：{video_pid.poll()}")
# now:2021-11-28 11:21:05.520822. - 當(dāng)前返回狀態(tài)：1

# wait()
# 等待命令執(zhí)行完成，并且返回結(jié)果狀態(tài)
print(video_pid.wait())  # 1

運(yùn)行結(jié)果：

附，各種信號總結(jié)

SIGHUP 終止進(jìn)程終端線路掛斷
SIGINT 終止進(jìn)程中斷進(jìn)程
SIGQUIT 建立CORE文件終止進(jìn)程，并且生成core文件
SIGILL 建立CORE文件非法指令
SIGTRAP 建立CORE文件跟蹤自陷
SIGBUS 建立CORE文件總線錯(cuò)誤
SIGSEGV 建立CORE文件段非法錯(cuò)誤
SIGFPE 建立CORE文件浮點(diǎn)異常
SIGIOT 建立CORE文件執(zhí)行I/O自陷
SIGKILL 終止進(jìn)程殺死進(jìn)程
SIGPIPE 終止進(jìn)程向一個(gè)沒有讀進(jìn)程的管道寫數(shù)據(jù)
SIGALARM 終止進(jìn)程計(jì)時(shí)器到時(shí)
SIGTERM 終止進(jìn)程軟件終止信號
SIGSTOP 停止進(jìn)程非終端來的停止信號
SIGTSTP 停止進(jìn)程終端來的停止信號
SIGCONT 忽略信號繼續(xù)執(zhí)行一個(gè)停止的進(jìn)程
SIGURG 忽略信號 I/O緊急信號
SIGIO 忽略信號描述符上可以進(jìn)行I/O
SIGCHLD 忽略信號當(dāng)子進(jìn)程停止或退出時(shí)通知父進(jìn)程
SIGTTOU 停止進(jìn)程后臺進(jìn)程寫終端
SIGTTIN 停止進(jìn)程后臺進(jìn)程讀終端
SIGXGPU 終止進(jìn)程 CPU時(shí)限超時(shí)
SIGXFSZ 終止進(jìn)程文件長度過長
SIGWINCH 忽略信號窗口大小發(fā)生變化
SIGPROF 終止進(jìn)程統(tǒng)計(jì)分布圖用計(jì)時(shí)器到時(shí)
SIGUSR1 終止進(jìn)程用戶定義信號1
SIGUSR2 終止進(jìn)程用戶定義信號2
SIGVTALRM 終止進(jìn)程虛擬計(jì)時(shí)器到時(shí)