python fire
v0.7.0
Python Fire 是一個用於從任何 Python 物件自動產生命令列介面 (CLI) 的函式庫。
若要使用 pip 安裝 Python Fire,請執行: pip install fire
若要使用 conda 安裝 Python Fire,請執行: conda install fire -c conda-forge
若要從來源安裝 Python Fire,請先複製儲存庫,然後執行: python setup.py install
您可以在任何 Python 物件上呼叫Fire
:
函數、類別、模組、物件、字典、列表、元組等。
下面是在函數上呼叫 Fire 的範例。
import fire
def hello ( name = "World" ):
return "Hello %s!" % name
if __name__ == '__main__' :
fire . Fire ( hello )
然後,您可以從命令列運行:
python hello.py # Hello World!
python hello.py --name=David # Hello David!
python hello.py --help # Shows usage information.
下面是在類別上呼叫 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
若要了解 Fire 在函數、物件、字典、清單等上的行為方式以及 Fire 的其他功能,請參閱使用 Fire CLI 頁面。
有關其他範例,請參閱 Python Fire 指南。
當您呼叫Fire
時,它會觸發(執行)您的命令。
請參閱 Python Fire 指南。
設定 | 命令 | 筆記 |
---|---|---|
安裝 | pip install fire |
創建 CLI | 命令 | 筆記 |
---|---|---|
進口 | import fire | |
稱呼 | fire.Fire() | 將當前模組轉變為 Fire CLI。 |
稱呼 | fire.Fire(component) | 將component 變成 Fire CLI。 |
使用 CLI | 命令 | 筆記 |
---|---|---|
幫助 | command --help 或command -- --help | |
REPL | command -- --interactive | 進入交互模式。 |
分離器 | command -- --separator=X | 將分隔符號設定為X 。預設分隔符號是- 。 |
完成 | command -- --completion [shell] | 產生 CLI 的完成腳本。 |
痕跡 | command -- --trace | 獲取命令的火災追蹤。 |
冗長 | command -- --verbose |
請注意,這些標誌與 Fire 命令之間透過獨立的--
分隔。
根據 Apache 2.0 許可證獲得許可。
這不是 Google 官方產品。