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
基本用法
你可以打电话给Fire
在任何Python对象上:
函数、类、模块、对象、字典、列表、元组等,它们都可以工作!
以下是在函数上调用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的其他功能,请参阅Using a Fire CLI page
有关其他示例,请参见The Python Fire Guide
为什么叫“火”呢?
当你打电话给Fire
,它会触发(执行)您的命令
我在哪里可以了解更多?
参考文献
设置 | 命令 | 注意事项 |
---|---|---|
安装 | pip install fire |
创建CLI | 命令 | 注意事项 |
---|---|---|
导入 | import fire | |
打电话 | fire.Fire() | 将当前模块转换为Fire CLI |
打电话 | fire.Fire(component) | 转弯component 变成Fire CLI |
使用CLI | 命令 | 注意事项 |
---|---|---|
Help | command --help 或command -- --help | |
REPL | command -- --interactive | 进入交互模式 |
Separator | command -- --separator=X | 将分隔符设置为X 默认分隔符是- |
Completion | command -- --completion [shell] | 为CLI生成完成脚本 |
Trace | command -- --trace | 获取该命令的火灾跟踪 |
Verbose | command -- --verbose |
请注意,这些标志与消防命令之间由独立的--
许可证
根据Apache 2.0许可证
免责声明
这不是谷歌的官方产品
声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。