前言
按照官方的介绍:Click 是一个利用很少的代码以可组合的方式创造优雅命令行工具接口的 Python 库。它是高度可配置的,但却有合理默认值的“命令行接口创建工具”。
它致力于将创建命令行工具的过程变的快速而有趣,免除你因无法实现一个 CLI API 的挫败感。
Click 的三个特性:
- 任意嵌套命令
- 自动生成帮助页面
- 支持在运行时延迟加载子命令
安装
使用 pip
安装
pip install -i https://pypi.douban.com/simple click
官方建议使用 virtualenv 环境来进行安装,不是本文介绍要点,故略过。
有兴趣可直接参考 click 文档进行学习配置。
快速上手
我们通过一个简单的例子来说明,新建 main.py 文件:
import click
@click.command()
@click.option('-n', '--name', type=click.STRING, help='input your name please', required=True)
def say_hello(name):
click.echo('hello {name}'.format(name=name))
if __name__ == '__main__':
say_hello()
函数 say_hello 通过装饰器 click.command()
变为一个命令行工具
而 click.option()
则是定义了参数 name 值的类型是 String 以及显示的提示 help
我们可以在终端中进行调试查看
python main.py --help
可以得到输出:
Usage: main.py [OPTIONS]
Options:
-n, --name TEXT input your name please [required]
--help Show this message and exit.
接着我们传入参数值调用
python main.py -n world
可以得到输出:
hello world
至此,我们通过一个 demo 已经简单地了解了 click 的使用方法