python click模块-命令行神器

Click 是用 Python 写的一个第三方模块，用于快速创建命令行。我们知道，Python 内置了一个 Argparse 的标准库用于创建命令行，但使用起来有些繁琐，Click 相比于 Argparse，就好比 requests 相比于 urllib。

快速使用

Click 的使用大致有两个步骤：

使用 @click.command() 装饰一个函数，使之成为命令行接口；

使用 @click.option() 等装饰函数，为其添加命令行选项等。

它的一种典型使用形式如下：

<code>import</code> <code>click</code>

<code> </code> 

<code>@click</code><code>.command()</code>

<code>@click</code><code>.option(</code><code>'--param'</code><code>, default</code><code>=</code><code>default_value, </code><code>help</code><code>=</code><code>'description'</code><code>)</code>

<code>def</code> <code>func(param):</code>

<code>    </code><code>pass</code>

下面，让我们看一下官方文档的入门例子：

<code>@click</code><code>.option(</code><code>'--count'</code><code>, default</code><code>=</code><code>1</code><code>, </code><code>help</code><code>=</code><code>'Number of greetings.'</code><code>)</code> <code>@click</code><code>.option(</code><code>'--name'</code><code>, prompt</code><code>=</code><code>'Your name'</code><code>, </code><code>help</code><code>=</code><code>'The person to greet.'</code><code>)</code> <code>def</code> <code>hello(count, name):</code> <code>    </code><code>"""Simple program that greets NAME for a total of COUNT times."""</code> <code>    </code><code>for</code> <code>x </code><code>in</code> <code>range</code><code>(count):</code> <code>        </code><code>click.echo(</code><code>'Hello %s!'</code> <code>%</code> <code>name)</code> <code>if</code> <code>__name__ </code><code>=</code><code>=</code> <code>'__main__'</code><code>:</code> <code>    </code><code>hello()</code>

在上面的例子中，函数 hello 有两个参数：count 和 name，它们的值从命令行中获取。

@click.command() 使函数 hello 成为命令行接口；

@click.option 的第一个参数指定了命令行选项的名称，可以看到，count 的默认值是 1；

使用 click.echo 进行输出是为了获得更好的兼容性，因为 print 在 Python2 和 Python3 的用法有些差别。

看看执行情况：

<code>$ python hello.py</code>

<code>Your name: Ethan           </code><code># 这里会显示 'Your name: '(对应代码中的 prompt)，接受用户输入</code>

<code>Hello Ethan!</code>

<code>$ python hello.py </code><code>-</code><code>-</code><code>help</code>   <code># click 帮我们自动生成了 `--help` 用法</code>

<code>Usage: hello.py [OPTIONS]</code>

<code>  </code><code>Simple program that greets NAME </code><code>for</code> <code>a total of COUNT times.</code>

<code>Options:</code>

<code>  </code><code>-</code><code>-</code><code>count INTEGER  Number of greetings.</code>

<code>  </code><code>-</code><code>-</code><code>name TEXT      The person to greet.</code>

<code>  </code><code>-</code><code>-</code><code>help</code>           <code>Show this message </code><code>and</code> <code>exit.</code>

<code>$ python hello.py </code><code>-</code><code>-</code><code>count </code><code>3</code> <code>-</code><code>-</code><code>name Ethan    </code><code># 指定 count 和 name 的值</code>

<code>$ python hello.py </code><code>-</code><code>-</code><code>count</code><code>=</code><code>3</code> <code>-</code><code>-</code><code>name</code><code>=</code><code>Ethan    </code><code># 也可以使用 `=`，和上面等价</code>

<code>$ python hello.py </code><code>-</code><code>-</code><code>name</code><code>=</code><code>Ethan              </code><code># 没有指定 count，默认值是 1</code>

click.option

option 最基本的用法就是通过指定命令行选项的名称，从命令行读取参数值，再将其传递给函数。在上面的例子，我们看到，除了设置命令行选项的名称，我们还会指定默认值，help 说明等，option 常用的设置参数如下：

default: 设置命令行参数的默认值

help: 参数说明

type: 参数类型，可以是 string, int, float 等

prompt: 当在命令行中没有输入相应的参数时，会根据 prompt 提示用户输入

nargs: 指定命令行参数接收的值的个数

metavar：如何在帮助页面表示值

下面，我们再看看相关的例子。

指定 type

我们可以使用 type 来指定参数类型：

<code>@click</code><code>.option(</code><code>'--rate'</code><code>, </code><code>type</code><code>=</code><code>float</code><code>, </code><code>help</code><code>=</code><code>'rate'</code><code>)   </code><code># 指定 rate 是 float 类型</code> <code>def</code> <code>show(rate):</code> <code>    </code><code>click.echo(</code><code>'rate: %s'</code> <code>%</code> <code>rate)</code> <code>    </code><code>show()</code>

执行情况：

<code>$ python click_type.py </code><code>-</code><code>-</code><code>rate </code><code>1</code> <code>rate: </code><code>1.0</code> <code>$ python click_type.py </code><code>-</code><code>-</code><code>rate </code><code>0.66</code> <code>rate: </code><code>0.66</code>

可选值

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

<code>@click</code><code>.option(</code><code>'--gender'</code><code>, </code><code>type</code><code>=</code><code>click.Choice([</code><code>'man'</code><code>, </code><code>'woman'</code><code>]))    </code><code># 限定值</code> <code>def</code> <code>choose(gender):</code> <code>    </code><code>click.echo(</code><code>'gender: %s'</code> <code>%</code> <code>gender)</code> <code>    </code><code>choose()</code>

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

多值参数

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

看看例子就明白了：

<code>@click</code><code>.option(</code><code>'--center'</code><code>, nargs</code><code>=</code><code>2</code><code>, </code><code>type</code><code>=</code><code>float</code><code>, </code><code>help</code><code>=</code><code>'center of the circle'</code><code>)</code>

<code>@click</code><code>.option(</code><code>'--radius'</code><code>, </code><code>type</code><code>=</code><code>float</code><code>, </code><code>help</code><code>=</code><code>'radius of the circle'</code><code>)</code>

<code>def</code> <code>circle(center, radius):</code>

<code>    </code><code>click.echo(</code><code>'center: %s, radius: %s'</code> <code>%</code> <code>(center, radius))</code>

<code>    </code><code>circle()</code>

在上面的例子中，option 指定了两个参数：center 和 radius，其中，center 表示二维平面上一个圆的圆心坐标，接收两个值，以元组的形式将值传递给函数，而 radius 表示圆的半径。

<code>$ python click_multi_values.py </code><code>-</code><code>-</code><code>center </code><code>3</code> <code>4</code> <code>-</code><code>-</code><code>radius </code><code>10</code>

<code>center: (</code><code>3.0</code><code>, </code><code>4.0</code><code>), radius: </code><code>10.0</code>

<code>$ python click_multi_values.py </code><code>-</code><code>-</code><code>center </code><code>3</code> <code>4</code> <code>5</code> <code>-</code><code>-</code><code>radius </code><code>10</code>

<code>Usage: click_multi_values.py [OPTIONS]</code>

<code>Error: Got unexpected extra argument (</code><code>5</code><code>)</code>

输入密码

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

看看例子：

<code>@click</code><code>.option(</code><code>'--password'</code><code>, prompt</code><code>=</code><code>True</code><code>, hide_input</code><code>=</code><code>True</code><code>, confirmation_prompt</code><code>=</code><code>True</code><code>)</code>

<code>def</code> <code>input_password(password):</code>

<code>    </code><code>click.echo(</code><code>'password: %s'</code> <code>%</code> <code>password)</code>

<code>    </code><code>input_password()</code>

<code>$ python click_password.py</code> <code>Password:                         </code><code># 不会显示密码</code> <code>Repeat </code><code>for</code> <code>confirmation:          </code><code># 重复一遍</code> <code>password: </code><code>666666</code>

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

<code>@click</code><code>.password_option()</code>

改变命令行程序的执行

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

让我们看看例子：

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

其中：

is_eager=True 表明该命令行选项优先级高于其他选项；

expose_value=False 表示如果没有输入该命令行选项，会执行既定的命令行流程；

callback 指定了输入该命令行选项时，要跳转执行的函数；

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

click.argument

我们除了使用 @click.option 来添加可选参数，还会经常使用 @click.argument 来添加固定参数。它的使用和 option 类似，但支持的功能比 option 少。

入门使用

下面是一个简单的例子：

<code>@click</code><code>.argument(</code><code>'coordinates'</code><code>)</code> <code>def</code> <code>show(coordinates):</code> <code>    </code><code>click.echo(</code><code>'coordinates: %s'</code> <code>%</code> <code>coordinates)</code>

<code>$ python click_argument.py                     </code><code># 错误，缺少参数 coordinates</code> <code>Usage: click_argument.py [OPTIONS] COORDINATES</code> <code>Error: Missing argument </code><code>"coordinates"</code><code>.</code> <code>$ python click_argument.py </code><code>-</code><code>-</code><code>help</code>              <code># argument 指定的参数在 help 中没有显示</code> <code>  </code><code>-</code><code>-</code><code>help</code>  <code>Show this message </code><code>and</code> <code>exit.</code> <code>$ python click_argument.py </code><code>-</code><code>-</code><code>coordinates </code><code>10</code>    <code># 错误用法，这是 option 参数的用法</code> <code>Error: no such option: </code><code>-</code><code>-</code><code>coordinates</code> <code>$ python click_argument.py </code><code>10</code>                  <code># 正确，直接输入值即可</code> <code>coordinates: </code><code>10</code>

多个 argument

我们再来看看多个 argument 的例子：

<code>@click</code><code>.argument(</code><code>'x'</code><code>)</code> <code>@click</code><code>.argument(</code><code>'y'</code><code>)</code> <code>@click</code><code>.argument(</code><code>'z'</code><code>)</code> <code>def</code> <code>show(x, y, z):</code> <code>    </code><code>click.echo(</code><code>'x: %s, y: %s, z:%s'</code> <code>%</code> <code>(x, y, z))</code>

<code>$ python click_argument.py </code><code>10</code> <code>20</code> <code>30</code> <code>x: </code><code>10</code><code>, y: </code><code>20</code><code>, z:</code><code>30</code> <code>$ python click_argument.py </code><code>10</code> <code>Usage: click_argument.py [OPTIONS] X Y Z</code> <code>Error: Missing argument </code><code>"y"</code><code>.</code> <code>$ python click_argument.py </code><code>10</code> <code>20</code> <code>Error: Missing argument </code><code>"z"</code><code>.</code> <code>$ python click_argument.py </code><code>10</code> <code>20</code> <code>30</code> <code>40</code> <code>Error: Got unexpected extra argument (</code><code>40</code><code>)</code>

不定参数

argument 还有另外一种常见的用法，就是接收不定量的参数，让我们看看例子：

<code>@click</code><code>.argument(</code><code>'src'</code><code>, nargs</code><code>=</code><code>-</code><code>1</code><code>)</code>

<code>@click</code><code>.argument(</code><code>'dst'</code><code>, nargs</code><code>=</code><code>1</code><code>)</code>

<code>def</code> <code>move(src, dst):</code>

<code>    </code><code>click.echo(</code><code>'move %s to %s'</code> <code>%</code> <code>(src, dst))</code>

<code>    </code><code>move()</code>

其中，nargs=-1 表明参数 src 接收不定量的参数值，参数值会以 tuple 的形式传入函数。如果 nargs 大于等于 1，表示接收 nargs 个参数值，上面的例子中，dst 接收一个参数值。

让我们看看执行情况：

<code>$ python click_argument.py file1 trash    </code><code># src=('file1',)  dst='trash'</code> <code>move (u</code><code>'file1'</code><code>,) to trash</code> <code>$ python click_argument.py file1 file2 file3 trash   </code><code># src=('file1', 'file2', 'file3')  dst='trash'</code> <code>move (u</code><code>'file1'</code><code>, u</code><code>'file2'</code><code>, u</code><code>'file3'</code><code>) to trash</code>

彩色输出

在前面的例子中，我们使用 click.echo 进行输出，如果配合 colorama 这个模块，我们可以使用 click.secho 进行彩色输出，在使用之前，使用 pip 安装 colorama：

$ pip install colorama

<code>@click</code><code>.option(</code><code>'--name'</code><code>, </code><code>help</code><code>=</code><code>'The person to greet.'</code><code>)</code>

<code>    </code><code>click.secho(</code><code>'Hello %s!'</code> <code>%</code> <code>name, fg</code><code>=</code><code>'red'</code><code>, underline</code><code>=</code><code>True</code><code>)</code>

<code>    </code><code>click.secho(</code><code>'Hello %s!'</code> <code>%</code> <code>name, fg</code><code>=</code><code>'yellow'</code><code>, bg</code><code>=</code><code>'black'</code><code>)</code>

其中:

fg 表示前景颜色（即字体颜色），可选值有：BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等；

bg 表示背景颜色，可选值有：BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等；

underline 表示下划线，可选的样式还有：dim=True，bold=True 等；

小结

使用 click.command() 装饰一个函数，使其成为命令行接口。

使用 click.option() 添加可选参数，支持设置固定长度的参数值。

使用 click.argument() 添加固定参数，支持设置不定长度的参数值。

参考资料

Click Documentation (6.0)

Python Click 学习笔记

click模块 – cdwanze

本文转自 baby神 51CTO博客，原文链接：http://blog.51cto.com/babyshen/1887837，如需转载请自行联系原作者