python命令行参数之click和argument

Click

        Click 是 Flask 的开发团队 Pallets 的另一款开源项目，它是用于快速创建命令行的第三方模块。
        我们知道，Python 内置了一个 Argparse 的标准库用于创建命令行，但使用起来有些繁琐，Click 相比于 Argparse，就好比 requests 相比于 urllib。
        Click 是一个第三方库，因此，在使用之前需要先安装：

pip install click

参考文档 Click 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.options的使用

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' % rate)
  
if __name__ == '__main__':
    show()

执行情况：

$ python click_type.py --help
Usage: click_type.py [OPTIONS]

Options:
  --rate FLOAT  rate
  --help        Show this message and exit.

$ python click_type.py --rate 1
rate: 1.0
$ python click_type.py --rate 0.66
rate: 0.66

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

$ python click_choice.py  --help
Usage: click_choice.py [OPTIONS]

Options:
  --gender [man|woman]
  --help                Show this message and exit.

$ python click_choice.py --gender boy
Usage: click_choice.py [OPTIONS]
  
Error: Invalid value for "--gender": invalid choice: boy. (choose from man, woman)
  
$ python click_choice.py --gender man
gender: man

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

$ python click_multi_values.py --help
Usage: click_multi_values.py [OPTIONS]

Options:
  --center FLOAT...  center of the circle
  --radius FLOAT     radius of the circle


$ python click_multi_values.py --center 3 4 --radius 10
center: (3.0, 4.0), radius: 10.0
  
$ python click_multi_values.py --center 3 4 5 --radius 10
Usage: click_multi_values.py [OPTIONS]
  
Error: Got unexpected extra argument (5)

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

import click
  
@click.command()
@click.option('--password', prompt=True, hide_input=True, confirmation_prompt=True)
def input_password(password):
    click.echo('password: %s' % password)
  
  
if __name__ == '__main__':
    input_password()

执行情况：

$ python click_password.py
Password:                         # 不会显示密码
Repeat for confirmation:          # 重复一遍
password: 123

click 也提供了一种快捷的方式，通过使用 @click.password_option()，上面的代码可以简写成：

import click
  
@click.command()
@click.password_option()
def input_password(password):
    click.echo('password: %s' % password)
  
if __name__ == '__main__':
    input_password()

click.IntRange()

@click.command()
@click.option('--count', type=click.IntRange(0, 20, clamp=True))
@click.option('--digit', type=click.IntRange(0, 10))
def repeat(count, digit):
    click.echo(str(digit) * count)

if __name__ == '__main__':
    repeat()

执行情况：

$ repeat --count=1000 --digit=5
55555555555555555555
$ repeat --count=1000 --digit=12
Usage: repeat [OPTIONS]

Error: Invalid value for "--digit": 12 is not in the valid range of 0 to 10.

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

import click
def print_version(ctx, param, value):
    if not value or ctx.resilient_parsing:
        return
    click.echo('Version 1.0')
    ctx.exit()
@click.command()
@click.option('--version', is_flag=True, callback=print_version,
              expose_value=False, is_eager=True)
@click.option('--name', default='Ethan', help='name')
def hello(name):
    click.echo('Hello %s!' % name)
if __name__ == '__main__':
    hello()

其中：

• is_eager=True 表明该命令行选项优先级高于其他选项；
• expose_value=False 表示如果没有输入该命令行选项，会执行既定的命令行流程；
• callback 指定了输入该命令行选项时，要跳转执行的函数
• is_flag=True 表明参数值可以省略

执行情况：

$ python click_eager.py
Hello Ethan!
$ python click_eager.py --version  # 拦截既定的命令行执行流程
Version 1.0
$ python click_eager.py --name Michael
Hello Michael!
$ python click_eager.py --version --name Ethan  # 忽略 name 选项
Version 1.0