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 通过预先导入和创建所需的模块和变量，使使用 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

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  # 显示使用信息。

这是在类上调用 Fire 的示例。

import fire

class Calculator(object):
  """一个简单的计算器类。"""

  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？

当您调用 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`