对论证的适当帮助

Question

当脚本使用是这样的时候，Python optparse 工作得很好

%prog [options] [args]

但是我需要为带有 1 个必需参数的脚本编写帮助，所以用法将像这样

%prog action [options] [args]

当你使用 Subversion 时你可以看到类似的东西 - 它的使用字符串是

svn <subcommand> [options] [args]

所以我的问题是：是否可以以 Subversion 的方式使用 optparse 为所需参数准备帮助？结果我想看到这样的帮助：

Usage: python myscript.py action [options] [args]

Available actions:
  foo
  bar

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -v, --verbose         Verbose mode. Output debug log to stdout.

Answer 1

我认为对您来说一个很好的解决方案是 argparse，它已建议包含在 Python 2.7 和 3.2 中。我相信它可以处理子命令，并且链接的页面包含一个指向从 optparse 移植代码的页面的链接。

另请参阅问题 command-line-arguments-in-python，有人编辑了该问题似乎包含与您想要的完全相同的内容的参考列表：

Answer 2

是的。您可以像这样设置用法字符串：

usage = "%prog action [options] [args]"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",
                  action="store_true", dest="verbose", default=True,
                  help="make lots of noise [default]")

打印以下内容：

Usage:  action [options] [args]

Options:
  -h, --help     show this help message and exit
  -v, --verbose  make lots of noise [default]

这是几乎逐字复制自 文档。

编辑：

根据您的评论，您可以使用描述来实现类似的功能，但不能在其中添加换行符。

parser.description = 'Available actions: foo, bar'

看起来像这样：

Usage:  action [options] [args]

Available actions: foo, bar

Options:
  -h, --help     show this help message and exit
  -v, --verbose  make lots of noise [default]

Answer 3

我也遇到了这个问题。我的解决方案是在列表或元组中声明命令，将它们格式化为 OptionParser 的 usage 参数，然后使用解析器提供的参数列表来确定是否提供了命令，因为从技术上讲它必须是args[0]。例如：

self.commands = ('foo', 'bar' ...)
self.parser = <initialized instance of OptionParser>
(self.options, self.args) = parser.parse_args()

if len(self.args) == 0:
   self.parser.error("Command required")

self.command = self.args[0]
if not self.command in self.commands:
   self.parser.error("Command not recognized")

#... etc

这会给你一个看起来像 Subversion 的命令系统，但不可否认 optparse 可能会更好。我听说 argparse 模块应该将其纳入 stdlib，但由于 2.7 是 2 系列版本中的最后一个，我想您必须等待它被合并到 3 系列中.x。当然，您可以只安装 argparse，但在某些情况下这会很麻烦。