更改 Click 默认帮助选项的方法？

Question

每当您使用 Click 创建命令或组时，都会有一个默认的

--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.

现在，Click 允许您通过装饰器中的参数覆盖通过终端调用

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 的文档，我没有看到类似的选项来覆盖默认帮助消息。

---

在终端中寻求帮助时，是否有指定给

click.command

的参数来覆盖文本 “显示此消息并退出”？

Answer 1

您可以使用

help_option

装饰器更改 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

Answer 2

要更改帮助文本，只需一行

help_option

装饰器就足够了

@click.help_option('--help', help='Show my better message and exit')

或者，您可以按照完整的 @Stephen Rauch 的答案进行详细调整