Python 命令行工具库：Fire

前言

来啦老铁！

又到了学习的时间啦，今天来学点最近公司大佬提到的一个小知识点，它就是 Python 的：

• Fire 库。

当然，目的不是在精通（做不到也没必要），而是学习其基本用法和便利之处。

整体步骤

1. 简单介绍一下 Fire；
2. 先简单 Demo 相似模块： argparse；
3. 安装 fire 模块；
4. 逐个使用函数；
5. 函数的链式调用；
6. 参数解析功能；

1. 简单介绍一下 Fire；

Python Fire 是 Google 开源的一个可从任何 Python 代码自动生成命令行接口（CLI）的库。

• Python Fire 是一种在 Python 中创建 CLI 的简单方法。
• Python Fire 是开发和调试 Python 代码的有用工具。
• Python Fire 帮助探索现有代码或将其他人的代码转换为CLI。
• Python Fire 使 Bash 和 Python 之间的转换更为容易。
• Python Fire 通过使用你需要导入和创建的模块和变量来设置 REPL，使得使用 Python REPL 更容易。
  （摘抄自：https://www.oschina.net/p/python-fire?hmsr=aladdin1e1）

让我不禁想到另一个之前用过的一个生成命令行参数的模块：argparse，下面先来简单 Demo 一下 argparse 模块；

2. 先简单 Demo 相似模块： argparse；

• 直接上代码（本 Demo 文件名为 argparseDemo.py）：

import argparse


def test():
    parser = argparse.ArgumentParser()
    parser.add_argument("-n", "--name", default=0)
    args = parser.parse_args()
    print(f"Hello {args.name} !")


if __name__ == '__main__':
    test()

• 演示：

python3 argparseDemo.py --name=dylan

或：

python3 argparseDemo.py -n=dylan

• 则命令行输出：

命令行输出

我们看到 name 参数传到 test() 方法了，也就做到 REPL 的效果了，不过可想而知，如果要对传入的不同参数，做不同的逻辑处理，则需要写很多逻辑判断语句，代码应该不会很“整洁”~
而 fire 模块在这方面就显得很不一样了，接下来我们来学学 fire 模块。

3. 安装 fire 模块；

pip3 install fire

4. 逐个使用函数；

1). 单个函数；

• 代码：

import fire


def add(first_number, second_number):
    return first_number + second_number


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

• 演示：

python3 demo.py - add 3 4

或：

python3 demo.py - add --first_number=3 --second_number=4

• 则命令行输出：7

则命令行输出：7

2). 多个函数；

• 代码：

import fire


def add(first_number, second_number):
    return first_number + second_number


def subtract(first_number, second_number):
    return first_number - second_number


def multiply(first_number, second_number):
    return first_number * second_number


def divide(first_number, second_number):
    return first_number / second_number


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

• 演示：

python3 demo.py - multiply 4 5

或：

python3 demo.py - multiply --first_number=4 --second_number=5

• 则命令行输出：20

则命令行输出：20

当然，现在还只能一个函数一个函数调用，无法做到链式调用的效果，如：

python3 demo.py - add 3 4 - multiply 4 5

链式调用报错

当然，fire 是能够做到函数的链式调用的，只是要稍微处理一下，请往下阅读~

5. 函数的链式调用；

• 代码：

import fire


class Calculator(object):
    def __init__(self, init_number):
        self.init_number = init_number
        self.result = self.init_number

    def __str__(self):
        return str(self.result)

    def add(self, number):
        self.result = self.result + number
        return self

    def subtract(self, number):
        self.result = self.result - number
        return self

    def multiply(self, number):
        self.result = self.result * number
        return self

    def divide(self, number):
        self.result = self.result / number
        return self

    def to_integer(self):
        self.result = int(self.result)
        return self


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

1). 函数链式调用演示；

• 演示：

python3 main.py --init_number=8 - add 4 - multiply 3

• 则命令行输出：36

命令行输出：36

• 再如：

python3 main.py --init_number=8 - add 4 - divide 2

• 则命令行输出：6.0

则命令行输出：6.0

• 再如我们在上面的基础上再将结果转为整数：

python3 main.py --init_number=8 - add 4 - divide 2 - to_integer

• 则命令行输出：6

命令行输出：6

2). 函数带可变参数链式调用演示；

• 代码：

import fire


class Calculator(object):
    def __init__(self, init_number):
        self.init_number = init_number
        self.result = self.init_number

    def __str__(self):
        return str(self.result)

    def add(self, number):
        self.result = self.result + number
        return self

    def subtract(self, number):
        self.result = self.result - number
        return self

    def multiply(self, number):
        self.result = self.result * number
        return self

    def divide(self, number):
        self.result = self.result / number
        return self

    def to_integer(self):
        self.result = int(self.result)
        return self

    def batch_add(self, *numbers):
        self.result += sum(numbers)
        return self


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

• 演示：

python3 main.py --init_number=8 - add 4 - divide 2 - to_integer - batch_add 1 3 4 6

• 则命令行输出：20
  （因为 batch_add 方法可以传递多个值，且 batch_add 实际上是将所有传递进方法的参数累加到 self.result 变量中去，因此此处为：6 + 1 + 3 + 4 + 6 = 20）

命令行输出：20

6. 参数解析功能；

• 代码：

import fire


def test_type():
    return lambda obj: type(obj).__name__


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

• 演示：

python3 example.py --obj=10

或（后续例子不再重复介绍）：

python3 example.py 10

控制台输出：int

python3 example.py --obj="10"

控制台输出：int

python3 example.py --obj=\"10\"

控制台输出：str

python3 example.py --obj=True

控制台输出：bool

python3 example.py --obj='{"name":"dylan"}'

控制台输出：dict

可见，fire 模块的功能比 argparse 强大得多，用起来也更为顺手，代码也十分优雅，你 get 到了吗？

好了，今天我们就到这儿吧，有兴趣的朋友不妨练练手~

如果本文对您有帮助，麻烦动动手指点点赞？

非常感谢！

本文参考、借鉴的文献：

• https://blog.csdn.net/John_xyz/article/details/104045312
• https://zhuanlan.zhihu.com/p/25743443
• https://www.jianshu.com/p/1566ab4040c5