Question

如the docs中所述，optparse.OptionParser使用IndentedHelpFormatter输出格式化的选项帮助，我发现了一些API documentation。

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

澄清

最好只使用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来获得正确的间距。然后我用newlines加入它们，并将其附加到传递给OptionParser的'usage'字符串。

它看起来很好，但感觉很愚蠢，当然文档最终出现在选项列表上方。我没有找到任何方法，或者如何做任何复杂的事情，即在位置arg的描述下面描述了一组给定的选项，因为它们只适用于那个arg。

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

Answer 4

位置参数的大多数帮助文本类似于* NIX框的手册页中经常使用的格式。看看how the 'cp' command is documented。您的帮助文本应该类似于此。

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

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

澄清

4 个答案: