巧用Google Fire简化Python命令行程序

最新推荐文章于 2022-01-28 01:45:00 发布
最新推荐文章于 2022-01-28 01:45:00 发布
阅读量367 收藏
点赞数
文章标签： python 数据库 shell
原文链接：https://juejin.im/post/5b17b017f265da6e13490a08
版权

Hello World

要介绍Fire是什么，看一个简单的例子就明白了

# calc.py
import fire

class Calculator(object):
  """A simple calculator class."""

  def double(self, number):
    return 2 * number

if __name__ == '__main__':
  fire.Fire(Calculator)
复制代码

接下来我们进入bash来执行上面编写的脚本

> python calc.py double 10
20
> python calc.py double --number=16
32
复制代码

上面是官方的示例代码，有了fire，编写Python的命令行程序就变得非常简单，我们无需再去处理繁琐的命令行参数解析了。接下来我们仿照HelloWorld，编写一个圆周率和阶乘计算的命令行脚本。

实战

import math
import fire


class Math(object):

    def pi(self, n):
        s = 0.0
        for i in range(n):
            s += 1.0/(i+1)/(i+1)
        return math.sqrt(6*s)

    def fact(self, n):
        s = 1
        for i in range(n):
            s *= (i+1)
        return s


if __name__ == '__main__':
    fire.Fire(Math)
复制代码

接下来我们运行一下

>  python maths.py pi 10000
3.14149716395
>  python maths.py pi 100000
3.14158310433
>  python maths.py pi 1000000
3.14159169866
>  python maths.py fact 10
3628800
>  python maths.py fact 15
1307674368000
>  python maths.py fact 20
2432902008176640000
复制代码

Cool，真的非常方便！fire对当前对象结构进行了暴露，将结构信息映射到shell命令行参数上。fire其实有多种暴露模式，接下来我们逐个来看fire都有哪些暴露模式。

暴露模块

fire如果不传递任何参数就可以直接暴露当前模块结构，我们对上面的例子做一下改造，去掉类信息

import math
import fire


def pi(n):
    s = 0.0
    for i in range(n):
        s += 1.0/(i+1)/(i+1)
    return math.sqrt(6*s)

def fact(n):
    s = 1
    for i in range(n):
        s *= (i+1)
    return s


if __name__ == '__main__':
    fire.Fire()
复制代码

注意Fire函数调用没有任何参数，运行一下

>  python maths.py fact 20
2432902008176640000
>  python maths.py pi 1000000
3.14159169866
复制代码

暴露函数

fire还可以传递一个函数对象来暴露单个函数，可以让我们在命令行参数上省掉函数名称

import math
import fire


def pi(n):
    s = 0.0
    for i in range(n):
        s += 1.0/(i+1)/(i+1)
    return math.sqrt(6*s)


if __name__ == '__main__':
    fire.Fire(pi)
复制代码

如果暴露函数那就只能暴露一个函数，如果暴露了两个，那就只有后面一个生效，运行一下

>  python maths.py 1000
3.14063805621
复制代码

暴露字典

fire可以直接暴露一个模块，将当前模块的所有函数全部暴露，函数名和第一个参数名一致。我们也可以不用暴露整个模块的所有函数，使用字典暴露法就可以选择性地对模块的某些函数进行暴露，顺便还可以替换暴露出来的函数名称。

import math
import fire


def pi(n):
    s = 0.0
    for i in range(n):
        s += 1.0/(i+1)/(i+1)
    return math.sqrt(6*s)

def fact(n):
    s = 1
    for i in range(n):
        s *= (i+1)
    return s


if __name__ == '__main__':
    fire.Fire({
        "pi[n]": pi
    })
复制代码

我们只暴露了pi函数，并且把名字还换掉了，运行一下，看效果

>  python maths.py pi[n] 1000
3.14063805621
复制代码

如果我们使用原函数名称，就会看到fire列出的友好的报错信息

>  python maths.py pi 1000
Fire trace:
1. Initial component
2. ('Cannot find target in dict:', 'pi', {'pi[n]': <function pi at 0x10a062c08>})

Type:        dict
String form: {'pi[n]': <function pi at 0x10a062c08>}
Length:      1

Usage:       maths.py
             maths.py pi[n]
复制代码

暴露对象

import math
import fire


class Maths(object):

    def pi(self, n):
        s = 0.0
        for i in range(n):
            s += 1.0/(i+1)/(i+1)
        return math.sqrt(6*s)

    def fact(self, n):
        s = 1
        for i in range(n):
            s *= (i+1)
        return s


if __name__ == '__main__':
    fire.Fire(Maths())
复制代码

运行

>  python maths.py pi 1000
3.14063805621
>  python maths.py fact 20
2432902008176640000
复制代码

暴露类

这个我们在上面的实战环节已经演示过了，这里就不在重复粘贴

类 vs 对象

通过上面的例子，我们发现暴露类和暴露对象似乎没有任何区别，那到底该选哪种比较优雅呢？这个要看类的构造器有没有参数，如果是不带参数的构造器，那么类和对象的暴露是没有区别的，但是如果类的构造器有参数，那就不一样了，下面我们改造一下Maths类，增加一个放大系数。

import math
import fire


class Maths(object):

    def __init__(self, coeff):
        self.coeff = coeff

    def pi(self, n):
        s = 0.0
        for i in range(n):
            s += 1.0/(i+1)/(i+1)
        return self.coeff * math.sqrt(6*s)

    def fact(self, n):
        s = 1
        for i in range(n):
            s *= (i+1)
        return self.coeff * s


if __name__ == '__main__':
    fire.Fire(Maths)
复制代码

因为Maths的构造器带有参数，所有运行命令行时需要指定构造器参数值

> python maths.py pi 1000 --coeff=2
6.28127611241
复制代码

如果不指定参数的值，运行时就会报错

> python maths.py pi 1000
Fire trace:
1. Initial component
2. ('The function received no value for the required argument:', 'coeff')

Type:        type
String form: <class '__main__.Maths'>
File:        ~/source/rollado/maths.py
Line:        5

Usage:       maths.py COEFF
             maths.py --coeff COEFF
复制代码

如果改成暴露对象，那么放大系数就是在代码里写死的，无法在命令行进行参数定制了。这就是暴露对象和暴露类的差别，似乎暴露类在功能上更强大一些。

暴露属性

上面的所有例子我们最终暴露的都是函数，要么是模块里的函数，要么是类里的函数。但实际上fire还可以暴露属性，比如我们可以将上面的coeff参数通过命令行进行输出。

> python maths.py coeff --coeff=2
2
> python maths.py coeff --coeff=3
3
复制代码

再来一个更加简单的例子

# example.py
import fire
english = 'Hello World'
spanish = 'Hola Mundo'
fire.Fire()
复制代码

运行

$ python example.py english
Hello World
$ python example.py spanish
Hola Mundo
复制代码

原理

命令行中的参数顺序和代码内部对象的树状层次结构呈现一一对应关系。如果fire不带参数暴露了当前的模块，那么第一个参数就应该是这个模块内部的函数名、类名或者是变量名。如果第一个参数是函数，那么接下来的参数就是函数的参数。如果第一个参数是类，那么接下来的参数可能是这个类实例内部的方法或者字段。如果第一个参数是变量名，后面没有参数的话，就直接显示这个变量。如果后面还有参数，那么就把这个变量看成一个对象，然后继续使用后续参数来深入解析这个对象。

在Python里面所有的变量都是对象，包括普通的整数、字符串、浮点数、布尔值等。理论上可以一直将对象结构递归下去，形成一个复杂的链式调用。

链式暴露

接下来我们验证这个理论，尝试一下复杂的链式暴露。

import fire


class Chain(object):

    def __init__(self):
        self.value = 1

    def incr(self):
        print "incr", self.value
        self.value += 1
        return self

    def decr(self):
        print "decr", self.value
        self.value -= 1
        return self

    def get(self):
        return self.value


if __name__ == '__main__':
    fire.Fire(Chain)
复制代码

运行一下

> python chains.py incr incr incr decr decr get
incr 1
incr 2
incr 3
decr 4
decr 3
2
复制代码

Cool! 我们通过在每个方法里面方法self对象自身来实现了漂亮的链式调用效果。

接下来我们尝试对内置字符串对象进行解构

# xyz.py
import fire

value = "hello"

if __name__ == '__main__':
    fire.Fire()
复制代码

字符串有upper和lower方法，我们反复使用upper和lower，然后观察结果

> python xyz.py value
hello
> python xyz.py value upper
HELLO
> python xyz.py value upper lower
Traceback (most recent call last):
  File "xyz.py", line 7, in <module>
    fire.Fire()
  File "/Users/pyloque/source/pys/.py/lib/python2.7/site-packages/fire/core.py", line 127, in Fire
    component_trace = _Fire(component, args, context, name)
  File "/Users/pyloque/source/pys/.py/lib/python2.7/site-packages/fire/core.py", line 366, in _Fire
    component, remaining_args)
  File "/Users/pyloque/source/pys/.py/lib/python2.7/site-packages/fire/core.py", line 542, in _CallCallable
    result = fn(*varargs, **kwargs)
TypeError: upper() takes no arguments (1 given)
复制代码

很不幸，内置的字符串对象似乎不支持链式调用，第一个upper倒是执行成功了。不过fire提供了一个特殊的符号用来解决这个问题。

> python xyz.py value upper - lower
hello
> python xyz.py value upper - lower - upper
HELLO
> python xyz.py value upper - lower - upper - lower
hello
复制代码

减号用来表示参数的结束，这样后续的参数就不会被当成函数的参数来映射了。

让redis-py秒变命令行

最后我们再来一个酷炫的小例子，把redis-py的StrictRedis暴露一下变身命令行

import fire
import redis


if __name__ == '__main__':
    fire.Fire(redis.StrictRedis)
复制代码

就这么简单，接下来就可以玩命令行了

>  python client.py flushdb
True
>  python client.py set codehole superhero
True
>  python client.py get codehole
superhero
>  python client.py exists codehole
True
>  python client.py keys "*"
codehole
>  python client.py delete codehole
1
# 指定地址
> python client.py set codehole superhero --host=127.0.0.1 --port=6379
True
复制代码

总结

有了Google Fire这样一个小巧的类库，我们就可以从复杂的命令行参数分析中解脱出来了。我们常说写代码要漂亮优雅，没有好的类库，这种理想也不是非常容易实现的。如果没有fire，你有本事试试把复杂的命令行参数解析代码写优雅了给老师我看看。

阅读更多高级文章，关注公众号「码洞」

George_Fal
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
两行代码，为 Python 脚本生成命令行
Python_xiaowu的博客
01-05 604
有时候我们会有这样的一个需求： 我们定义了一个 Python 的方法，方法接收一些参数，但是调用的时候想将这些参数用命令行暴露出来。 比如说这里有个爬取方法： import requests def scrape(url, timeout=10): response = requests.get(url, timeout=timeout) print(response.text) 这里定义了一个 scrape 方法，第一个参数接收 url，即爬取的网址，第二个参数接收 time
用什么库写 Python 命令行程序(示例代码详解)
12-20
fire 的设计理念是将 Python 函数直接映射到命令行参数，这使得函数可以直接作为命令行程序运行，极大简化了开发流程。然而，对于复杂的命令行配置，fire 可能不如其他库那么强大。 在选择命令行库时，需要考虑以下...
python工具是什么-使用Python编写命令行工具有什么好的库？
weixin_37988176的博客
11-01 328
使用Python编写命令行工具的库很多，我最推荐的还是Google FireHello World要介绍Fire是什么，看一个简单的例子就明白了# calc.pyimport fireclass Calculator(object):"""A simple calculator class."""def double(self, numb...
python学习过程中遇到问题汇总
caodaoxi的专栏
08-24 202
1.错误打印： Traceback (most recent call last): File "ReaderTest.py", line 6, in line = reader.readLine() TypeError: readLine() takes no arguments (1 given) 错误原因：自定义了一个函数，没有参数，但是self这个参数是要加...
Python技术相关的bottle框架自带服务器例子脚本提示takes no arguments 1 given 错误
babasu的专栏
11-19 9172
Python开发环境下安装了bottle框架，输入例子： from bottle import error, route, run @route('/hello') @error(404) def hello():     return 'hello world.' run(host='localhost', port=8082, debug=True, reloader=True)
Python-PythonFire一个用于从任何Python对象创建命令行界面CLI的库
08-10
总的来说，Python Fire 是一个强大的工具，它简化了Python CLI的开发过程，让开发者能够更专注于核心功能的实现，同时提供了一个统一且易于使用的命令行接口。无论你是初学者还是经验丰富的Python开发者，Python ...
Google 的用于生成命令行接口的工具 fire 的简单用法
04-22
**Google Fire：为Python程序构建命令行接口的利器** Google Fire是一个开源库，它使得创建命令行接口（CLI）对于Python开发者来说变得极其简单。这个工具的目的是让编写具有交互性的命令行应用变得轻而易举，无论...
PyPI 官网下载 | fire_python-0.41.tar.gz
01-31
通过`fire`，开发者可以轻松地将Python代码转换成易于使用的命令行程序，而无需编写额外的接口代码。这对于快速原型开发或者创建简单的CLI工具非常有用。 在`fire`库中，你可以定义一个Python函数，然后通过`fire....
python-cli
02-12
4. `fire`：Google开源的CLI库，可以将Python函数直接转换为命令行界面，简单易用。 四、Python CLI最佳实践 1. 提供--help选项：让用户能够轻松查看命令用法和选项。 2. 设计清晰的命令结构：避免过多的嵌套命令...
Python中报错提示：TypeError: Student() takes no arguments
热门推荐
xuantaiyang888的博客
07-13 6万+
Traceback (most recent call last): File "E:/learnpython/day06/15.py", line 20, in &lt;module&gt; tom = Student ("aaszsdf",'adfsgfd') TypeError: Student() takes no arguments 检查你的 def __...
TypeError: __init__() takes exactly 2 arguments (1 given)（已解决）
狐狸的懒窝
12-14 2万+
原因：在多个文件的引用过程中，本文件类无需新建对象。
17个新手常见Python运行时错误
qiuyepiaoling的专栏
07-31 1万+
原文地址：http://www.oschina.net/question/89964_62779    http://inventwithpython.com/blog/2012/07/09/16-common-python-runtime-errors/ 当初学 Python 时，想要弄懂 Python 的错误信息的含义可能有点复杂。这里列出了常见的的一些让你程序 crash 的运行
Python Fire试用体验
weixin_34209406的博客
05-24 122
之前用Python写过一些CLI的小工具，在CLI命令行传参处理上，一般都是用argparse，最近看到Google开源的Python Fire（2017-3-2就开源了）, 把argparse包装了，可以自动将代码转变成 CLI，开发者无需做任何额外工作。减少没有技术含量的代码量，减少低级Bug产生可能，节省了宝贵的吃鸡时间。这么有意义的库，那么肯定要...
Python3，3行代码，自动为脚本生成命令行，我默默的收藏了。
商务合作 | 面试培训 | 职场规划 ==>主页扫码
01-28 7090
fire模块，不需要修改代码，直接在执行脚本命令行，输入需要传入参数， 执行起来，非常方便。
sublime text 运行python时，控制台不显示结果
Crazy的博客
01-28 1万+
sublime text 运行python，ctrl+b，控制台不显示结果。 网上找解决方案。删除配置文件，卸载重装。 折腾半天，结果发现，是因为文件路径中包含中文 -_-|||...
Python新手错误自查
Alpha5的专栏
01-01 8627
Python新手常犯的错误 当初学 Python 时，想要弄懂 Python 的错误信息的含义可能有点复杂。这里列出了常见的的一些让你程序 crash 的运行时错误。 1）忘记在 if , elif , else , for , while , class ,def 声明末尾添加 ：（导致 “SyntaxError ：invalid syntax”） 该错误将发生在类似如
Python fire官方文档教学（自动生成命令行，个人觉得意义不大，不如argparse）
墨痕诉清风的博客
08-27 681
0x00 简介 欢迎来到Python Fire指南！ Python Fire是一个Python库，只需对Fire进行一次调用即可将任何Python组件转变为命令行界面。 让我们开始吧！ 0x01 安装 从pypi安装Python Fire，请运行： pip install fire 或者，从源代码安装Python Fire，请下载源代码并运行： python setup.py install 0x02 Hello World Version 1:fire.Fire() 使用Fi.
命令行工具 python
最新发布
08-06
3. Python Fire：Python Fire是谷歌开源的一个命令行工具，用于从任何Python对象自动生成命令行界面。它可以帮助开发和调试Python代码，并且可以将其他人的代码转换为命令行工具。 以上是一些常见的Python命令行...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值