大家都说好用的Python命令行库click的使用


Posted in Python onNovember 07, 2019

一、前言

在本系列前面几篇文章中,我们分别介绍了 argparse 和 docopt 的主要功能和用法。它们各具特色,都能出色地完成命令行任务。argparse 是面向过程的,需要先设置解析器,再定义参数,再解析命令行,最后实现业务逻辑。而 docopt 先用声明式的语法定义出参数,再过程式地解析命令行和实现业务逻辑。在一些人看来,这些方式都不够优雅。

而今天要介绍的 click[2] 则是用一种你很熟知的方式来玩转命令行。命令行程序本质上是定义参数和处理参数,而处理参数的逻辑一定是与所定义的参数有关联的。那可不可以用函数和装饰器来实现处理参数逻辑与定义参数的关联呢?而 click 正好就是以这种方式来使用的。

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

二、介绍click

是一个以尽可能少的代码、以组合的方式创建优美的命令行程序的 Python 包。它有很高的可配置性,同时也能开箱即用。

它旨在让编写命令行工具的过程既快速又有趣,还能防止由于无法实现预期的 CLI API 所产生挫败感。它有如下三个特点:

  • 任意嵌套命令
  • 自动生成帮助
  • 支持运行时延迟加载子命令

三、快速开始

3.1 业务逻辑

首先定义业务逻辑,是不是感觉到有些难以置信呢?

不论是 argparse 还是 docopt,业务逻辑都是被放在最后一步,但 click 却是放在第一步。细想想 click 的这种方式才更符合人的思维吧?不论用什么命令行框架,我们最终关心的就是实现业务逻辑,其它的能省则省。

我们以官方示例为例,来介绍 click 的用法和哲学。假设命令行程序的输入是 name 和 count,功能是打印指定次数的名字。

那么在 hello.py 中,很容易写出如下代码:

def hello(count, name): 
  """Simple program that greets NAME for a total of COUNT times.""" 
  for x in range(count): 
    click.echo('Hello %s!' % name)

这段代码的逻辑很简单,就是循环 count 次,使用 click.echo 打印 name。其中,click.echo 和 print 的作用相似,但功能更加强大,能处理好 Unicode 和 二进制数据的情况。

3.2 定义参数

很显然,我们需要针对 count 和 name 来定义它们所对应的参数信息。

  • count 对应为命令行选项 --count,类型为数字,我们希望在不提供参数时,其默认值是 1
  • name 对应为命令行选项 --name,类型为字符串,我们希望在不提供参数时,能给人提示

使用 click,就可以写成下面这样:

from click import click 
 
@click.command() 
@click.option('--count', default=1, help='Number of greetings.') 
@click.option('--name', prompt='Your name', 
       help='The person to greet.') 
def hello(count, name): 
  ...

在上面的示例中:

  1. 使用装饰器的方式,即定义了参数,又将之与处理逻辑绑定,这真是优雅。和 argparse、docopt 比起来,就少了一步绑定过程
  2. 使用 click.command 表示 hello 是对命令的处理
  3. 使用 click.option 来定义参数选项
    1. 对于 --count 来说,使用 default 来指定默认值。而由于默认值是数字,进而暗示 --count 选项的类型为数字
    2. 对于 --name 来说,使用 prompt 来指定未输入该选项时的提示语
    3. 使用 help 来指定帮助信息

不论是装饰器的方式、还是各种默认行为,click 都是像它的介绍所说的那样,让人尽可能少地编写代码,让整个过程变得快速而有趣。

3.3 代码梳理

使用 click 的方式非常简单,我们将上文的代码汇总下,以有一个更清晰的认识:

# hello.py 
import click 
 
@click.command() 
@click.option('--count', default=1, help='Number of greetings.') 
@click.option('--name', prompt='Your name', 
       help='The person to greet.') 
def hello(count, name): 
  """Simple program that greets NAME for a total of COUNT times.""" 
  for x in range(count): 
    click.echo('Hello %s!' % name) 
 
if __name__ == '__main__': 
  hello()

若我们指定次数和名字:

$ python3 hello.py --count 2 --name Eric 
Hello Eric! 
Hello Eric!

若我们什么都不指定,则会提示输入名字,并默认输出一次:

$ python3 hello.py 
Your name: Eric 
Hello Eric!

我们还可以通过 --help 参数查看自动生成的帮助信息:

Usage: hello.py [OPTIONS] 
 
 Simple program that greets NAME for a total of COUNT times. 
 
Options: 
 --count INTEGER Number of greetings. 
 --name TEXT   The person to greet. 
 --help      Show this message and exit.

四、小结

click 的思路非常简单,定义处理函数,通过它的装饰器来定义参数。使用装饰器的绝妙之处就在于把定义和绑定这两个步骤合为一个步骤,使得整个过程变得如丝般顺滑。

click 除了以 Pythonic 的方式让命令行程序的实现变得更加优雅和好用外,还提供了比 argparse 和 docopt 都要强大的功能。在接下来几节中,我们将会逐步揭开它的面纱。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
python实现从web抓取文档的方法
Sep 26 Python
python中sets模块的用法实例
Sep 30 Python
python实现报表自动化详解
Nov 16 Python
Python中摘要算法MD5,SHA1简介及应用实例代码
Jan 09 Python
人生苦短我用python python如何快速入门?
Mar 12 Python
对Python2与Python3中__bool__方法的差异详解
Nov 01 Python
Python中按值来获取指定的键
Mar 04 Python
Python3实现二叉树的最大深度
Sep 30 Python
Python中sorted()排序与字母大小写的问题
Jan 14 Python
python3 实现口罩抽签的功能
Mar 11 Python
导致python中import错误的原因是什么
Jul 01 Python
django如何自定义manage.py管理命令
Apr 27 Python
flask 实现token机制的示例代码
Nov 07 #Python
python3反转字符串的3种方法(小结)
Nov 07 #Python
Python中__repr__和__str__区别详解
Nov 07 #Python
Python通过Manager方式实现多个无关联进程共享数据的实现
Nov 07 #Python
Python上下文管理器类和上下文管理器装饰器contextmanager用法实例分析
Nov 07 #Python
Python中xml和dict格式转换的示例代码
Nov 07 #Python
python对象转字典的两种实现方式示例
Nov 07 #Python
You might like
用php实现选择排序的解决方法
2013/05/04 PHP
PHP入门经历和学习过程分享
2014/04/11 PHP
PHP中spl_autoload_register()和__autoload()区别分析
2014/05/10 PHP
php使用CURL伪造IP和来源实例详解
2015/01/15 PHP
PHP正则表达式笔记与实例详解
2019/05/09 PHP
js不能获取隐藏的div的宽度只能先显示后获取
2014/09/04 Javascript
ANGULARJS中用NG-BIND指令实现单向绑定的例子
2014/12/08 Javascript
javascript中数组的定义及使用实例
2015/01/21 Javascript
常用DOM整理
2015/06/16 Javascript
深入解读JavaScript中的Iterator和for-of循环
2015/07/28 Javascript
浅谈javascript中的constructor
2016/06/08 Javascript
bootstrap提示标签、提示框实现代码
2016/12/28 Javascript
简单实现js倒计时功能
2017/02/13 Javascript
JavaScript通过filereader接口读取文件
2017/05/10 Javascript
vue 父组件调用子组件方法及事件
2018/03/29 Javascript
es6数据变更同步到视图层的方法
2019/03/04 Javascript
vue实现可视化可拖放的自定义表单的示例代码
2019/03/20 Javascript
原生javascript运动函数的封装示例【匀速、抛物线、多属性的运动等】
2020/02/23 Javascript
Vue+Vuex实现自动登录的知识点详解
2020/03/04 Javascript
JS实现页面鼠标点击出现图片特效
2020/08/19 Javascript
Python 字典(Dictionary)操作详解
2014/03/11 Python
Python中的列表知识点汇总
2015/04/14 Python
Python爬虫利用cookie实现模拟登陆实例详解
2017/01/12 Python
Python调用C# Com dll组件实战教程
2017/10/12 Python
django中的setting最佳配置小结
2017/11/21 Python
Python3编码问题 Unicode utf-8 bytes互转方法
2018/10/26 Python
解决python3 HTMLTestRunner测试报告中文乱码的问题
2018/12/17 Python
python mac下安装虚拟环境的图文教程
2019/04/12 Python
python如何解析配置文件并应用到项目中
2019/06/27 Python
Django项目使用ckeditor详解(不使用admin)
2019/12/17 Python
Python操作Word批量生成合同的实现示例
2020/08/28 Python
六十大寿答谢词
2014/01/12 职场文书
大四学生找工作的自荐信
2014/03/27 职场文书
植树造林的宣传标语
2014/06/23 职场文书
重温经典:乔布斯在斯坦福大学的毕业演讲(双语)
2019/08/26 职场文书
Golang 语言控制并发 Goroutine的方法
2021/06/30 Golang