|
|
51CTO旗下网站
|
|
移步端
  • 用什么库写 Python 命令行程序?瞧这一篇就够了

    在近半年之 Python 命令行旅程中,咱们依次学习了 argparse、docopt、click 和 fire 库的性状和用法,逐步了解到 Python 命令行库的计划哲学与演变。

    笔者:HelloGitHub 来源:HelloGitHub| 2020-02-13 10:57

     一、前言

    在近半年之 Python 命令行旅程中,咱们依次学习了 argparse、docopt、click 和 fire 库的性状和用法,逐步了解到 Python 命令行库的计划哲学与演变。本文作为本次旅程的极端,瞩望从一个更高的见解对那些库进行双向对比,总结它们的异同点和利用场景,以期在回答不同景象时能够分析利弊,慎选适宜的库为己所用。

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

    二、计划理念

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

  • 命令行程序接受一个位置参数,他能出现多次,且是数字
  • 默认情况下,命令行程序会求出给定的一串数字的最大值
  • 如果指定了选项参数 --sum,这就是说就会将求出给定的一串数字的和
  • 瞩望从各级库实现该例子的编码中能进一步体会它们的计划理念。

    2.1、argparse

    argparse 的计划理念就是提供给你最细粒度的左右,你需要详细地报告他参数是选项参数还是位置参数、参数值的项目是什么、该参数的拍卖动作是怎样的。总而言之,他就像是一番没有智能分析能力的初代机器人,你需要告诉他鲜明的消息,他才会根据给定的消息去帮助你办事情。

    以下示例为 argparse 贯彻的 传感器程序:

          
    1. import argparse 
    2.  
    3. # 1. 安装解析器 
    4. parser = argparse.ArgumentParser(description='Calculator Program.'
    5.  
    6. # 2. 定义参数 
    7. # 补充位置参数 nums,在赞助信息中表现为 num 
    8. # 他类型为 int,且支持输入多个,且至少需要提供一个 
    9. parser.add_argument('nums',  metavar='num', type=int, nargs='+'
    10.                     help='a num for the accumulator'
    11. # 补充选项参数 --sum,该参数被 parser 剖析后所对应的习性名为 accumulate 
    12. # 若不提供 --sum,默认值为 max 函数,否则为 sum 函数 
    13. parser.add_argument('--sum', dest='accumulate'action='store_const'
    14.                     const=sumdefault=max
    15.                     help='sum the nums (default: find the max)'
    16.  
    17.  
    18. # 3. 剖析参数 
    19. args = parser.parse_args(['--sum''1''2''3']) 
    20. print(args) # 结果:Namespace(accumulate=<built-in function sum>, nums=[1, 2, 3]) 
    21.  
    22. # 4. 工作逻辑 
    23. result = args.accumulate(args.nums) 
    24. 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. # 1. 定义接口描述/赞助信息 
    2. """Calculator Program. 
    3.  
    4. Usage: 
    5.   calculator.py [--sum] <num>... 
    6.   calculator.py (-h | --help) 
    7.  
    8. Options: 
    9.   -h --help     Show help. 
    10.   --sum         Sum the nums (default: find the max). 
    11. ""
    12.  
    13. from docopt import docopt 
    14.  
    15. # 2. 剖析命令行 
    16. arguments = docopt(__doc__, options_first=True, argv=['--sum''1''2''3']) 
    17. print(arguments) # 结果:{'--help'False'--sum'True'<num>': ['1''2''3']} 
    18.  
    19. # 3. 工作逻辑 
    20. nums = (int(num) for num in arguments['<num>']) 
    21.  
    22. if arguments['--sum']: 
    23.     result = sum(nums) 
    24. else
    25.     result = max(nums) 
    26.  
    27. 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 贯彻的 传感器程序:

          
    1. import sys 
    2. import click 
    3.  
    4. sys.argv = ['calculator.py''--sum''1''2''3'
    5.  
    6. # 2. 定义参数 
    7. @click.command() 
    8. @click.argument('nums', nargs=-1, type=int
    9. @click.option('--sum''use_sum', is_flag=True, help='sum the nums (default: find the max)'
    10. # 1. 工作逻辑 
    11. def calculator(nums, use_sum): 
    12.     """Calculator Program.""" 
    13.     print(nums, use_sum) # 进出口:(1, 2, 3) True 
    14.     if use_sum: 
    15.         result = sum(nums) 
    16.     else
    17.         result = max(nums) 
    18.  
    19.     print(result) # 基于上文的 ['--sum''1''2''3'] 数,拍卖函数为 sum 函数,他结果为 6 
    20.  
    21. calculator() 

    副上述示例可以看到,数和回答的拍卖逻辑非常好地绑定在了共计,看上去就很直观,有效我们可以肯定了解参数会怎么处理,这在有恢宏指数时显得尤为关键,此处是 click 相比之下于 argparse 和 docopt 最引人注目的劣势。

    另外,click 还内置了众多实用工具和附加能力,比如说 Bash 补充全、颜色、成分页支持、速度条等很多实用功能,可谓是增长。

    2.4、firefire

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

    以下示例为 fire 贯彻的 传感器程序:

          
    1. import sys 
    2. import fire 
    3.  
    4. sys.argv = ['calculator.py''1''2''3''--sum'
    5.  
    6. builtin_sum = sum 
    7.  
    8. # 1. 工作逻辑 
    9. # sum=False,暗示它是一番摘取参数 --sum,不提供的时节为 False 
    10. # *nums 暗示它是一番能提供任意数量之岗位参数 
    11. def calculator(sum=False, *nums): 
    12.     """Calculator Program.""" 
    13.     print(sum, nums) # 进出口:True (1, 2, 3) 
    14.     if sum: 
    15.         result = builtin_sum(nums) 
    16.     else
    17.         result = max(nums) 
    18.  
    19.     print(result) # 基于上文的 ['1', '2', '3', '--sum'] 数,拍卖函数为 sum 函数,他结果为 6 
    20.  
    21.  
    22. fire.Fire(calculator) 

    副上述示例可以看到,fire 提供的措施无疑是最简单、并且最 Pythonic 的了。咱们只需关注业务逻辑,而命令行参数的概念则和函数参数的概念融为了一体。

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

    三、走向对比

    说到底,咱们横向对比下argparse、docopt、click 和 fire 库的各个职能和特色:

    Python 的指令行库种类繁多、匠心独运。重组方面的总结,可以选择出符合使用场景的库,如果几个库都符合,这就是说就根据你更偏爱的品格来选择。该署库都很出色,他背后的思维很是值得我们学习和壮大。

    【编纂推荐】

    1. 用Python做疫情数据分析,多维度解析传播率和动向,前途是乐观的
    2. 物联网和大数量完美搭配的15个更新应用
    3. 用大数量防疫要搞好个人隐私保护
    4. 内外端交互如何保证数据安全?
    5. 物联网产值竟能超过日本GDP?论物联网数据预测的各族面孔
    【义务编辑: 华轩 TEL:(010)68476606】

    点赞 0
  • Python  数量  计划
  • 分享:
    大家都在看
    猜你喜欢
  • 订阅专栏+更多

    Kubernetes:21远处完美通关

    Kubernetes:21远处完美通关

    从小白到修神
    共29章 | king584911644

    190人口订阅学习

    Python使用场景实战手册

    Python使用场景实战手册

    Python使用场景实战手册
    共3章 | KaliArch

    122人口订阅学习

    一步到位玩儿透Ansible

    一步到位玩儿透Ansible

    Ansible
    共17章 | 骏马金龙1

    209人口订阅学习

    订阅51CTO邮刊

    点击这里查看样刊

    订阅51CTO邮刊

    51CTO劳务号

    51CTO官微


  •