Объяснение поведения модуля argparse python: откуда берутся заглавные буквы? - PullRequest
4 голосов
/ 18 июля 2011

Я пытаюсь написать интерфейс командной строки (в первый раз), и после прочтения о argparse, optparse и getopt я выбрал argparse из-за нескольких рекомендаций здесь по SO и, кроме того, всеть.Адаптируя немного совета мистера ван Россума , я подключил свой первый интерфейс командной строки так:

def main(argv=None):
    if argv is None:
        argv = sys.argv
    desc = u'some description'
    parser = argparse.ArgumentParser(description=desc)

    parser.add_argument('-s', '--search', help='Search for someone.')
    parser.add_argument('-c', '--do_something_else', help='Do something else.')

    args = parser.parse_args()
    print args

if __name__ == '__main__':
    sys.exit(main())

Выполнение python myscript.py -h приводит к:

usage: dblp.py [-h] [-s SEARCH] [-c DO_SOMETHING_ELSE]

some description

optional arguments:
  -h, --help            show this help message and exit
  -s SEARCH, --search SEARCH
                        Search for someone.
  -c DO_SOMETHING_ELSE, --do_something_else DO_SOMETHING_ELSE
                        Do something else.

Итак, мой первый вопрос: Почему SEARCH и DO_SOMETHING_ELSE написаны ЗАГЛАВНЫМИ БУКВАМИ? Второй вопрос: нарушу ли я какие-либо стандарты? Есть ли лучший способ (или хороший пример из реального мира, из которого я могу поучиться), как создавать чистые и полезные интерфейсы командной строки с python? И есть ли подводных камней , которых следует избегать, когдаписать интерфейсы cmd?

Ответы [ 2 ]

7 голосов
/ 18 июля 2011

Заглавные буквы являются просто значениями-заполнителями; они взяты из пункта назначения. Вы можете указать альтернативные заполнители через metavar= параметр add_argument:

http://docs.python.org/dev/library/argparse.html#metavar

2 голосов
/ 18 июля 2011

Вот пара основных ресурсов argparse, которые я выкопал:

Некоторые слайды по argparse: http://www.slideshare.net/tisto/argparse-python-command-line-parser

Небольшой пример argparse: http://www.rutherfurd.net/tag/argparse/

реальный пример argparse: https://github.com/harijay/xtaltools/blob/e683fcef6a5ad7394b87382e58d4dce32a85585b/maskconvert.py

Чтобы избежать ловушек, вот приятная оболочка для argparse для сокращения стандартного кода, который вы должны написать для некоторых распространенных случаев: http://travelingfrontiers.wordpress.com/2010/11/03/simple-python-argparse-wrapper/

...