Python-Fire:將任何 Python 類別自動產生 CLI 介面

這是一個可以將任何 Python 類別自動生成命令列界面(CLI)的程式庫。這個開源專案由知名的搜尋引擎公司 Google 所貢獻,但專案後有特別聲明這不是 Google 官方的產品。

看到這個專案的簡潔介紹,第一個想到的功能就是利用這個程式庫做測試 ,就算你不使用測試驅動開發,在使用物件導向程式設計程式時,應該也會先寫一些小程式來測試這些定義的類別中的方法是否功能運作正常,有了 Python Fire 等於幫你省下撰寫這些程式碼的時間,完成 Python 的類別與方法實作後就可以透過 CLI 命令列介面來測試物件。

如何安裝

  • 使用 pip 套件管理可執行 pip install fire
  • 使用 conda 套件管理可執行 conda install fire -c conda-forge
  • 從原始碼直接編譯可下載原始碼後執行 python setup.py install

基本用法

在你要生成的 Python 類別  import fire ,例如以下的範例程式

import fire

class Calculator(object):
  """A simple calculator class."""

  def double(self, number):
    return 2 * number

if __name__ == '__main__':
  fire.Fire(Calculator)

然後就可以在命令列中開始測試這個類別

python calculator.py double 10  # 20
python calculator.py double --number=15  # 30

這樣做是不是幫你省下為每個類別寫測試程式的時間,直接透過命令列傳參數給物件的方法就可以驗證功能是否正確

更多的 Python Fire 使用範例可參考 The Python Fire Guide.

為什麼專案要稱為 Fire ?

當你調用 Fire 時,它會觸發(fires off )(執行)你的命令。

專案網址

相關線上課程


網站最新內容

使用 e-mail 追蹤 Soft & Share

Comments are closed.

Powered by WordPress.com.

Up ↑

%d 位部落客按了讚: