docopt不允许使用可选参数

时间:2014-02-06 10:24:40

标签: python command-line-interface docopt

我在docopt中有以下用法:

cli.py add_user <user_file> [<devices_file>] <destination_account> <token>
cli.py remove_user (--id|--username) <user_id> <source_account> <token>

[<devices_file>]是可选参数。

但是,当我尝试使用它时,我收到错误。

这没关系:

add_user user_29087.json dev_29087.json 531 token

这会引发错误:

add_user user_29087.json 531 token

错误:

Traceback (most recent call last):
  File "C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\Extensio
ns\Microsoft\Python Tools for Visual Studio\2.0\visualstudio_py_util.py", line 7
6, in exec_file
    exec(code_obj, global_variables)
  File "C:\Users\mryan\Documents\Code\cli\cli_front.py", line
 49, in <module>
    arguments = docopt(__doc__, version='1.0.0rc2')
  File "C:\Users\mryan\Documents\Code\cli\common\docopt.py", l
ine 581, in docopt
    raise DocoptExit()
DocoptExit: Usage:
    cli.py get_token
    cli.py add_user <user_file> [<devices_file>] <destination_account> <token>
    cli.py remove_user (--id|--username) <user_id> <source_account> <token>
    cli.py get_users <account_id> <token>

有人能看出我做错了吗?

1 个答案:

答案 0 :(得分:1)

根据你在add_user中的用法,如果有或没有可选的devices_file,我看不出CLI会如何区分。

在你的第二个例子中,似乎假设531是你的可选项,而你只是错过了你的,因为它无法将“531”条目解释为设备文件。

由于devices_file是可选的,我会这样写:

Usage:
    add_user <user_file> <destination_account> <token> [<devices_file>]

OR

Usage:
    add_user <user_file> [-d DEVFI | --devices-file=DEVFI] <destination_account> <token>

Options:
    -d DEVFI --devices-file=DEVFI    Optional devices file for blah.

请注意,在文档中,选项几乎总是在最后完成。

"""Naval Fate.

Usage:
  naval_fate.py ship new <name>...
  naval_fate.py ship <name> move <x> <y> [--speed=<kn>]
  naval_fate.py ship shoot <x> <y>
  naval_fate.py mine (set|remove) <x> <y> [--moored | --drifting]