使用fire打造你自己的命令行工具

前言

今天我的朋友小黄咨询我关于命令行的问题。他觉得他们团队的部署小组开发的命令行工具特别好用，可以用来部署环境，升级环境，检查环境等。他很好奇这到底是怎么做的。处于好奇，我们今天就一起来用 Python 写一个专属于我们自己的命令行工具。

关于 fire

今天我们要讲的主角就是 fire，他到底有什么魅力呢？

1. 快速打造命令行工具。
2. 可以简单的讲已有的代码转化为命令行。
3. 可以智能的生成命令提示。

呆猫

安装 fire

pip install fire

原始代码

cli-fire.py

def execAdd(a, b):
    print(a + b)


def sayHi(name):
    print(f'Hi,{name}')


if __name__ == '__main__':
    execAdd(1, 2)
    sayHi(name='phyger')

我们可以看到原始代码很简单，就是两个函数，分别实现加法和打招呼的功能。我们通过 Python 执行这个 py 文件就能得到我们需要的结果。

原始代码的执行结果

但是如果我们需要传入不同的参数的时候，我们就需要去修改函数的入参，显得比较麻烦。这个时候我们可以通过 fire 将原有的代码转化为命令行工具，这样我们就可以在命令行中传入参数即可。

使用 fire 进行转化

cli-fire.py

import fire
def execAdd(a, b):
    print(a + b)


def sayHi(name):
    print(f'Hi,{name}')


if __name__ == '__main__':
    fire.Fire()

如上，我们只导入了 fire，然后在主函数中调用了 Fire 方法。仅需两步就将我们已有的代码转化为了命令行。当然你直接写新的方法和类也是没有问题的。

我们执行 python3 cli-fire.py --help 看看效果。

--help

我们可以看到 fire 不但将我们的代码转换为了命令方式，而且能够自动识别我们的函数。

我们执行 python3 cli-fire.py execAdd 看看效果。

不带参数的效果

可以看到 fire 提示我们缺少参数，我们加上参数试试 python3 cli-fire.py execAdd 1 2。

成功

同样的套路我们再试试 python3 cli-fire.py sayHi Python 全栈开发+Python 研究所

成功

总结

怎么样，你学废了吗？例子虽然简单，但道理不简单。你可以在函数的内部去做任何你想做的事情，比如去查询天气，股票指数，商品价格等等。最后希望我的分享能对你有帮助。