当前位置: 首页 » Python(人生苦短) » py_module » [python]Python命令行神器–Click

[python]Python命令行神器–Click

Click(https://github.com/pallets/click) 是用 Python 写的一个第三方模块,用于快速创建命令行。我们知道,Python 内置了一个 Argparse(https://docs.python.org/2/howto/argparse.html) 的标准库用于创建命令行,但使用起来有些繁琐,Click 相比于 Argparse,就好比 requests 相比于 urllib。

官网说明:http://click.pocoo.org/6/
一、用法

Click 的使用大致有两个步骤:
使用 @click.command()装饰一个函数,使之成为命令行接口;
使用 @click.option()等装饰函数,为其添加命令行选项等。

1.基本例子

它的一种典型使用形式如下:

下面,让我们看一下官方文档(http://click.pocoo.org/6/)的入门例子:

在上面的例子中,函数 hello 有两个参数:count 和 name,它们的值从命令行中获取。

@click.command() 使函数 hello 成为命令行接口;
@click.option 的第一个参数指定了命令行选项的名称,可以看到,count 的默认值是 1;
使用 click.echo 进行输出是为了获得更好的兼容性,因为 print在 Python2 和 Python3 的用法有些差别。

看看执行情况:

option 最基本的用法就是通过指定命令行选项的名称,从命令行读取参数值,再将其传递给函数。在上面的例子,我们看到,除了设置命令行选项的名称,我们还会指定默认值,help 说明等,option 常用的设置参数如下:

default: 设置命令行参数的默认值
help: 参数说明
type: 参数类型,可以是 string, int, float 等
prompt: 当在命令行中没有输入相应的参数时,会根据 prompt 提示用户输入
nargs: 指定命令行参数接收的值的个数
下面,我们再看看相关的例子。

2.使用 type 来指定参数类型:

执行情况:

3.可选值
在某些情况下,一个参数的值只能是某些可选的值,如果用户输入了其他值,我们应该提示用户输入正确的值。在这种情况下,我们可以通过 click.Choice() 来限定:

执行情况:

4.多值参数
有时,一个参数需要接收多个值。option 支持设置固定长度的参数值,通过 nargs指定。

4.补丁参数
argument 还有另外一种常见的用法,就是接收不定量的参数,让我们看看例子:

其中,nargs=-1 表明参数 src 接收不定量的参数值,参数值会以 tuple 的形式传入函数。如果 nargs 大于等于 1,表示接收nargs个参数值,上面的例子中,dst 接收一个参数值。
让我们看看执行情况:

5.输入密码
有时,在输入密码的时候,我们希望能隐藏显示。option 提供了两个参数来设置密码的输入:hide_input 和 confirmation_promt,其中,hide_input 用于隐藏输入,confirmation_promt 用于重复输入。
看看例子:

执行情况:

由于上面的写法有点繁琐,click 也提供了一种快捷的方式,通过使用@click.password_option(),上面的代码可以简写成:

6.改变命令行程序的执行
有些参数会改变命令行程序的执行,比如在终端输入 python 是进入 python 控制台,而输入 python –version 是打印 python 版本。Click 提供 eager 标识对参数名进行标识,如果输入该参数,则会拦截既定的命令行执行流程,跳转去执行一个回调函数。
让我们看看例子:

其中:

is_eager=True 表明该命令行选项优先级高于其他选项;
expose_value=False 表示如果没有输入该命令行选项,会执行既定的命令行流程;
callback 指定了输入该命令行选项时,要跳转执行的函数;
执行情况:

我们除了使用 @click.option 来添加可选参数,还会经常使用@click.argument 来添加固定参数。它的使用和 option 类似,但支持的功能比 option 少。

7.彩色输出
在前面的例子中,我们使用 click.echo 进行输出,如果配合 colorama 这个模块,我们可以使用 click.secho 进行彩色输出,在使用之前,使用 pip 安装 colorama:

看看例子:

fg 表示前景颜色(即字体颜色),可选值有:BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等;
bg表示背景颜色,可选值有:BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等;
underline 表示下划线,可选的样式还有:dim=True,bold=True等;

8.分级命令

 

报错:
UnicodeDecodeError: 'utf8' codec can't decode byte 0x9c
原因:help中有中文
解决办法:

参考资料:
http://blog.csdn.net/lihua_tan/article/details/54869355?utm_source=itdadao&utm_medium=referral#comments
http://stackoverflow.com/questions/12468179/unicodedecodeerror-utf8-codec-cant-decode-byte-0x9c


下一篇 :

上一篇 :

暂无评论

发表评论

电子邮件地址不会被公开。 必填项已用*标注

$(document).ready(function(){ $("#article-index").css('display','none');});