大家都说好用的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爬取Coursera课程资源的详细过程
Nov 04 Python
python简单的函数定义和用法实例
May 07 Python
Python求算数平方根和约数的方法汇总
Mar 09 Python
python实现决策树、随机森林的简单原理
Mar 26 Python
python实现log日志的示例代码
Apr 28 Python
Tensorflow使用支持向量机拟合线性回归
Sep 07 Python
Python global全局变量函数详解
Sep 18 Python
在Python中分别打印列表中的每一个元素方法
Nov 07 Python
使用python打印十行杨辉三角过程详解
Jul 10 Python
python中 * 的用法详解
Jul 10 Python
Django框架视图函数设计示例
Jul 29 Python
使用coverage统计python web项目代码覆盖率的方法详解
Aug 05 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
整理的9个实用的PHP库简介和下载
2010/11/09 PHP
php中在PDO中使用事务(Transaction)
2011/05/14 PHP
PHP导出MySQL数据到Excel文件(fputcsv)
2011/07/03 PHP
PHP得到某段时间区间的时间戳 php定时任务
2012/04/12 PHP
ThinkPHP开发框架函数详解:C方法
2015/08/14 PHP
使用PHP实现下载CSS文件中的图片
2015/12/06 PHP
php使用strip_tags()去除html标签仍有空白的解决方法
2016/07/28 PHP
php设计模式之备忘模式分析【星际争霸游戏案例】
2020/03/24 PHP
基于jquery实现图片广告轮换效果代码
2011/07/07 Javascript
JS实现简单的二维矩阵乘积运算
2016/01/26 Javascript
jQuery简单实现彩色云标签效果示例
2016/08/01 Javascript
AngularJS 作用域详解及示例代码
2016/08/17 Javascript
vue-cli如何快速构建vue项目
2017/04/26 Javascript
微信小程序中吸底按钮适配iPhone X方案
2017/11/29 Javascript
vue.js根据代码运行环境选择baseurl的方法
2018/02/28 Javascript
详解如何构建一个Angular6的第三方npm包
2018/09/07 Javascript
微信小程序自定义组件实现环形进度条
2020/11/17 Javascript
iview的table组件自带的过滤器实现
2019/07/12 Javascript
JS猜数字游戏实例讲解
2020/06/30 Javascript
Vue页面手动刷新,实现导航栏激活项还原到初始状态
2020/08/06 Javascript
vue项目中js-cookie的使用存储token操作
2020/11/13 Javascript
[36:02]DOTA2上海特级锦标赛D组小组赛#2 Liquid VS VP第一局
2016/02/28 DOTA
Python中的字符串类型基本知识学习教程
2016/02/04 Python
Python实现简单多线程任务队列
2016/02/27 Python
python中numpy基础学习及进行数组和矢量计算
2017/02/12 Python
视觉直观感受若干常用排序算法
2017/04/13 Python
python实现简易通讯录修改版
2018/03/13 Python
python实现抖音点赞功能
2019/04/07 Python
用C#语言写出与SQLSERVER访问时的具体过程
2013/04/16 面试题
促销活动总结
2014/04/28 职场文书
舞蹈教育学专业自荐信
2014/06/15 职场文书
总经理岗位职责
2015/02/04 职场文书
公司清洁工岗位职责
2015/04/15 职场文书
工作年限证明范本
2015/06/15 职场文书
java设计模式--三种工厂模式详解
2021/07/21 Java/Android
Golang 遍历二叉树
2022/04/19 Golang