用什么库写 Python 命令行程序(示例代码详解)


Posted in Python onFebruary 20, 2020

一、前言

在近半年的 Python 命令行旅程中,我们依次学习了 argparse 、 docopt 、 click 和 fire 库的特点和用法,逐步了解到 Python 命令行库的设计哲学与演变。本文作为本次旅程的终点,希望从一个更高的视角对这些库进行横向对比,总结它们的异同点和使用场景,以期在应对不同场景时能够分析利弊,选择合适的库为己所用。

本系列文章默认使用 Python 3 作为解释器进行讲解。若你仍在使用 Python 2,请注意两者之间语法和库的使用差异哦~

二、设计理念

在讨论各个库的设计理念之前,我们先设计一个 计算器程序 ,其实这个例子在 argparse 库的第一篇讲解中出现过,也就是:

  1. 命令行程序接受一个位置参数,它能出现多次,且是数字
  2. 默认情况下,命令行程序会求出给定的一串数字的最大值
  3. 如果指定了选项参数 --sum ,那么就会将求出给定的一串数字的和

希望从各个库实现该例子的代码中能进一步体会它们的设计理念。

2.1、argparse

argparse 的设计理念就是提供给你最细粒度的控制,你需要详细地告诉它参数是选项参数还是位置参数、参数值的类型是什么、该参数的处理动作是怎样的。总之,它就像是一个没有智能分析能力的初代机器人,你需要告诉它明确的信息,它才会根据给定的信息去帮助你做事情。

以下示例为 argparse 实现的 计算器程序 :

import argparse
# 1. 设置解析器
parser = argparse.ArgumentParser(description='Calculator Program.')
# 2. 定义参数
# 添加位置参数 nums,在帮助信息中显示为 num
# 其类型为 int,且支持输入多个,且至少需要提供一个
parser.add_argument('nums', metavar='num', type=int, nargs='+',
   help='a num for the accumulator')
# 添加选项参数 --sum,该参数被 parser 解析后所对应的属性名为 accumulate
# 若不提供 --sum,默认值为 max 函数,否则为 sum 函数
parser.add_argument('--sum', dest='accumulate', action='store_const',
   const=sum, default=max,
   help='sum the nums (default: find the max)')
# 3. 解析参数
args = parser.parse_args(['--sum', '1', '2', '3'])
print(args) # 结果:Namespace(accumulate=<built-in function sum>, nums=[1, 2, 3])
# 4. 业务逻辑
result = args.accumulate(args.nums)
print(result) # 基于上文的 ['--sum', '1', '2', '3'] 参数,accumulate 为 sum 函数,其结果为 6

从上述示例可以看到,我们需要通过 add_argument 很明确地告诉 argparse 参数长什么样:

  • 它是位置参数 nums ,还是选项参数 --sum
  • 它的类型是什么,比如 type=int 表示类型是 int
  • 这个参数能重复出现几次,比如 nargs='+' 表示至少提供 1 个
  • 参数的是存什么的,比如 action='store_const' 表示存常量

然后它才根据给定的这些元信息来解析命令行参数(也就是示例中的 ['--sum', '1', '2', '3'] )。

这是很计算机的思维,虽然冗长,但也带来了灵活性。

2.2、docopt

从 argparse 的理念可以看出,它是命令式的。这时候 docopt 另辟蹊径,声明式是不是也可以?一个命令行程序的帮助信息其实已然包含了这个命令行的完整元信息,那不就可以通过定义帮助信息来定义命令行? docopt 就是基于这样的想法去设计的。

声明式的好处在于只要你掌握了声明式的语法,那么定义命令行的元信息就会很简单。

以下示例为 docopt 实现的 计算器程序 :

# 1. 定义接口描述/帮助信息
"""Calculator Program.
Usage:
 calculator.py [--sum] <num>...
 calculator.py (-h | --help)
Options:
 -h --help Show help.
 --sum  Sum the nums (default: find the max).
"""
from docopt import docopt
# 2. 解析命令行
arguments = docopt(__doc__, options_first=True, argv=['--sum', '1', '2', '3'])
print(arguments) # 结果:{'--help': False, '--sum': True, '<num>': ['1', '2', '3']}
# 3. 业务逻辑
nums = (int(num) for num in arguments['<num>'])
if arguments['--sum']:
 result = sum(nums)
else:
 result = max(nums)
print(result) # 基于上文的 ['--sum', '1', '2', '3'] 参数,处理函数为 sum 函数,其结果为 6

从上述示例可以看到,我们通过 __doc__ 定义了接口描述,这和 argparse 中 add_argument 是等价的,然后 docopt 便会根据这个元信息把命令行参数转换为一个字典。业务逻辑中就需要对这个字典进行处理。

对比与 argparse :

  • 对于更为复杂的命令程序,元信息的定义上 docopt 会更加简单
  • 然而在业务逻辑的处理上,由于 argparse 在一些简单参数的处理上会更加便捷(比如示例中的情形),相对来说 docopt 转换为字典后就把所有处理交给业务逻辑的方式会更加复杂

2.3、click

命令行程序本质上是定义参数和处理参数,而处理参数的逻辑一定是与所定义的参数有关联的。那可不可以用函数和装饰器来实现处理参数逻辑与定义参数的关联呢?而 click 正好就是以这种使用方式来设计的。

click 使用装饰器的好处就在于用装饰器优雅的语法将参数定义和处理逻辑整合在一起,从而暗示了路由关系。相比于 argparse 和 docopt 需要自行对解析后的参数来做路由关系,简单了不少。

以下示例为 click 实现的 计算器程序 :

import sys
import click
sys.argv = ['calculator.py', '--sum', '1', '2', '3']
# 2. 定义参数
@click.command()
@click.argument('nums', nargs=-1, type=int)
@click.option('--sum', 'use_sum', is_flag=True, help='sum the nums (default: find the max)')
# 1. 业务逻辑
def calculator(nums, use_sum):
 """Calculator Program."""
 print(nums, use_sum) # 输出:(1, 2, 3) True
 if use_sum:
 result = sum(nums)
 else:
 result = max(nums)
 print(result) # 基于上文的 ['--sum', '1', '2', '3'] 参数,处理函数为 sum 函数,其结果为 6
calculator()

从上述示例可以看出,参数和对应的处理逻辑非常好地绑定在了一起,看上去就很直观,使得我们可以明确了解参数会怎么处理,这在有大量参数时显得尤为重要,这边是 click 相比于 argparse 和 docopt 最明显的优势。

此外, click 还内置了很多实用工具和额外能力,比如说 Bash 补全、颜色、分页支持、进度条等诸多实用功能,可谓是如虎添翼。

2.4、fire

fire 则是用一种面向广义对象的方式来玩转命令行,这种对象可以是类、函数、字典、列表等,它更加灵活,也更加简单。你都不需要定义参数类型, fire 会根据输入和参数默认值来自动判断,这无疑进一步简化了实现过程。

以下示例为 fire 实现的 计算器程序 :

import sys
import fire
sys.argv = ['calculator.py', '1', '2', '3', '--sum']
builtin_sum = sum
# 1. 业务逻辑
# sum=False,暗示它是一个选项参数 --sum,不提供的时候为 False
# *nums 暗示它是一个能提供任意数量的位置参数
def calculator(sum=False, *nums):
 """Calculator Program."""
 print(sum, nums) # 输出:True (1, 2, 3)
 if sum:
 result = builtin_sum(nums)
 else:
 result = max(nums)
 print(result) # 基于上文的 ['1', '2', '3', '--sum'] 参数,处理函数为 sum 函数,其结果为 6
fire.Fire(calculator)

从上述示例可以看出, fire 提供的方式无疑是最简单、并且最 Pythonic 的了。我们只需关注业务逻辑,而命令行参数的定义则和函数参数的定义融为了一体。

不过,有利自然也有弊,比如 nums 并没有说是什么类型,也就意味着输入字符串'abc'也是合法的,这就意味着一个严格的命令行程序必须在自己的业务逻辑中来对期望的类型进行约束。

三、横向对比

最后,我们横向对比下 argparse 、 docopt 、 click 和 fire 库的各项功能和特点:

用什么库写 Python 命令行程序(示例代码详解)

Python 的命令行库种类繁多、各具特色。结合上面的总结,可以选择出符合使用场景的库,如果几个库都符合,那么就根据你更偏爱的风格来选择。这些库都很优秀,其背后的思想很是值得我们学习和扩展。

总结

以上所述是小编给大家介绍的用什么库写 Python 命令行程序,希望对大家有所帮助,也非常感谢大家对三水点靠木网站的支持!

Python 相关文章推荐
python实现360的字符显示界面
Feb 21 Python
Python作用域用法实例详解
Mar 15 Python
详解Django+Uwsgi+Nginx的生产环境部署
Jun 25 Python
python中csv文件的若干读写方法小结
Jul 04 Python
python与字符编码问题
May 24 Python
详解Django admin高级用法
Nov 06 Python
Django对接支付宝实现支付宝充值金币功能示例
Dec 17 Python
python关闭占用端口方式
Dec 17 Python
python 利用已有Ner模型进行数据清洗合并代码
Dec 24 Python
python利用线程实现多任务
Sep 18 Python
Python Django ORM连表正反操作技巧
Jun 13 Python
Golang Web 框架Iris安装部署
Aug 14 Python
在 Linux/Mac 下为Python函数添加超时时间的方法
Feb 20 #Python
Python os模块常用方法和属性总结
Feb 20 #Python
Python requests获取网页常用方法解析
Feb 20 #Python
pytorch实现保证每次运行使用的随机数都相同
Feb 20 #Python
Python argparse模块使用方法解析
Feb 20 #Python
浅谈pytorch torch.backends.cudnn设置作用
Feb 20 #Python
Python sqlite3查询操作过程解析
Feb 20 #Python
You might like
PHP简单系统查询模块代码打包下载
2008/06/07 PHP
php入门学习知识点六 PHP文件的读写操作代码
2011/07/14 PHP
php数组转成json格式的方法
2015/03/09 PHP
php使用ftp实现文件上传与下载功能
2017/07/21 PHP
redis+php实现微博(三)微博列表功能详解
2019/09/23 PHP
javascript 按回车键相应按钮提交事件
2009/11/02 Javascript
JS this作用域以及GET传输值过长的问题解决方法
2013/08/06 Javascript
jquery的总体架构分析及实现示例详解
2014/11/08 Javascript
JavaScript获取当前网页最后修改时间的方法
2015/04/03 Javascript
深入剖析JavaScript编程中的对象概念
2015/10/21 Javascript
基于canvas实现的钟摆效果完整实例
2016/01/26 Javascript
修改jquery中dialog的title属性方法(推荐)
2016/08/26 Javascript
JS实现可编辑的后台管理菜单功能【附demo源码下载】
2016/09/13 Javascript
用最简单的方法判断JavaScript中this的指向(推荐)
2017/09/04 Javascript
JS库之wow.js使用方法
2017/09/14 Javascript
微信小程序动态生成二维码的实现代码
2018/07/25 Javascript
react在安卓中输入框被手机键盘遮挡问题的解决方法
2018/09/03 Javascript
vue2中使用sass并配置全局的sass样式变量的方法
2018/09/04 Javascript
javascript实现文本框标签验证的实例代码
2018/10/14 Javascript
微信小程序开发搜索功能实现(前端+后端+数据库)
2020/03/04 Javascript
浅谈vue中document.getElementById()拿到的是原值的问题
2020/07/26 Javascript
使用Python的Flask框架表单插件Flask-WTF实现Web登录验证
2016/07/12 Python
NumPy 基本切片和索引的具体使用方法
2019/04/24 Python
Django 对象关系映射(ORM)源码详解
2019/08/06 Python
jupyter lab文件导出/下载方式
2020/04/22 Python
纯css3实现思维导图样式示例
2018/11/01 HTML / CSS
app内嵌H5 webview 本地缓存问题的解决
2020/10/19 HTML / CSS
如何使用canvas绘制可移动网格的示例代码
2020/12/14 HTML / CSS
初中三好学生自我鉴定
2014/04/07 职场文书
助人为乐好少年事迹材料
2014/08/18 职场文书
学校交通安全责任书
2014/08/25 职场文书
业绩倒数第一的检讨书
2014/09/24 职场文书
文员转正自我鉴定怎么写
2014/09/29 职场文书
2016北大自主招生自荐信模板
2016/01/28 职场文书
javaScript Array api梳理
2021/03/31 Javascript
如何创建一个创建MySQL数据库中的datetime类型
2022/03/21 MySQL