命令行神器 Click 简明笔记
melody467671
7年前
<h2>快速使用</h2> <p>Click 的使用大致有两个步骤：</p> <ol> <li>使用 @click.command() 装饰一个函数，使之成为命令行接口；</li> <li>使用 @click.option() 等装饰函数，为其添加命令行选项等。</li> </ol> <p>它的一种典型使用形式如下：</p> <pre> <code class="language-python">importclick @click.command() @click.option('--param', default=default_value, help='description') deffunc(param): pass </code></pre> <p>下面，让我们看一下 官方文档 的入门例子：</p> <pre> <code class="language-python">importclick @click.command() @click.option('--count', default=1, help='Number of greetings.') @click.option('--name', prompt='Your name', help='The person to greet.') defhello(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() </code></pre> <p>在上面的例子中，函数 hello 有两个参数：count 和 name，它们的值从命令行中获取。</p> <ul> <li>@click.command() 使函数 hello 成为命令行接口；</li> <li>@click.option 的第一个参数指定了命令行选项的名称，可以看到，count 的默认值是 1；</li> <li>使用 click.echo 进行输出是为了获得更好的兼容性，因为 print 在 Python2 和 Python3 的用法有些差别。</li> </ul> <p>看看执行情况：</p> <pre> <code class="language-python">$ pythonhello.py Yourname: Ethan # 这里会显示 'Your name: '(对应代码中的 prompt)，接受用户输入 HelloEthan! $ pythonhello.py --help # click 帮我们自动生成了 `--help` 用法 Usage: hello.py [OPTIONS] SimpleprogramthatgreetsNAMEfor a totalofCOUNTtimes. Options: --countINTEGER Numberofgreetings. --nameTEXT Thepersonto greet. --help Showthis messageand exit. $ pythonhello.py --count 3 --nameEthan # 指定 count 和 name 的值 HelloEthan! HelloEthan! HelloEthan! $ pythonhello.py --count=3 --name=Ethan # 也可以使用 `=`，和上面等价 HelloEthan! HelloEthan! HelloEthan! $ pythonhello.py --name=Ethan # 没有指定 count，默认值是 1 HelloEthan! </code></pre> <h2>click.option</h2> <p>option 最基本的用法就是通过指定命令行选项的名称，从命令行读取参数值，再将其传递给函数。在上面的例子，我们看到，除了设置命令行选项的名称，我们还会指定默认值，help 说明等，option 常用的设置参数如下：</p> <ul> <li>default: 设置命令行参数的默认值</li> <li>help: 参数说明</li> <li>type: 参数类型，可以是 string, int, float 等</li> <li>prompt: 当在命令行中没有输入相应的参数时，会根据 prompt 提示用户输入</li> <li>nargs: 指定命令行参数接收的值的个数</li> </ul> <p>下面，我们再看看相关的例子。</p> <h2>指定 type</h2> <p>我们可以使用 type 来指定参数类型：</p> <pre> <code class="language-python">importclick @click.command() @click.option('--rate', type=float, help='rate') # 指定 rate 是 float 类型 defshow(rate): click.echo('rate: %s' % rate) if __name__ == '__main__': show() </code></pre> <p>执行情况：</p> <pre> <code class="language-python">$ pythonclick_type.py --rate 1 rate: 1.0 $ pythonclick_type.py --rate 0.66 rate: 0.66 </code></pre> <h2>可选值</h2> <p>在某些情况下，一个参数的值只能是某些可选的值，如果用户输入了其他值，我们应该提示用户输入正确的值。在这种情况下，我们可以通过 click.Choice() 来限定：</p> <pre> <code class="language-python">importclick @click.command() @click.option('--gender', type=click.Choice(['man', 'woman'])) # 限定值 defchoose(gender): click.echo('gender: %s' % gender) if __name__ == '__main__': choose() </code></pre> <p>执行情况：</p> <pre> <code class="language-python">$ pythonclick_choice.py --genderboy Usage: click_choice.py [OPTIONS] Error: Invalidvaluefor "--gender": invalidchoice: boy. (choosefromman, woman) $ pythonclick_choice.py --genderman gender: man </code></pre> <h2>多值参数</h2> <p>有时，一个参数需要接收多个值。 <strong>option 支持设置固定长度的参数值</strong> ，通过 nargs 指定。</p> <p>看看例子就明白了：</p> <pre> <code class="language-python">importclick @click.command() @click.option('--center', nargs=2, type=float, help='center of the circle') @click.option('--radius', type=float, help='radius of the circle') defcircle(center, radius): click.echo('center: %s, radius: %s' % (center, radius)) if __name__ == '__main__': circle() </code></pre> <p>在上面的例子中，option 指定了两个参数：center 和 radius，其中，center 表示二维平面上一个圆的圆心坐标，接收两个值，以元组的形式将值传递给函数，而 radius 表示圆的半径。</p> <p>执行情况：</p> <pre> <code class="language-python">$ pythonclick_multi_values.py --center 3 4 --radius 10 center: (3.0, 4.0), radius: 10.0 $ pythonclick_multi_values.py --center 3 4 5 --radius 10 Usage: click_multi_values.py [OPTIONS] Error: Gotunexpectedextraargument (5) </code></pre> <h2>输入密码</h2> <p>有时，在输入密码的时候，我们希望能隐藏显示。option 提供了两个参数来设置密码的输入：hide_input 和 confirmation_promt，其中，hide_input 用于隐藏输入，confirmation_promt 用于重复输入。</p> <p>看看例子：</p> <pre> <code class="language-python">importclick @click.command() @click.option('--password', prompt=True, hide_input=True, confirmation_prompt=True) definput_password(password): click.echo('password: %s' % password) if __name__ == '__main__': input_password() </code></pre> <p>执行情况：</p> <pre> <code class="language-python">$ pythonclick_password.py Password: # 不会显示密码 Repeatfor confirmation: # 重复一遍 password: 666666 </code></pre> <p>由于上面的写法有点繁琐，click 也提供了一种快捷的方式，通过使用 @click.password_option() ，上面的代码可以简写成：</p> <pre> <code class="language-python">importclick @click.command() @click.password_option() definput_password(password): click.echo('password: %s' % password) if __name__ == '__main__': input_password() </code></pre> <h2>改变命令行程序的执行</h2> <p>有些参数会改变命令行程序的执行，比如在终端输入 python 是进入 python 控制台，而输入 python --version 是打印 python 版本。Click 提供 eager 标识对参数名进行标识，如果输入该参数，则会拦截既定的命令行执行流程，跳转去执行一个回调函数。</p> <p>让我们看看例子：</p> <pre> <code class="language-python">importclick defprint_version(ctx, param, value): if not valueor ctx.resilient_parsing: return click.echo('Version 1.0') ctx.exit() @click.command() @click.option('--version', is_flag=True, callback=print_version, expose_value=False, is_eager=True) @click.option('--name', default='Ethan', help='name') defhello(name): click.echo('Hello %s!' % name) if __name__ == '__main__': hello() </code></pre> <p>其中：</p> <ul> <li>is_eager=True 表明该命令行选项优先级高于其他选项；</li> <li>expose_value=False 表示如果没有输入该命令行选项，会执行既定的命令行流程；</li> <li>callback 指定了输入该命令行选项时，要跳转执行的函数；</li> </ul> <p>执行情况：</p> <pre> <code class="language-python">$ pythonclick_eager.py HelloEthan! $ pythonclick_eager.py --version # 拦截既定的命令行执行流程 Version 1.0 $ pythonclick_eager.py --nameMichael HelloMichael! $ pythonclick_eager.py --version --nameEthan # 忽略 name 选项 Version 1.0 </code></pre> <h2>click.argument</h2> <p>我们除了使用 @click.option 来添加 <strong>可选参数</strong> ，还会经常使用 @click.argument 来添加 <strong>固定参数</strong> 。它的使用和 option 类似，但支持的功能比 option 少。</p> <h2>入门使用</h2> <p>下面是一个简单的例子：</p> <pre> <code class="language-python">importclick @click.command() @click.argument('coordinates') defshow(coordinates): click.echo('coordinates: %s' % coordinates) if __name__ == '__main__': show() </code></pre> <p>看看执行情况：</p> <pre> <code class="language-python">$ pythonclick_argument.py # 错误，缺少参数 coordinates Usage: click_argument.py [OPTIONS] COORDINATES Error: Missingargument "coordinates". $ pythonclick_argument.py --help # argument 指定的参数在 help 中没有显示 Usage: click_argument.py [OPTIONS] COORDINATES Options: --help Showthis messageand exit. $ pythonclick_argument.py --coordinates 10 # 错误用法，这是 option 参数的用法 Error: nosuchoption: --coordinates $ pythonclick_argument.py 10 # 正确，直接输入值即可 coordinates: 10 </code></pre> <h2>多个 argument</h2> <p>我们再来看看多个 argument 的例子：</p> <pre> <code class="language-python">importclick @click.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() </code></pre> <p>执行情况：</p> <pre> <code class="language-python">$ pythonclick_argument.py 10 20 30 x: 10, y: 20, z:30 $ pythonclick_argument.py 10 Usage: click_argument.py [OPTIONS] X Y Z Error: Missingargument "y". $ pythonclick_argument.py 10 20 Usage: click_argument.py [OPTIONS] X Y Z Error: Missingargument "z". $ pythonclick_argument.py 10 20 30 40 Usage: click_argument.py [OPTIONS] X Y Z Error: Gotunexpectedextraargument (40) </code></pre> <h2>不定参数</h2> <p>argument 还有另外一种常见的用法，就是接收不定量的参数，让我们看看例子：</p> <pre> <code class="language-python">importclick @click.command() @click.argument('src', nargs=-1) @click.argument('dst', nargs=1) defmove(src, dst): click.echo('move %s to %s' % (src, dst)) if __name__ == '__main__': move() </code></pre> <p>其中， nargs=-1 表明参数 src 接收不定量的参数值，参数值会以 tuple 的形式传入函数。如果 nargs 大于等于 1，表示接收 nargs 个参数值，上面的例子中， dst 接收一个参数值。</p> <p>让我们看看执行情况：</p> <pre> <code class="language-python">$ pythonclick_argument.pyfile1trash # src=('file1',) dst='trash' move (u'file1',) to trash $ pythonclick_argument.pyfile1file2file3trash # src=('file1', 'file2', 'file3') dst='trash' move (u'file1', u'file2', u'file3') to trash </code></pre> <h2>彩色输出</h2> <p>在前面的例子中，我们使用 click.echo 进行输出，如果配合 colorama 这个模块，我们可以使用 click.secho 进行彩色输出，在使用之前，使用 pip 安装 colorama：</p> <pre> <code class="language-python">$ pipinstallcolorama </code></pre> <p>看看例子：</p> <pre> <code class="language-python">importclick @click.command() @click.option('--name', help='The person to greet.') defhello(name): click.secho('Hello %s!' % name, fg='red', underline=True) click.secho('Hello %s!' % name, fg='yellow', bg='black') if __name__ == '__main__': hello() </code></pre> <p>其中:</p> <ul> <li>fg 表示前景颜色（即字体颜色），可选值有：BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等；</li> <li>bg 表示背景颜色，可选值有：BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等；</li> <li>underline 表示下划线，可选的样式还有： dim=True ， bold=True 等；</li> </ul> <h2>小结</h2> <ul> <li>使用 click.command() 装饰一个函数，使其成为命令行接口。</li> <li>使用 click.option() 添加可选参数，支持设置固定长度的参数值。</li> <li>使用 click.argument() 添加固定参数，支持设置不定长度的参数值。</li> </ul> <h2>参考资料</h2> <ul> <li><a href="/misc/goto?guid=4959731352310477426" rel="nofollow,noindex">Click Documentation (6.0)</a></li> <li><a href="/misc/goto?guid=4959731352405070410" rel="nofollow,noindex">Python Click 学习笔记</a></li> <li><a href="/misc/goto?guid=4959731352482137032" rel="nofollow,noindex">click模块 – cdwanze</a></li> </ul> <p> </p> <p>来自：http://python.jobbole.com/87111/</p> <p> </p>