别名组 http://click.pocoo.org/5/advanced/不是您想要的,因为它允许最短的前缀匹配,而且您似乎需要实际的别名。但这个例子确实提供了可行的方向的提示。它继承自click.Group
并覆盖某些行为。
这是实现您所追求的目标的一种方法:
定制类
这个类重写了click.Group.command()
用于装饰命令函数的方法。它增加了传递命令别名列表的能力。此类还添加了引用别名命令的简短帮助。
class CustomMultiCommand(click.Group):
def command(self, *args, **kwargs):
"""Behaves the same as `click.Group.command()` except if passed
a list of names, all after the first will be aliases for the first.
"""
def decorator(f):
if isinstance(args[0], list):
_args = [args[0][0]] + list(args[1:])
for alias in args[0][1:]:
cmd = super(CustomMultiCommand, self).command(
alias, *args[1:], **kwargs)(f)
cmd.short_help = "Alias for '{}'".format(_args[0])
else:
_args = args
cmd = super(CustomMultiCommand, self).command(
*_args, **kwargs)(f)
return cmd
return decorator
使用自定义类
通过通过cls
参数到click.group()
装饰器,通过添加到组的任何命令group.command()
可以传递命令名称列表。
@click.group(cls=CustomMultiCommand)
def cli():
"""My Excellent CLI"""
@cli.command(['my-command', 'my-cmd'])
def my_command():
....
测试代码:
import click
@click.group(cls=CustomMultiCommand)
def cli():
"""My Excellent CLI"""
@cli.command(['my-command', 'my-cmd'])
def my_command():
"""This is my command"""
print('Running the command')
if __name__ == '__main__':
cli('--help'.split())
检测结果:
Usage: my_cli [OPTIONS] COMMAND [ARGS]...
My Excellent CLI
Options:
--help Show this message and exit.
Commands:
my-cmd Alias for 'my-command'
my-command This is my command