官网地址:Welcome to Click — Click Documentation (8.1.x)
函数说明
@click.command() 装饰器,使函数成为命令行接口。
@click.option() 装饰器,为其添加命令行选项。
click.option()参数说明
- default: 设置命令行参数的默认值
- help: 参数说明
- type: 参数类型,可以是 string, int, float 等
- prompt: 当在命令行中没有输入相应的参数时,会根据 prompt 提示用户输入
- nargs: 指定命令行参数接收的值的个数
- metavar:如何在帮助页面表示值
说明:如果没有指定type,则使用默认值的类型。如果没有提供默认值,则类型默认为字符串
基础示例
@click.command() @click.option('--n', default=1) def dots(n): click.echo('#' * n)
命令行输入:dots --n=2
输出如下内容
##
一个参数接收多个值
@click.command() @click.option('--pos', nargs=2, type=float) def findme(pos): click.echo('%s / %s' % pos)
命令行输入:findme --pos 2.0 3.0
输出如下内容
2.0 / 3.0
接收元组
@click.command() @click.option('--item', type=(str, int)) def putitem(item):