Python 命令行(五)- click 库

一. 认识 Click 库

连载关于命令行系列文章,我们提到了 Python 标准库模块 argparse 可用于解析命令行参数~ 但由于 argparse 使用复杂,add_argument 方法参数众多。为此,第三方库模块 click 应运而生,极大地改善了 argparse 的易用性。

注:Click 第三方库由 Flask 的作者 Armin Ronacher 开发。Click 相较于 argparse 较好比 requests 相较于 urllib

使用 click 之前,需要先进行安装:

pip install click

Click 模块构建 Python 命令行,分以下 2 步走:

  • 使用 @click.command() 装饰器,使被装饰的函数成为命令行接口;
  • 使用 @click.option() 等装饰器,添加命令行选项。

下面是一个简单的示例:

import click

@click.command()
@click.option('--count', default=1, help='Number of grettings.')
@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()

函数 hello 接受两个参数 countname ,分别从命令行中读取值。程序中用到了 click 模块的 command option 以及 echo ,它们的作用如下:

  • command 使得函数 hello 作为命令行接口;
  • option 添加命令行选项;
  • click.echo 主要是从兼容性考虑:Python2 的 print 是语句,而 Python3 中则为函数。

运行结果:

由于我们刚刚在添加 name 参数时,指定了 prompt='Your name' ,因此当执行命令行时,如果没有指定 --nameClick 将提示用户在交互模式下输入。--count 参数在定义时,我们指定了默认值 default=1

此外,和 argparse 一样,click 也会自动为我们生成好帮助信息:

二. 添加参数的详细用法

Click 库提供的装饰器 @click.option 通过指定命令行选项的名称,从命令行读取参数值,再将其传递给函数。其中,option 常用的设置参数如下:

  • default 设置命令行参数的默认值;
  • help 参数说明;
  • type 指定参数类型,如 string int float
  • prompt 当命令行未指定相应参数时,会根据 prompt 提示用户输入;
  • nargs 指定命令行参数接受的值的个数。

示例 1 标准库的 argparse 可以通过 nargs 配置参数的个数,通过 type 设置参数的数据类型。在 click 中也可以实现:

import click

@click.command()
@click.option('--pos', nargs=2, type=float)
def example(pos):
    click.echo('pos={}'.format(pos))

if __name__ == '__main__':
    example()

运行结果:

上述的例子中,程序会自动将参数转换为浮点数,并且以元组的形式赋值给变量 pos

示例 2 对于枚举类型的命令行参数,可以指定 typeclick.Choice 实例。Choice 的参数是一个列表,改列表列出所有可能的值。

import click

@click.command()
@click.option('--subject', type=click.Choice(['math','chinese','english']))
def score(subject):
    click.echo('{} score: 100'.format(subject))

if __name__ == '__main__':
    score()

运行结果:

示例 3 交互式地输入密码

argparse 模块中,输入密码只能像普通参数一样设置,这将带来一定的安全隐患:使用 history 就可以轻易获取到我们的密码。

click 中,上述问题得到了非常优美的解决:只需要设置 prompt=True ,就能够交互式地输入密码;设置 hide_input=True 即可隐藏我们的命令行输入;设置 confirmation_prompt=True 就可以进行密码的两次验证。

import click
from werkzeug.security import generate_password_hash

@click.command()
@click.option('--password', prompt=True, hide_input=True, confirmation_prompt=True)
def encrypt(password):
    click.echo('Encrypting password to %s' % generate_password_hash(password))

if __name__ == '__main__':
    encrypt()

运行结果:

示例 5 在编辑器中编辑输入的数据

熟悉 Linux 系统的用户,很可能使用过命令 fc,在编辑长命令时非常便捷。输入 fc 命令并回车会打开一个编辑器,改编辑器已经保存了上一条命令的内容。我们只需要在编辑器中修复错误内容,然后保存并退出,刚才编辑的命令将会自动执行。

使用 Click 库,在 Python 中也能实现类似的功能:

from __future__ import print_function
import click
import os

message = click.edit()
print(message)
print(os.system(message))

运行代码,程序将自动进入默认编辑器。进入编辑器之后,就可以在编辑器中编辑输入的数据,输入的内容将被赋值给程序中的变量 message

注:Click 是一个非常优秀的开源项目,更多详细用法,可以参见 Click 官网:https://click.palletsprojects.com/en/8.0.x/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352

推荐阅读更多精彩内容