单击中的 HelpFormatter

Question

我在本地模块中使用click并且我想调整帮助的显示方式：

当前输出--help：

Usage: __main__.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  foo     Foo is a program very nice and pretty...

默认情况下，prog名称为__main__.py并且文本被修剪为 78 个字符。

我发现这可以使用HelpFormatter类进行调整。但我不知道如何在这种情况下使用它。

当前代码：

import click

@click.group()
def main(ctx):
   pass

@main.command()
def foo():
   pass

click.CommandCollection(sources=[main])()

预期输出：

Usage: my_module_name [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  foo     Foo is a program very nice and pretty and this sentence is very long.

Answer 1

如果您试图避免截断帮助字符串，这可以通过short_help参数来完成。 short_help通常派生自help但被截断。如果明确传递，将显示整个字符串。

显示字符串my_module_name，可以在参数下传递prog_name

测试代码：

import click

@click.group()
def main(ctx):
   pass

@main.command(short_help='Foo is a program very nice and pretty and '
                         'this sentence is very long.')
def foo():
   pass

main(['--help'], prog_name='my_module_name')

结果short_help：

Usage: my_module_name [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  foo  Foo is a program very nice and pretty and this sentence is very long.