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 官方产品。