github 项目介绍 – python-fire : 将任何 Python 类别自动产生 CLI 接口

691 阅读1分钟

项目链接

python-fire

项目介绍

Python Fire 是一个可以将任何 Python 类别自动生成命令行界面(CLI)的程序库。这个开源项目由知名的搜索引擎公司 Google 所贡献,但项目后有特别声明这不是 Google 官方的产品。

看到这个项目的简洁介绍,第一个想到的功能就是利用这个程序库做测试 ,就算你不使用测试驱动开发,在使用面向对象编程程序时,应该也会先写一些小程序来测试这些定义的类别中的方法是否功能运作正常,有了 Python Fire 等于帮你省下撰写这些代码的时间,完成 Python 的类别与方法实作后就可以透过 CLI 命令行接口来测试对象。

如何安装

  • 使用 pip 套件管理可运行 pip install fire
  • 使用 conda 套件管理可运行 conda install fire -c conda-forge
  • 从原代码直接编译可下载原代码后运行 python setup.py install

基本用法

在你要生成的 Python 类别 import 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

这样做是不是帮你省下为每个类别写测试程序的时间,直接透过命令行传参数给对象的方法就可以验证功能是否正确

更多的 Python Fire 使用范例可参考 The Python Fire Guide.

为什么项目要称为 Fire ?

当你调用 Fire 时,它会触发(fires off )(运行)你的命令。


更多 Soft & Share 分享內容