在自動化運維、CI/CD 流水線或測試腳本中,經常需要從 Python 呼叫 Shell 命令。標準庫 subprocess 功能強大但介面較底層。本文提供一個生產級的 Shell 封裝類,支援阻塞/非阻塞執行、狀態輪詢、強制終止、遠程 SSH 執行,並內建日誌與異常處理,開箱即用。
Shell封裝 subprocess.Popen,統一管理輸出、返回碼、錯誤資訊,提供三種呼叫模式:
run():同步阻塞,等待命令結束run_background():非阻塞啟動,立即返回wait() / get_status():異步模式下等待或輪詢狀態class Shell(object):
def __init__(self, cmd):
self.cmd = cmd
self.ret_code = None
self.ret_info = None
self.err_info = None
self.logger = MockLogger() # 可替換為真實 logger
def run_background(self):
'''非阻塞啟動,shell=True 讓 shell 處理命令不存在等錯誤'''
self._process = subprocess.Popen(
self.cmd, shell=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE
)
def run(self):
'''阻塞執行'''
self.run_background()
self.wait()
def wait(self):
'''等待結束並收集輸出'''
self.ret_info, self.err_info = self._process.communicate()
self.ret_code = self._process.returncode
def get_status(self):
'''輪詢狀態:RUNNING / FINISHED'''
retcode = self._process.poll()
return "FINISHED" if retcode is not None else "RUNNING"
def kill(self):
'''強制終止(SIGKILL)'''
os.kill(self._process.pid, signal.SIGKILL)
self.wait() # 必須再 wait 回收進程資源
RemoteShell / RemoteShell2透過 SSH 將命令發送到遠端主機,自動處理金鑰認證、超時與嚴格主機檢查:
class RemoteShell(Shell):
def __init__(self, cmd, ip):
ssh = ('ssh -o PreferredAuthentications=publickey '
'-o StrictHostKeyChecking=no -o ConnectTimeout=10')
cmd = '%s %s "%s"' % (ssh, ip, cmd)
Shell.__init__(self, cmd)
RemoteShell2 僅調整引號策略,適合命令包含雙引號的場景。
# 本地同步執行
sh = Shell("sleep 2 && echo hello")
sh.run()
print(sh.ret_code, sh.ret_info)
# 異步執行 + 超時殺掉
sh = Shell("sleep 10")
sh.run_background()
for _ in range(5):
if sh.get_status() == "FINISHED": break
time.sleep(1)
else:
sh.kill() # 超時強殺
communicate() 會將所有輸出載入記憶體,若命令產生 GB 級日誌需改用迴圈讀取 stdout 流。encoding='utf-8', errors='replace' 參數避免解碼失敗。signal.SIGKILL 在 Windows 無效,需改用 taskkill /PID 或 ctypes 呼叫 TerminateProcess。MockLogger 方便測試時捕獲日誌,正式環境注入 logging.Logger 實例。這個封裝類已在多個專案穩定運行,涵蓋本地構建、遠程部署、健康檢查等場景,歡迎根據業務需求二次開發。