Python--Click

Click

Click 是 Flask 的开发团队 Pallets 的另一款开源项目，它是用于快速创建命令行的第三方模块。

我们知道，Python 内置了一个 Argparse 的标准库用于创建命令行，但使用起来有些繁琐，Click 相比于 Argparse，就好比 requests 相比于 urllib。

Click 是一个第三方库，因此，在使用之前需要先安装：

pip install click

参考文档http://click.pocoo.org/6/options/

Click 对argparse 的主要改进在易用性，使用Click 分为两个步骤：

1. 使用 @click.command() 装饰一个函数，使之成为命令行接口；
2. 使用 @click.option() 等装饰函数，为其添加命令行选项等。

看一下官方文档的入门例子：

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()

 

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

 

• @click.command() 使函数 hello 成为命令行接口；

• @click.option 的第一个参数指定了命令行选项的名称，可以看到，count 的默认值是 1；

• 使用 click.echo 进行输出是为了获得更好的兼容性，因为 print 在 Python2 和 Python3 的用法有些差别。

 

执行情况

$ python hello.py
Your name: Ethan           # 这里会显示 'Your name: '(对应代码中的 prompt)，接受用户输入
Hello Ethan!
  
$ python hello.py --help   # click 帮我们自动生成了 `--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.
  
$ python hello.py --count 3 --name Ethan    # 指定 count 和 name 的值
Hello Ethan!
Hello Ethan!
Hello Ethan!
  
$ python hello.py --count=3 --name=Ethan    # 也可以使用 `=`，和上面等价
Hello Ethan!
Hello Ethan!
Hello Ethan!
  
$ python hello.py --name=Ethan              # 没有指定 count，默认值是 1
Hello Ethan!

 

Group使用

Click 通过 group 来创建一个命令行组，也就是说它可以有各种参数来解决相同类别的不同问题

import click

@click.group()
def cli():
    pass

@click.command()
def initdb():
    click.echo('Initialized the database')
····
@click.command()
def dropdb():
    click.echo('Droped the database')

cli.add_command(initdb)
cli.add_command(dropdb)

if __name__ == "__main__":
    cli()

执行情况

$ python hello.py
Usage: hello.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  dropdb
  initdb
$ python hello.py initdb
Initialized the database
$ python hello.py dropdb
Droped the database

 

 click.option使用

option 最基本的用法就是通过指定命令行选项的名称，从命令行读取参数值，再将其传递给函数。

在上面的例子，我们看到，除了设置命令行选项的名称，我们还会指定默认值，help 说明等，option 常用的设置参数如下：

 

• default: 设置命令行参数的默认值

• help: 参数说明

• type: 参数类型，可以是 string, int, float 等

• prompt: 当在命令行中没有输入相应的参数时，会根据 prompt 提示用户输入

• nargs: 指定命令行参数接收的值的个数

• metavar：如何在帮助页面表示值

 

下面，我们再看看相关的例子。

指定 type

我们可以使用 type 来指定参数类型：

import click
  
@click.command()
@click.option('--rate', type=float, help='rate')   # 指定 rate 是 float 类型
def show(rate):
    click.echo('rate: %s