一. 介紹
fire是python中用於生成命令行界面(Command Line Interfaces, CLIs)的工具,不需要做任何額外的工作,只需要從主模塊中調用fire.Fire(),它會自動將你的代碼轉化為CLI,Fire()的參數可以說任何的python對象
二. 安裝
pip install fire
三. 用法
實例1 單個函數:python 模塊名 參數1 參數2
在Common目錄下新建一個test_fire.py的模塊
import fire def add(a, b): count = a + b return count if __name__ == '__main__': fire.Fire(add)
當不接參數時,執行python test_fire.py會顯示幫助信息
幫助信息里顯示了fire.Fire()的參數類型(function)、文件路徑、文檔字符串、參數用法等信息
加參數運行的結果如下:
注意:兩種方法調用,一種是直接跟實參,一種是--形參 實參的形式,為了方便,本文采取第一種
實例2 多個函數:python 模塊名 函數名 參數
import fire def add(a, b): count = a + b return count def sub(a, b): result = a - b return result if __name__ == '__main__': fire.Fire()
加上參數運行結果:
實例3 類(對象) 多個函數:python 模塊名 函數名 參數
import fire class Calculator(object): def add(self, a, b): count = a + b return count def sub(self, a, b): result = a - b return result if __name__ == '__main__': fire.Fire(Calculator) #這里用類名Calculator或者類的實例化對象Calculator()結果都是一樣的
加參數運行結果:
注意:
1. fire 默認使用 -
作為參數分隔符,所以如果你要在命令行傳入類似 2017-04-22
的參數時,那么程序接收到的參數就肯定不是 2017-04-22
了,需要使用 --separator
來改變分隔符
2. fire
會自動區分你在命令行傳入的參數的類型,例如 20170422
會自動識別成 int
,hello
會自動識別成 str
,'(1,2)'
會自動識別成 tuple
,'{"name": "Alan Lee"}'
會自動識別成 dict
。但是你如果想要傳入一個字符串類型的 20170422
怎么辦?那就需要這樣寫:'"20170422"'
或者 "'20170422'"
或者 \"20170422\"
,總之呢,就是加一個轉義,因為命令行默認會吃掉你的引號
參考文章
https://blog.csdn.net/u010099080/article/details/70332074
https://mp.weixin.qq.com/s/lMOieL_RFRHsh5OW4G4axg