Github: https://github.com/google/python-fire
Python Fire
Python Fireは、絶対に任意のPythonオブジェクトからコマンドラインインターフェイス(CLI)を自動的に生成するためのライブラリです。
- Python Fireは、PythonでCLIを作成する簡単な方法です。 [1]
- Python Fireは、Pythonコードの開発とデバッグに役立つツールです。 [2]
- Python Fireは、既存のコードを調べたり、他の人のコードをCLIに変えたりするのに役立ちます。 [3]
- Python Fireは、BashとPythonの間の移行を容易にします。 [4]
- Python Fireは、すでにインポートして作成する必要があるモジュールと変数でREPLを設定することで、Python REPLを簡単に使用できます。 [5]
インストール
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
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 Guide」を参照してください。
なぜ火と呼ばれるのですか?
Fire
を呼び出すと、あなたのコマンドを起動(実行)します。
どこでもっと知ることができますか?
The Python Fire Guideを参照してください。
参照
セットアップ | コマンド | ノート |
---|---|---|
インストール | pip install fire |
CLIの作成 | コマンド | ノート |
---|---|---|
インポート | import fire |
|
コール | fire.Fire() |
現在のモジュールをFire CLIに変換します。 |
コール | fire.Fire(component) |
component をFire CLIに変換します。 |
CLIの使用 | コマンド | ノート |
---|---|---|
助けて | command -- --help |
|
REPL | command -- --interactive |
対話モードに入ります。 |
セパレータ | command -- --separator=X |
セパレータをX 設定します。 デフォルトの区切り記号は- です。 |
完了 | command -- --completion [shell] |
CLIの完了スクリプトを生成します。 |
トレース | command -- --trace |
コマンドのFireトレースを取得します。 |
詳細 | command -- --verbose |
フラグは隔離された引数によってFireコマンドから分離されています。
免責事項
これは公式のGoogleサービスではありません。