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 到了吗?

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

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

非常感谢!

本文参考、借鉴的文献:
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,734评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,931评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,133评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,532评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,585评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,462评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,262评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,153评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,587评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,792评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,919评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,635评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,237评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,855评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,983评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,048评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,864评论 2 354