python - python 中的 docopt 给我带来了问题

Question

我有一组三个程序，我想将它们组合成一个。他们都单独工作，但我在尝试让他们一起工作时遇到了问题。我目前遇到的问题是代码的第一部分:

import os
import sys
from contextlib import closing

import colorama  # $ pip install colorama
import docopt  # $ pip install docopt
import socks  # $ pip install PySocks
import stem.process  # $ pip install stem
from sockshandler import SocksiPyHandler  # see pysocks repository
from stem.util import term

try:
    import urllib2
except ImportError: # Python 3
    import urllib.request as urllib2

args = docopt.docopt(__doc__, version='0.2')
colorama.init(strip=not (sys.stdout.isatty() or args['--color']))

当我运行该程序时，出现此错误:

Traceback (most recent call last):
  File "cilantro.py", line 34, in <module>
    args = docopt.docopt(__doc__, version='0.2')
  File "C:\Python34\lib\site-packages\docopt.py", line 558, in docopt
    DocoptExit.usage = printable_usage(doc)
  File "C:\Python34\lib\site-packages\docopt.py", line 468, in printable_usage
    raise DocoptLanguageError('"usage:" (case-insensitive) not found.')
docopt.DocoptLanguageError: "usage:" (case-insensitive) not found.

为什么我会收到此错误消息？相同的代码在原始程序中运行良好。

Answer 1

当使用 docopt 时，您需要为您的脚本编写一个 __doc__ 字符串。 docopt 解析此字符串以计算出如何处理命令行选项和参数。

要解决此问题，以及类似于“导入操作系统”上方的以下文本(因此它是文件中的第一件事):

"""
Name.
Describe what this script does

Usage:
 name <firstarg>
 name --countdown
 name sillycommand <SILLYNESS>
 name -h | --help

Options:
  --countdown  display a count down
"""

可以在 docopt 文档 http://docopt.org/ 中找到有关在该用法字符串中放置什么内容的更多详细信息