为什么我使用click。参数PRODUCT“获得意外的关键字参数“help”？

Question

运行以下代码会导致此错误：

TypeError:init（）获得意外的关键字参数“help”

import click

@click.command()
@click.argument('command', required=1, help="start|stop|restart")
@click.option('--debug/--no-debug', default=False, help="Run in foreground")
def main(command, debug):
    print (command)
    print (debug)

if __name__ == '__main__':
    main()

$ python3 foo.py start
Traceback (most recent call last):
  File "foo.py", line 5, in <module>
    @click.option('--debug/--no-debug', default=False, help="Run in foreground")
  File "/home/cbetti/python/lib/python3/dist-packages/click-4.0-py3.4.egg/click/decorators.py", line 148, in decorator
    _param_memo(f, ArgumentClass(param_decls, **attrs))
  File "/home/cbetti/python/lib/python3/dist-packages/click-4.0-py3.4.egg/click/core.py", line 1618, in __init__
    Parameter.__init__(self, param_decls, required=required, **attrs)
TypeError: __init__() got an unexpected keyword argument 'help'

为什么会发生这种错误？

Answer 1

单击库不允许-help内的参数单击。参数（包括编写此注释时的当前版本6.7）。但是，您可以在单击中使用-help参数。选项
您可以在以下位置查看当前的单击文档：http://click.pocoo.org/6/documentation/或以前在http://click.pocoo.org/5/documentation/这种行为最近没有改变。那么，它就是一团。这不是一个错误。

Answer 2

您正在将命令定义为参数。请注意，与您在此处尝试的方法相比，单击有更好的方法来定义命令。

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

@main.command()
def start():
    """documentation for the start command"""
    print("running command `start`")

@main.command()
def stop():
    """documentation for the stop command"""
    print("running command `stop`")

if __name__ == '__main__':
    main()

将产生以下默认帮助文本：

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

Options:
  --help  Show this message and exit.

Commands:
  start  documentation for the start command
  stop   documentation for the stop command

话虽如此，如果您真的需要参数，您不能使用help参数。单击留档确实指出您应该记录自己的参数。然而，我不知道如何做到这一点。有什么提示吗？

编辑

如注释中所述：这是为了与Unix标准保持一致，以便在主帮助文本中记录参数。

Answer 3

我一次又一次地遇到这个问题，因为跟踪输出与导致错误的参数不对应。注意跟踪中的ArgumentClass，这是您的提示。

“help”是单击时可接受的参数。选项。但是，单击库更倾向于记录自己的参数。点击@按钮。参数帮助参数导致此异常。

这段代码有效：（注意@click.argument中缺少，help=“start | stop | restart”）

import click

@click.command()
@click.argument('command', required=1)
@click.option('--debug/--no-debug', default=False, help="Run in foreground")
def main(command, debug):
    """ COMMAND: start|stop|restart """
    print (command)
    print (debug)

if __name__ == '__main__':
        main()

输出：

$ python3 foo.py start
start
False

帮助输出：

Usage: test.py [OPTIONS] COMMAND

  COMMAND: start|stop|restart

Options:
  --debug / --no-debug  Run in foreground
  --help                Show this message and exit.