ShutIt:一個基於 Python 的 shell 自動化框架

發表於2017-06-17

譯者注:本文通過例項簡單介紹了ShutIt這個基於Python的自動化框架的使用方法。除了pexpect,我們又多了這個選擇。以下是譯文。

ShutIt是一個易於使用的基於shell的自動化框架。它對基於python的expect庫(pexpect)進行了包裝。你可以把它看作是“沒有痛點的expect”。它可以通過pip進行安裝。

Hello World

讓我們從最簡單的例子開始吧。建立一個名為example.py的檔案:

執行這個檔案:

輸出:

“send”函式的第一個引數是要執行的命令。“echo”的引數將會輸出到終端上。預設情況下,ShutIt是靜默的。

登入伺服器

如果你要登陸一臺伺服器並執行伺服器上的命令。可以將example.py改為:

程式將登入到這臺伺服器上,並輸出主機名。

顯然,這很不安全!你可以這樣執行:

它會讓你輸入密碼:

同樣的,“login”方法在登入後改變了提示符。你給了ShutIt一個登入命令,並附帶使用者名稱和密碼(如果需要的話),然後,ShutIt會完成剩餘的事情。

“logout”負責終止“login”,並向螢幕輸出發生的任何變化。

登入到多臺伺服器

假設你有一個叢集包含兩臺伺服器,並希望同時登入到這兩個伺服器上去。則只需要建立兩個會話,並執行類似的login和send命令:

將輸出這樣的結果:

例項:監控多臺伺服器

我們可以通過新增一些程式碼邏輯來檢查命令的輸出,從而將上述程式碼變成一個簡單的監控工具:

在這裡,我們用了“sendandget_output”方法來獲取capacity_command命令的輸出。

還有很多更加優雅的方法可以完成上面的操作,但這取決於你想要Python有多聰明。

更復雜的IO – Expecting

假設你需要跟一個命令列程式進行互動,並且要實現自動化操作。在這裡,我們使用telnet來舉一個簡單的例子:

注意“expect”的引數。你只需要給出telnet提示符的一個子集來進行匹配。

注意“check_exit”的引數,後面我們會講到這個引數的。上面這段程式碼將輸出:

現在回到“checkexit = false”上來。由於telnet命令會返回一個錯誤的退出碼(1),我們不想讓指令碼執行失敗,這裡的“checkexit = false”能讓ShutIt知道你並不關注這個退出碼。

如果你沒有傳入這個引數,ShutIt會給你一個互動式的提示,如果你有終端接入的話。這被稱為“暫停點”。

暫停點

你可以隨便在什麼時候通過呼叫以下方法來設定一個“暫停點”。

當指令碼執行到暫停點時,同時按下“Ctrl”和“]”,則可以讓指令碼繼續執行。這對於除錯非常有用:新增一個暫停點,看看周圍,然後繼續。試試這個:

程式輸出:

更復雜的IO – Backgrounding

回到我們上面的“監控多臺伺服器”的例子上來。想象一下,我們要在每臺伺服器上執行一個長時間執行的任務。預設情況下,ShutIt會持續執行很長時間。但是我們可以在後臺執行任務來加快ShutIt的執行速度。

在這裡,你可以使用簡單的命令“sleep 60”來嘗試一個例子。

我的膝上型電腦說,執行這兩個命令只需花費0.5秒,而指令碼在一分鐘以後才執行結束(使用了’wait’方法)。

雖然這個例子看起來是微不足道的,但是想像一下,如果你有數百臺這樣的伺服器需要管理,那麼你可以看到這幾行程式碼和一個python import所帶來的強大的力量。

更多資訊

ShutIt可以做很多事。更多資訊,請參閱:
ShutIt
GitHub

相關文章