Как форматировать позиционный аргумент с помощью Python optparse?

Как упоминалось в в документах, optparse.OptionParser использует IndentedHelpFormatter для вывода форматированной опции help, для которой я нашел некоторую документация API.

Я хочу отобразить аналогично отформатированный текст справки для требуемых позиционных аргументов в тексте использования. Существует ли адаптер или простой шаблон использования, который можно использовать для аналогичного форматирования позиционных аргументов?

Разъяснение

Предпочтительно использовать только stdlib. Optparse отлично справляется с этим, кроме этого одного форматирующего нюанса, который, как мне кажется, мы можем исправить, не импортируя целые другие пакеты.: -)

ОТВЕТЫ

Ответ 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

Ответ 2

Попробуйте взглянуть на argparse. Документация говорит, что он поддерживает аргументы позиции и более приятные поисковые сообщения.

Ответ 3

Меня бы интересовало чистое решение этого; Я не смог придумать это. OptionParser действительно полностью фокусируется на опциях; это не дает вам ничего, чтобы работать с позициями args, насколько я смог найти.

Я сделал, чтобы создать список небольших блоков документации для каждого из моих позиционных аргументов, используя \t, чтобы получить правильный интервал. Затем я присоединился к ним с новыми строками и добавил это к строке "use", которая передается в OptionParser.

Это выглядит хорошо, но это кажется глупым, и, конечно же, документация заканчивается выше списка опций. Я не нашел никакого способа обойти это или как сделать какой-либо сложный материал, т.е. Данный набор параметров описывается ниже описания для позиционного arg, потому что они применимы только к этому аргументу.

Я просмотрел методы OptionParser для обезьян-патчей, и я помню (это было год назад), что это было бы не так сложно, но я не хотел идти по этому пути.

Ответ 4

Большинство текстов справки для позиционных аргументов напоминают формат, часто используемый в man-страницах для * NIX-боксов. Взгляните на как документируется команда 'cp'. Текст вашей помощи должен напоминать это.

В противном случае, пока вы заполняете аргумент "help" при использовании анализатора, документация должна выдавать себя.