Python 显示完整的docstring，其中docopt不带-h

我试图用

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)

我必须显式设置

--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 foo.py--帮助
海军命运。
用法：
海军命运号新。。。
海军舰艇移动[--速度=]
海军舰艇射击
海军命运水雷（设置|移除）[--系泊|--漂移]
海军的命运——h——救命
海军命运版
选项：
-h--帮助显示此屏幕。
--版本显示版本。
--速度=以节为单位的速度[默认值：10]。
--停泊（锚定）的矿井。
--漂流矿。

捕获

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__

“”“
海军命运。
用法：
海军命运号新。。。
海军舰艇移动[--速度=]
海军舰艇射击
海军命运水雷（设置|移除）[--系泊|--漂移]
海军的命运——h——救命
海军命运版
选项：
-h--帮助显示此屏幕。
--版本显示版本。
--速度=以节为单位的速度[默认值：10]。
--停泊（锚定）的矿井。
--漂流矿。
"""
从docopt导入docopt、DocoptExit
尝试：
参数=docopt（\uuuuu doc\uuuuuu，版本=1）
除DocoptExit外：
打印文件__

我总是挠头想知道为什么这不是默认行为，最后打开了一个问题的bug：

---

让我们看看附加了什么

另一个与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

时，您将获得完整的帮助屏幕

import sys

# ...

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

arguments = docopt(__doc__, version=1)