技术咨询
代买器件
商务客服
研发客服一、前言
在上一篇文章中，我们介绍了 click中的“参数”，本文将继续深入了解 click，着重讲解它的“选项”。
本系列文章默认使用 Python 3 作为解释器进行讲解。
若你仍在使用 Python 2，请注意两者之间语法和库的使用差异哦~
二、选项
通过 click.option可以给命令增加选项，并通过配置函数的参数来配置不同功能的选项。
2.1 给选项命名
click.option中的命令规则可参考参数名称[2]。它接受的前两个参数为长、短选项（顺序随意），其中：
-
长选项以 “--” 开头，比如 “--string-to-echo”
-
短选项以 “-” 开头，比如 “-s”
第三个参数为选项参数的名称，如果不指定，将会使用长选项的下划线形式名称：
@click.command() @click.option('-s', '--string-to-echo') def echo(string_to_echo): click.echo(string_to_echo)
显示指定为 string
@click.command() @click.option('-s', '--string-to-echo', 'string') def echo(string): click.echo(string)
2.2 基本值选项
值选项是非常常用的选项，它接受一个值。如果在命令行中提供了值选项，则需要提供对应的值；反之则使用默认值。若没在 click.option中指定默认值，则默认值为 None，且该选项的类型为 STRING[3]；反之，则选项类型为默认值的类型。
比如，提供默认值为 1，则选项类型为 INT[4]：
@click.command() @click.option('--n', default=1) def dots(n): click.echo('.' * n)
如果要求选项为必填，则可指定 click.option的 required=True：
@click.command() @click.option('--n', required=True, type=int) def dots(n): click.echo('.' * n)
如果选项名称和 Python 中的关键字冲突，则可以显式的指定选项名称。比如将 --from的名称设置为 from_：
@click.command() @click.option('--from', '-f', 'from_') @click.option('--to', '-t') def reserved_param_name(from_, to): click.echo(f'from {from_} to {to}')
如果要在帮助中显式默认值，则可指定 click.option的 show_default=True：
@click.command() @click.option('--n', default=1, show_default=True) def dots(n): click.echo('.' * n)
在命令行中调用则有：
$ dots --help Usage: dots [OPTIONS]
Options:
--n INTEGER [default: 1]
--help Show this message and exit.
2.3 多值选项
有时，我们会希望命令行中一个选项能接收多个值，通过指定 click.option中的 nargs参数（必须是大于等于 0）。这样，接收的多值选项就会变成一个元组。
比如，在下面的示例中，当通过 --pos指定多个值时，pos变量就是一个元组，里面的每个元素是一个 float：
@click.command() @click.option('--pos', nargs=2, type=float) def findme(pos): click.echo(pos)
在命令行中调用则有：
$ findme --pos 2.0 3.0
(1.0, 2.0)
有时，通过同一选项指定的多个值得类型可能不同，这个时候可以指定 click.option中的 type=(类型1, 类型2, ...)来实现。而由于元组的长度同时表示了值的数量，所以就无须指定 nargs参数。
@click.command() @click.option('--item', type=(str, int)) def putitem(item): click.echo('name=%s id=%d' % item)
在命令行中调用则有：
$ putitem --item peter 1338
name=peter id=1338
2.4 多选项
不同于多值选项是通过一个选项指定多个值，多选项则是使用多个相同选项分别指定值，通过 click.option中的 multiple=True来实现。
当我们定义如下多选项：
@click.command() @click.option('--message', '-m', multiple=True) def commit(message): click.echo('
'.join(message))
便可以指定任意数量个选项来指定值，获取到的 message是一个元组：
$ commit -m foo -m bar --message baz
foo
bar
baz
2.5 计值选项
有时我们可能需要获得选项的数量，那么可以指定 click.option中的 count=True来实现。
最常见的使用场景就是指定多个 --verbose或 -v选项来表示输出内容的详细程度。
@click.command() @click.option('-v', '--verbose', count=True) def log(verbose): click.echo(f'Verbosity: {verbose}')
在命令行中调用则有：
$ log -vvv
Verbosity: 3
通过上面的例子，verbose就是数字，表示 -v选项的数量，由此可以进一步使用该值来控制日志的详细程度。
2.6 布尔选项
布尔选项用来表示真或假，它有多种实现方式：
-
通过 click.option的 is_flag=True参数来实现：
import sys @click.command() @click.option('--shout', is_flag=True) def info(shout): rv = sys.platform if shout:
rv = rv.upper() + '!!!!111' click.echo(rv)
在命令行中调用则有：
$ info --shout
LINUX!!!!111
-
通过在 click.option的选项定义中使用 /分隔表示真假两个选项来实现：
import sys @click.command() @click.option('--shout/--no-shout', default=False) def info(shout): rv = sys.platform if shout:
rv = rv.upper() + '!!!!111' click.echo(rv)
在命令行中调用则有：
$ info --shout
LINUX!!!!111
$ info --no-shout
linux
在 Windows 中，一个选项可以以 /开头，这样就会真假选项的分隔符冲突了，这个时候可以使用 ;进行分隔：
@click.command() @click.option('/debug;/no-debug') def log(debug): click.echo(f'debug={debug}') if __name__ == '__main__':
log()
在 cmd 中调用则有：
> log /debug
debug=True
2.7 特性切换选项
所谓特性切换就是切换同一个操作对象的不同特性，比如指定 --upper就让输出大写，指定 --lower就让输出小写。这么来看，布尔值其实是特性切换的一个特例。
要实现特性切换选项，需要让多个选项都有相同的参数名称，并且定义它们的标记值 flag_value：
import sys @click.command() @click.option('--upper', 'transformation', flag_value='upper', default=True) @click.option('--lower', 'transformation', flag_value='lower') def info(transformation): click.echo(getattr(sys.platform, transformation)())
在命令行中调用则有：
$ info --upper
LINUX
$ info --lower
linux
$ info
LINUX
在上面的示例中，--upper和 --lower都有相同的参数值 transformation：
-
当指定 --upper时，transformation就是 --upper选项的标记值 upper
-
当指定 --lower时，transformation就是 --lower选项的标记值 lower
进而就可以做进一步的业务逻辑处理。
2.8 选择项选项
选择项选项和 上篇文章中介绍的 选择项参数类似，只不过是限定选项内容，依旧是通过 type=click.Choice实现。此外，case_sensitive=False还可以忽略选项内容的大小写。
@click.command() @click.option('--hash-type', type=click.Choice(['MD5', 'SHA1'], case_sensitive=False)) def digest(hash_type): click.echo(hash_type)
在命令行中调用则有：
$ digest --hash-type=MD5
MD5
$ digest --hash-type=md5
MD5
$ digest --hash-type=foo
Usage: digest [OPTIONS]
Try "digest --help" for help.
Error: Invalid value for "--hash-type": invalid choice: foo. (choose from MD5, SHA1)
$ digest --help Usage: digest [OPTIONS]
Options:
--hash-type [MD5|SHA1]
--help Show this message and exit.
2.9 提示选项
顾名思义，当提供了选项却没有提供对应的值时，会提示用户输入值。这种交互式的方式会让命令行变得更加友好。通过指定 click.option中的 prompt可以实现。
-
当 prompt=True时，提示内容为选项的参数名称
@click.command() @click.option('--name', prompt=True) def hello(name): click.echo(f'Hello {name}!')
在命令行调用则有：
$ hello --name=John
Hello John!
$ hello
Name: John
Hello John!
-
当 prompt='Your name please'时，提示内容为指定内容
@click.command() @click.option('--name', prompt='Your name please') def hello(name): click.echo(f'Hello {name}!')
在命令行中调用则有：
$ hello
Your name please: John
Hello John!
基于提示选项，我们还可以指定 hide_input=True来隐藏输入，confirmation_prompt=True来让用户进行二次输入，这非常适合输入密码的场景。
@click.command() @click.option('--password', prompt=True, hide_input=True, confirmation_prompt=True) def encrypt(password): click.echo(f'Encrypting password to {password.encode("rot13")}')
当然，也可以直接使用 click.password_option：
@click.command() @click.password_option() def encrypt(password): click.echo(f'Encrypting password to {password.encode("rot13")}')
我们还可以给提示选项设置默认值，通过 default参数进行设置，如果被设置为函数，则可以实现动态默认值。
@click.command() @click.option('--username', prompt=True, default=lambda: os.environ.get('USER', '')) def hello文章来源于:21IC 原文链接