如何使用 Python 的 optparse 格式化位置参数帮助？

Question

正如文档中提到的optparse.OptionParser 使用 IndentedHelpFormatter 输出格式化的选项帮助，为此我找到了一些API 文档。

我想在使用文本中显示所需位置参数的类似格式的帮助文本。 是否有适配器或简单的使用模式可用于类似的位置参数格式？

说明

最好仅使用 stdlib。 Optparse 做得很好，除了这个格式上的细微差别，我觉得我们应该能够在不导入整个其他包的情况下修复它。 :-)

Answer 1

最好的选择是为 optparse 模块编写补丁。 同时，您可以通过稍微修改的 OptionParser 类来完成此操作。 这并不完美，但它会完成你想要的事情。

#!/usr/bin/env python
from optparse import OptionParser, Option, IndentedHelpFormatter

class PosOptionParser(OptionParser):
    def format_help(self, formatter=None):
        class Positional(object):
            def __init__(self, args):
                self.option_groups = []
                self.option_list = args

        positional = Positional(self.positional)
        formatter = IndentedHelpFormatter()
        formatter.store_option_strings(positional)
        output = ['\n', formatter.format_heading("Positional Arguments")]
        formatter.indent()
        pos_help = [formatter.format_option(opt) for opt in self.positional]
        pos_help = [line.replace('--','') for line in pos_help]
        output += pos_help
        return OptionParser.format_help(self, formatter) + ''.join(output)

    def add_positional_argument(self, option):
        try:
            args = self.positional
        except AttributeError:
            args = []
        args.append(option)
        self.positional = args

    def set_out(self, out):
        self.out = out
def main():
    usage = "usage: %prog [options] bar baz"
    parser = PosOptionParser(usage)
    parser.add_option('-f', '--foo', dest='foo',
                      help='Enable foo')
    parser.add_positional_argument(Option('--bar', action='store_true',
                                   help='The bar positional argument'))
    parser.add_positional_argument(Option('--baz', action='store_true',
                                   help='The baz positional argument'))
    (options, args) = parser.parse_args()
    if len(args) != 2:
        parser.error("incorrect number of arguments")
    pass

if __name__ == '__main__':
    main()

运行此命令得到的输出：

Usage: test.py [options] bar baz

  Options:
    -h, --help         show this help message and exit
    -f FOO, --foo=FOO  Enable foo

Positional Arguments:
  bar  The bar positional argument
  baz  The baz positional argument

Answer 2

尝试查看 argparse。 文档称它支持位置参数和更美观的帮助消息。

Answer 3

我对一个干净的解决方案感兴趣； 我想不出一个。 OptionParser 实际上完全专注于选项； 据我所知，它没有给你任何与位置参数相关的信息。

我所做的是为每个位置参数生成一个小文档块列表，使用 \t 来获得正确的间距。 然后我用换行符将它们连接起来，并将其附加到传递给 OptionParser 的“usage”字符串中。

它看起来不错，但感觉很愚蠢，当然该文档最终出现在选项列表上方。 我还没有找到解决这个问题的任何方法，或者如何做任何复杂的事情，即在位置参数的描述下方描述了一组给定的选项，因为它们仅适用于该参数。

我查看了猴子修补 OptionParser 的方法，我记得（这是大约一年前）它不会那么困难，但我不想走那条路。

Answer 4

大多数位置参数的帮助文本类似于 *NIX 框手册页中常用的格式。 查看如何记录“cp”命令。 您的帮助文本应该与此类似。

否则，只要您在使用解析器时填写“help”参数，文档就应该自行生成。