对于Click中的可选参数,是否有与argparse
的nargs='*'
功能等效的功能?
我正在编写一个命令行脚本,其中一个选项需要能够接受无限数量的参数,例如:
foo --users alice bob charlie --bar baz
所以users
应该是['alice', 'bob', 'charlie']
,bar
应该是'baz'
。
在argparse
中,我可以指定多个可选参数,通过设置nargs='*'
来收集它们后面的所有参数。
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--users', nargs='*')
>>> parser.add_argument('--bar')
>>> parser.parse_args('--users alice bob charlie --bar baz'.split())
Namespace(bar='baz', users=['alice', 'bob', 'charlie'])
我知道Click允许你通过设置nargs=-1
来指定一个参数接受无限的输入,但是当我试图将一个可选参数的nargs
设置为-1时,我得到:
TypeError:选项的nargs不能小于0
有没有办法让Click接受一个选项的不指定数目的参数?
更新:
我需要能够在接受无限参数的选项之后指定选项。
更新:
@Stephen Rauch的回答回答了这个问题,但是我不推荐使用我在这里要求的方法,我的特性请求是intentionally not implemented in Click,因为它可能会导致意外的行为,Click推荐的方法是使用multiple=True
:
@click.option('-u', '--user', 'users', multiple=True)
在命令行中,它看起来像:
foo -u alice -u bob -u charlie --bar baz
4条答案
按热度按时间r9f1avp51#
实现所需功能的一种方法是从click.option继承并自定义解析器。
自定义类:
使用自定义类:
要使用自定义类,请将
cls
参数传递给@click.option()
装饰器,如下所示:或者如果希望该选项将吃掉命令行的整个剩余部分,而不考虑其它选项:
这是如何工作的?
这是因为click是一个设计良好的OO框架,
@click.option()
装饰器通常示例化click.Option
对象,但允许使用cls参数覆盖此行为,因此在我们自己的类中继承click.Option
并覆盖所需的方法是一件相对容易的事情。在本例中,我们覆盖
click.Option.add_to_parser()
,猴子修补解析器,以便我们可以根据需要吃多个令牌。测试代码:
测试结果:
aoyhnmkz2#
你可以使用这个技巧。
添加具有所需名称和无参数
nargs=0
的伪option
,然后添加具有无限参数nargs=-1
的“argument”。但要小心进一步的选择:
jvlzgdj93#
我也遇到了同样的问题。我没有实现一个带有n个参数的命令行选项,而是决定使用多个相同的命令行选项,并让Click在幕后用参数生成一个元组。我最终认为,如果Click不支持它,那么做出这个决定可能是有原因的。
https://click.palletsprojects.com/en/7.x/options/#multiple-options
这里有一个例子可以说明我的观点:
不是传递单个字符串参数,而是分隔符上的拆分:
我选择使用这个:
下面是源代码:
这更像是键入,但我确实认为它使CLI更加用户友好和健壮。
3bygqnnd4#
我自己需要这个,并考虑解决由@nikita-malovichko提供的solution,尽管它是非常限制性的,但它对我不起作用(见我对该答案的评论),所以想出了下面的替代方案。
我的解决方案并没有直接解决如何支持
nargs=*
的问题,但它为我自己提供了一个很好的选择,所以为了他人的利益分享它。我们的想法是使用一个选项来指定另一个选项的预期计数,即在运行时动态设置
nargs
计数。在上面的代码中,创建了一个自定义
Command
类,它知道“count”arg和接受多个arg的目标arg之间的链接。它首先在“resilient”模式下执行本地解析以检测计数,然后使用计数更新目标arg的nargs
值,然后在正常模式下继续解析。下面是一些交互示例:
注意:与官方推荐的使用
multiple=True
相比,它的优点是我们可以使用文件名通配符,并让shell扩展它们。