Question

我一直在尝试使用docopt来创建一个简单的CLI，但由于某些原因，我的默认参数没有出现。下面是我的测试代码。我正在使用github存储库中的最新版docopt.py。

"""
Usage:  scrappy <path> ... [options]

-a --auto           Automatically scrape and rename without user interaction.
-l --lang           Specify language code [default: en].
--scan-individual   Evaluate series information individually for each file.
-c --cfg            User alternate config file [default: ../scrappy.conf]
-t --test           Test run.  Do not modify files.
-v --verbose        Print verbose output
"""

from docopt import docopt
arguments = docopt(__doc__, version='0.1.0 alpha')
print arguments  # DEBUG

这是我运行$ scrappy/scrappy.py first_path_parameter second/path/parameter

时的输出

{'--auto': None,
 '--cfg': None,
 '--lang': None,
 '--scan-individual': None,
 '--test': None,
 '--verbose': None,
 '<path>': ['first_path_parameter', 'second/path/parameter']}

有人知道发生了什么事吗？

修改

我更新了我的代码，但我仍然得到类似的输出。更重要的是，当我尝试传递--scan-individual时，我得到一个错误，根据它需要一个参数。再次，如果它很重要，我正在运行docopt，只需将docopt.py复制到我项目的工作目录中。发生了什么事，在这里？

#!/usr/bin/env python

"""Scrappy:  Rename media files based on scraped information.

Usage:  scrappy <path> ... [options]

-a --auto               Automatically scrape and rename without user interaction.
-l LANG --lang LANG     Specify language code [default: en].
--scan-individual       Evaluate series information individually for each file.
-c CONF --cfg CONF      User alternate config file [default: ../scrappy.conf]
-t --test               Test run.  Do not modify files.
-v --verbose            Print verbose output
"""

from docopt import docopt
arguments = docopt(__doc__, version='0.1.0 alpha')
print arguments  # DEBUG

输出：

$ scrappy/scrappy.py first_path_parameter second/path/parameter --scan-individual
--scan-individual requires argument
Usage:  scrappy <path> ... [options]

Answer 1

通过查看示例，似乎如果要传递默认值，则可能必须指定目标变量，例如。

naval_fate.py:  --speed=<kn>  Speed in knots [default: 10].
options_example.py-  --exclude=PATTERNS   exclude files or directories which match these comma
options_example.py:                       separated patterns [default: .svn,CVS,.bzr,.hg,.git]
options_example.py-  -f NAME --file=NAME  when parsing directories, only check filenames matching
options_example.py:                       these comma separated patterns [default: *.py]

所以在你的情况下，

-l LANG --lang LANG  Specify language code [default: en].
-c CONFIG            User alternate config file [default: ../scrappy.conf]

产生

localhost-2:coding $ python doc.py --auto a b c
{'--auto': True,
 '--lang': 'en',
 '--scan-individual': False,
 '--test': False,
 '--verbose': False,
 '-c': '../scrappy.conf',
 '<path>': ['a', 'b', 'c']}

编辑：OP发布的更新代码对我来说很合适，我在大约半小时前下载了github版本：

localhost-2:coding $ ./scrappy.py first_path_parameter second/path/parameter --scan-individual
{'--auto': False,
 '--cfg': '../scrappy.conf',
 '--lang': 'en',
 '--scan-individual': True,
 '--test': False,
 '--verbose': False,
 '<path>': ['first_path_parameter', 'second/path/parameter']}

所以我不知所措。

Answer 2

我刚刚在自己的代码中遇到过这个问题并进行了测试（使用hargriffle和DSM中的其他答案），直到我发现了以下内容。

请注意，这是docopt 0.6.1

运行此文件时：

#! /usr/bin/env python
"""scans.py

Usage:
  scans.py [<args>...]

Options:
  -h --help           Show this screen.
  --version           Show version.
  -L INT --limit=INT  Query response row limit [default: 10]

"""

from docopt import docopt

if __name__ == '__main__':
    print docopt(__doc__)

我收到以下输出

{'<args>': []}

但是，如果我特意写入，则参数在使用行中是可选的，如下所示：

Usage:
  scans.py [-L INT | --limit=INT] [<args>...]

我收到了我希望的内容：

{'--limit': '10',
 '<args>': []}

Answer 3

我刚遇到同样的问题 - 我在阅读了@DSM和@blz的最后两条评论之后才解决了这个问题。

重申，因为它可能有助于其他人，要解析默认变量，你必须确保选项的变量末尾和文本描述之间至少有两个空格。选项。

来自docs：

使用两个空格将选项与其非正式描述分开：

--verbose More text.   # BAD, will be treated as if verbose option had
                   # an argument "More", so use 2 spaces instead
-q        Quit.        # GOOD
-o FILE   Output file. # GOOD
--stdout  Use stdout.  # GOOD, 2 spaces

因此，如果没有两个空格，选项解析器会将描述文本解释为变量，而不会处理[default: ...]部分。

Answer 4

与我同样的问题。

在我的特定情况下，我注意到doc-opt对以制表符开头的行与以空格开头的行

敏感

#!/usr/bin/env python
"""Sample Application.

Usage:
    sample [options] me
    sample --version

Options:
  --host HOST     words here  [default: 5]
  --version  Version identifier

"""

VS

#!/usr/bin/env python
"""Sample Application.

Usage:
    sample [options] me
    sample --version

Options:
    --host HOST     words here  [default: 5]
    --version  Version identifier

"""

在选项：列表中的--host和--version之前有一个选项卡。第二种情况没有正确解析默认值，第一种情况没有用于初始缩进的空格。

为什么默认值没有出现在docopt的命令行参数字典中？

4 个答案: