Click[Click][0] 是 [Flask][1] 的开发团队 [Pallets][2] 的另一款开源项目它是用于快速创建命令行的第三方模块。我们知道Python 内置了一个 [Argparse][3] 的标准库用于创建命令行但使用起来有些繁琐[Click][0] 相比于 [Argparse][3]就好比 [requests][4] 相比于 [urllib][5]。快速使用Click 的使用大致有两个步骤使用click.command()装饰一个函数使之成为命令行接口使用click.option()等装饰函数为其添加命令行选项等。它的一种典型使用形式如下importclickclick.command()click.option(--param,defaultdefault_value,helpdescription)deffunc(param):pass下面让我们看一下[官方文档][6]的入门例子importclickclick.command()click.option(--count,default1,helpNumber of greetings.)click.option(--name,promptYour name,helpThe person to greet.)defhello(count,name):Simple program that greets NAME for a total of COUNT times.forxinrange(count):click.echo(Hello %s!%name)if__name____main__:hello()在上面的例子中函数hello有两个参数count 和 name它们的值从命令行中获取。click.command()使函数hello成为命令行接口click.option的第一个参数指定了命令行选项的名称不难猜到count 的默认值是 1name 的值从输入获取使用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 --count3 --nameEthan # 也可以使用 和上面等价 Hello Ethan! Hello Ethan! Hello Ethan! $ python hello.py --nameEthan # 没有指定 count默认值是 1 Hello Ethan!click.optionoption 最基本的用法就是通过指定命令行选项的名称从命令行读取参数值再将其传递给函数。在上面的例子我们看到除了设置命令行选项的名称我们还会指定默认值help 说明等option 常用的设置参数如下default: 设置命令行参数的默认值help: 参数说明type: 参数类型可以是 string, int, float 等prompt: 当在命令行中没有输入相应的参数时会根据 prompt 提示用户输入nargs: 指定命令行参数接收的值的个数下面我们再看看相关的例子。指定 type我们可以使用type来指定参数类型importclickclick.command()click.option(--rate,typefloat,helprate)# 指定 rate 是 float 类型defshow(rate):click.echo(rate: %s%rate)if__name____main__:show()执行情况$ python click_type.py --rate 1 rate: 1.0 $ python click_type.py --rate 0.66 rate: 0.66可选值在某些情况下一个参数的值只能是某些可选的值如果用户输入了其他值我们应该提示用户输入正确的值。在这种情况下我们可以通过click.Choice()来限定importclickclick.command()click.option(--gender,typeclick.Choice([man,woman]))# 限定值defchoose(gender):click.echo(gender: %s%gender)if__name____main__:choose()执行情况$ 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指定。看看例子就明白了importclickclick.command()click.option(--center,nargs2,typefloat,helpcenter of the circle)click.option(--radius,typefloat,helpradius of the circle)defcircle(center,radius):click.echo(center: %s, radius: %s%(center,radius))if__name____main__:circle()在上面的例子中option 指定了两个参数center 和 radius其中center 表示二维平面上一个圆的圆心坐标接收两个值以元组的形式将值传递给函数而 radius 表示圆的半径。执行情况$ 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 用于重复输入。看看例子importclickclick.command()click.option(--password,promptTrue,hide_inputTrue,confirmation_promptTrue)definput_password(password):click.echo(password: %s%password)if__name____main__:input_password()执行情况$ python click_password.py Password: # 不会显示密码 Repeat for confirmation: # 重复一遍 password: 666666由于上面的写法有点繁琐click 也提供了一种快捷的方式通过使用click.password_option()上面的代码可以简写成importclickclick.command()click.password_option()definput_password(password):click.echo(password: %s%password)if__name____main__:input_password()改变命令行程序的执行有些参数会改变命令行程序的执行比如在终端输入python是进入 python 控制台而输入python --version是打印 python 版本。Click 提供 eager 标识对参数名进行标识如果输入该参数则会拦截既定的命令行执行流程跳转去执行一个回调函数。让我们看看例子importclickdefprint_version(ctx,param,value):ifnotvalueorctx.resilient_parsing:returnclick.echo(Version 1.0)ctx.exit()click.command()click.option(--version,is_flagTrue,callbackprint_version,expose_valueFalse,is_eagerTrue)click.option(--name,defaultEthan,helpname)defhello(name):click.echo(Hello %s!%name)if__name____main__:hello()其中is_eagerTrue表明该命令行选项优先级高于其他选项expose_valueFalse表示如果没有输入该命令行选项会执行既定的命令行流程callback指定了输入该命令行选项时要跳转执行的函数执行情况$ 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.0click.argument我们除了使用click.option来添加可选参数还会经常使用click.argument来添加固定参数。它的使用和 option 类似但支持的功能比 option 少。入门使用下面是一个简单的例子importclickclick.command()click.argument(coordinates)defshow(coordinates):click.echo(coordinates: %s%coordinates)if__name____main__:show()看看执行情况$ python click_argument.py # 错误缺少参数 coordinates Usage: click_argument.py [OPTIONS] COORDINATES Error: Missing argument coordinates. $ python click_argument.py --help # argument 指定的参数在 help 中没有显示 Usage: click_argument.py [OPTIONS] COORDINATES Options: --help Show this message and exit. $ python click_argument.py --coordinates 10 # 错误用法这是 option 参数的用法 Error: no such option: --coordinates $ python click_argument.py 10 # 正确直接输入值即可 coordinates: 10多个 argument我们再来看看多个 argument 的例子importclickclick.command()click.argument(x)click.argument(y)click.argument(z)defshow(x,y,z):click.echo(x: %s, y: %s, z:%s%(x,y,z))if__name____main__:show()执行情况$ python click_argument.py 10 20 30 x: 10, y: 20, z:30 $ python click_argument.py 10 Usage: click_argument.py [OPTIONS] X Y Z Error: Missing argument y. $ python click_argument.py 10 20 Usage: click_argument.py [OPTIONS] X Y Z Error: Missing argument z. $ python click_argument.py 10 20 30 40 Usage: click_argument.py [OPTIONS] X Y Z Error: Got unexpected extra argument (40)不定参数argument 还有另外一种常见的用法就是接收不定量的参数让我们看看例子importclickclick.command()click.argument(src,nargs-1)click.argument(dst,nargs1)defmove(src,dst):click.echo(move %s to %s%(src,dst))if__name____main__:move()其中nargs-1表明参数src接收不定量的参数值参数值会以 tuple 的形式传入函数。如果nargs大于等于 1表示接收nargs个参数值上面的例子中dst接收一个参数值。让我们看看执行情况$ python click_argument.py file1 trash # src(file1,) dsttrash move (ufile1,) to trash $ python click_argument.py file1 file2 file3 trash # src(file1, file2, file3) dsttrash move (ufile1, ufile2, ufile3) to trash彩色输出在前面的例子中我们使用click.echo进行输出如果配合 [colorama][7] 这个模块我们可以使用click.secho进行彩色输出在使用之前使用 pip 安装 colorama$ pip install colorama看看例子importclickclick.command()click.option(--name,helpThe person to greet.)defhello(name):click.secho(Hello %s!%name,fgred,underlineTrue)click.secho(Hello %s!%name,fgyellow,bgblack)if__name____main__:hello()其中:fg表示前景颜色即字体颜色可选值有BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等bg表示背景颜色可选值有BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等underline表示下划线可选的样式还有dimTrueboldTrue等小结使用click.command()装饰一个函数使其成为命令行接口。使用click.option()添加可选参数支持设置固定长度的参数值。使用click.argument()添加固定参数支持设置不定长度的参数值。
