全文拷贝自 命令行神器 Click 简明笔记
Click
Click 是用 Python 写的一个第三方模块,用于快速创建命令行。我们知道,Python 内置了一个 Argparse 的标准库用于创建命令行,但使用起来有些繁琐,Click 相比于 Argparse,就好比 requests 相比于 urllib。
快速使用
Click 的使用大致有两个步骤:
- 使用 @click.command() 装饰一个函数,使之成为命令行接口;
- 使用 @click.option() 等装饰函数,为其添加命令行选项等。
它的一种典型使用形式如下:
import click
@click.command()
@click.option('--param', default=default_value, help='description')
def func(param):
pass
下面,让我们看一下官方文档的入门例子:
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!