Python 一种更改 Click 默认帮助选项的方法

发布于06月11日

无论何时使用单击创建命令或组，都会有一个默认的--help选项来显示使用指南:

import click

@click.command()
def main():
    click.echo('Success!')

if __name__ == '__main__':
    main()

如果我使用--help运行文件，我应该得到:

$ python file.py --help
Usage: file.py [OPTIONS]

Options:
--help  Show this message and exit.

现在，单击允许您通过decorator中的参数覆盖通过终端调用help选项的方式:

@click.command(
    context_settings=dict(
        help_option_names=['-f', '--foo']
    )
)
def main():
    click.echo('Success!')

$ python file.py -f
Usage: file.py [OPTIONS]

Options:
-f, --foo  Show this message and exit.

然而，翻阅Click的documentation，我看不到类似的选项来覆盖默认的帮助message.

是否有一个参数指定为click.command，在终端中调用帮助时覆盖文本"Show this message and exit"？

推荐答案

您可以使用help_option decorator更改click的默认帮助选项

示例代码:

@click.command(add_help_option=False)
@click.help_option('--foo', '-f', help='Show my better message and exit')
def main():
    """The docstring is the Help Message"""
    click.echo('Success!')

测试代码:

if __name__ == "__main__":
    print('Click Version: {}'.format(click.__version__))
    print('Python Version: {}'.format(sys.version))
    print('-----------')
    cmd = 'main --foo'
    print('> ' + cmd)
    main(cmd.split())

试验结果:

Click Version: 8.1.3
Python Version: 3.7.8 (tags/v3.7.8:4b47a5b6ba, Jun 28 2020, 08:53:46) [MSC v.1916 64 bit (AMD64)]
-----------
> main --foo
Usage: test_code.py [OPTIONS]

  The docstring is the Help Message

Options:
  -f, --foo  Show my better message and exit