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 | コマンドの Fire トレースを取得します。 |
冗長 | command -- --verbose |
これらのフラグは、孤立した--
によって Fire コマンドから区切られていることに注意してください。
Apache 2.0 ライセンスに基づいてライセンスされています。
これは Google の公式製品ではありません。