文章/答案/技术大牛

发布

社区首页 >问答首页 >使用没有-h的docopt显示完整的docstring

问使用没有-h的docopt显示完整的docstring
EN

Stack Overflow用户

提问于 2015-07-16 14:58:14

回答 3查看 394关注 0票数 4

我试图使用docopt显示所有帮助消息，而不添加--help参数。

例如，这是官方文档中的：

"""
Naval Fate.

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

Options:
  -h --help     Show this screen.
  --version     Show version.
  --speed=<kn>  Speed in knots [default: 10].
  --moored      Moored (anchored) mine.
  --drifting    Drifting mine.
"""

from docopt import docopt
arguments = docopt(__doc__, version=1)

如果我不带参数地调用脚本，docopt将显示使用部分：

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

我必须显式地设置--help参数以查看完整的帮助：

$ python foo.py --help
Naval Fate.

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

Options:
  -h --help     Show this screen.
  --version     Show version.
  --speed=<kn>  Speed in knots [default: 10].
  --moored      Moored (anchored) mine.
  --drifting    Drifting mine.

python

docopt

回答 3

Stack Overflow用户

回答已采纳

发布于 2015-07-17 15:32:03

捕获DocoptExit应该是可行的。如下所示：

"""
Naval Fate.

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

Options:
  -h --help     Show this screen.
  --version     Show version.
  --speed=<kn>  Speed in knots [default: 10].
  --moored      Moored (anchored) mine.
  --drifting    Drifting mine.
"""

from docopt import docopt, DocoptExit
try:
    arguments = docopt(__doc__, version=1)
except DocoptExit:
    print __doc__

票数 3

Stack Overflow用户

发布于 2018-03-21 22:32:25

我总是绞尽脑汁，想知道为什么这不是默认的行为，并最终为这个问题打开了一个bug：

https://github.com/docopt/docopt/issues/410

看看附加的是什么..。

票数 0

Stack Overflow用户

发布于 2018-08-14 20:53:54

另一个与J.P.Petersen的答案一样有效的选择是：

import sys

# ...

if len(sys.argv) == 1: # i.e just the program name
    sys.argv.append('-h')

arguments = docopt(__doc__, version=1)

现在，当您运行python foo.py时，您将得到完整的帮助屏幕。

票数 0

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/31457804

复制

相似问题

问使用没有-h的docopt显示完整的docstring
EN

回答 3

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问使用没有-h的docopt显示完整的docstringEN

回答 3

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问使用没有-h的docopt显示完整的docstring
EN