如果cli中的任务选项不正确，则显示帮助

Question

当我将无效参数放入命令时，只显示以下内容：

Usage: ugen.py [OPTIONS]

Error: Missing option "-o" / "--out_file".

我想用——help选项显示整个帮助消息

我的装饰功能：

^{pr2}$

Answer 1

您可以挂接命令调用，然后根据需要显示帮助，如下所示：

自定义命令类

import click

class ShowUsageOnMissingError(click.Command):
    def __call__(self, *args, **kwargs):
        try:
            return super(ShowUsageOnMissingError, self).__call__(
                *args, standalone_mode=False, **kwargs)
        except click.MissingParameter as exc:
            exc.ctx = None
            exc.show(file=sys.stdout)
            click.echo()
            try:
                super(ShowUsageOnMissingError, self).__call__([' help'])
            except SystemExit:
                sys.exit(exc.exit_code)

使用自定义类

要使用自定义类，只需将该类传递给click.command()修饰符，如下所示：

^{pr2}$

这是怎么回事？

这是因为click是一个设计良好的OO框架。@click.command()修饰符通常实例化一个click.Command对象，但允许使用cls参数覆盖此行为。因此，在我们自己的类中从click.Command继承并超越所需的方法是一件相对容易的事情。在

在本例中，我们重写__call__()，并在打印异常后打印帮助。在

测试代码

@click.command(cls=ShowUsageOnMissingError)
@click.option("-o", help="Output file where data is written.", required=True)
def cli(o):
    click.echo(o)


if __name__ == "__main__":
    commands = (
        '-o outfile',
        '',
        ' help',
    )

    import sys, time

    time.sleep(1)
    print('Click Version: {}'.format(click.__version__))
    print('Python Version: {}'.format(sys.version))
    for cmd in commands:
        try:
            time.sleep(0.1)
            print('     -')
            print('> ' + cmd)
            time.sleep(0.1)
            cli(cmd.split(), obj={})

        except BaseException as exc:
            if str(exc) != '0' and \
                    not isinstance(exc, (click.ClickException, SystemExit)):
                raise

结果

Click Version: 6.7
Python Version: 3.6.2 (default, Jul 17 2017, 23:14:31)
[GCC 5.4.0 20160609]
     -
> -o outfile
outfile
     -
>
Error: Missing option "-o".

Usage: test.py [OPTIONS]

Options:
  -o TEXT  Output file where data is written.  [required]
   help   Show this message and exit.
     -
>  help
Usage: test.py [OPTIONS]

Options:
  -o TEXT  Output file where data is written.  [required]
   help   Show this message and exit.