`argparse.md`

1638 строк · 116.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/argparse.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 16.4. [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) – Парсер для параметров командной строки, аргументов и подкоманд89Новое в версии 3.2.1011**Исходный код:** [Lib/argparse.py](https://python-all.ru/src/3.6/Lib/argparse.py)1213---1415Учебное пособие1617На этой странице содержится справочная информация по API. Для более плавного введения в разбор командной строки Python обратитесь к [учебному пособию по argparse](https://python-all.ru/3.6/howto/argparse.html#id1).1819Модуль [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) упрощает создание удобных интерфейсов командной строки. Программа определяет, какие аргументы ей нужны, а [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) сам решает, как извлечь их из [`sys.argv`](https://python-all.ru/3.6/library/sys.html#sys.argv). Модуль [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) также автоматически формирует сообщения справки и подсказки по использованию и выводит ошибки, когда пользователь передаёт программе неверные аргументы.2021## 16.4.1. Пример2223Следующий код представляет собой программу на Python, которая принимает список целых чисел и выводит либо сумму, либо максимум:2425```python26import argparse2728parser = argparse.ArgumentParser(description='Process some integers.')29parser.add_argument('integers', metavar='N', type=int, nargs='+',30                    help='an integer for the accumulator')31parser.add_argument('--sum', dest='accumulate', action='store_const',32                    const=sum, default=max,33                    help='sum the integers (default: find the max)')3435args = parser.parse_args()36print(args.accumulate(args.integers))37```3839Если приведенный выше код Python сохранен в файл `prog.py`, его можно запустить из командной строки, и он выдаст полезные сообщения справки:4041```console42$ python prog.py -h43usage: prog.py [-h] [--sum] N [N ...]4445Process some integers.4647positional arguments:48 N           an integer for the accumulator4950optional arguments:51 -h, --help  show this help message and exit52 --sum       sum the integers (default: find the max)53```5455При запуске с соответствующими аргументами программа выводит либо сумму, либо максимум переданных целых чисел:5657```console58$ python prog.py 1 2 3 45946061$ python prog.py 1 2 3 4 --sum621063```6465Если передать неверные аргументы, будет выдана ошибка:6667```console68$ python prog.py a b c69usage: prog.py [-h] [--sum] N [N ...]70prog.py: error: argument N: invalid int value: 'a'71```7273В следующих разделах этот пример разбирается подробно.7475### 16.4.1.1. Создание парсера7677Первый шаг при использовании [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) – создание объекта [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser):7879```python80>>> parser = argparse.ArgumentParser(description='Process some integers.')81```8283Объект [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) будет содержать всю информацию, необходимую для разбора командной строки в типы данных Python.8485### 16.4.1.2. Добавление аргументов8687Заполнение объекта [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) информацией об аргументах программы выполняется вызовами метода [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument). В общем случае эти вызовы сообщают [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser), как преобразовывать строки командной строки в объекты. Эта информация сохраняется и используется при вызове [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args). Например:8889```python90>>> parser.add_argument('integers', metavar='N', type=int, nargs='+',91...                     help='an integer for the accumulator')92>>> parser.add_argument('--sum', dest='accumulate', action='store_const',93...                     const=sum, default=max,94...                     help='sum the integers (default: find the max)')95```9697Впоследствии вызов [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) вернет объект с двумя атрибутами: `integers` и `accumulate`. Атрибут `integers` будет списком из одного или нескольких целых чисел, а атрибут `accumulate` будет либо функцией [`sum()`](https://python-all.ru/3.6/library/functions.html#sum), если в командной строке был указан `--sum`, либо функцией [`max()`](https://python-all.ru/3.6/library/functions.html#max), если нет.9899### 16.4.1.3. Разбор аргументов100101[`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) разбирает аргументы с помощью метода [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args). Этот метод проверяет командную строку, преобразует каждый аргумент в соответствующий тип и затем выполняет необходимое действие. В большинстве случаев это означает, что простой объект [`Namespace`](https://python-all.ru/3.6/library/argparse.html#argparse.Namespace) будет составлен из атрибутов, полученных при разборе командной строки:102103```python104>>> parser.parse_args(['--sum', '7', '-1', '42'])105Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])106```107108В скрипте [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) обычно вызывается без аргументов, и [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) автоматически определяет аргументы командной строки из [`sys.argv`](https://python-all.ru/3.6/library/sys.html#sys.argv).109110## 16.4.2. Объекты ArgumentParser111112#### `class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)`113114Создаёт новый объект [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser). Все параметры должны передаваться как именованные аргументы. Каждый параметр имеет собственное подробное описание ниже, но вкратце они таковы:115116- [prog](https://python-all.ru/3.6/library/argparse.html#prog) – имя программы (по умолчанию: `sys.argv[0]`)117- [usage](https://python-all.ru/3.6/library/argparse.html#usage) - строка, описывающая использование программы (по умолчанию генерируется из аргументов, добавленных в парсер)118- [description](https://python-all.ru/3.6/library/argparse.html#description) – текст, отображаемый перед справкой по аргументам (по умолчанию: нет)119- [epilog](https://python-all.ru/3.6/library/argparse.html#epilog) – текст, отображаемый после справки по аргументам (по умолчанию: нет)120- [parents](https://python-all.ru/3.6/library/argparse.html#parents) - список объектов [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser), аргументы которых также должны быть включены121- [formatter\_class](https://python-all.ru/3.6/library/argparse.html#formatter-class) - класс для настройки вывода справки122- [prefix\_chars](https://python-all.ru/3.6/library/argparse.html#prefix-chars) - набор символов, которые являются префиксом необязательных аргументов (по умолчанию: ‘-‘)123- [fromfile\_prefix\_chars](https://python-all.ru/3.6/library/argparse.html#fromfile-prefix-chars) - набор символов, которые являются префиксом файлов, из которых должны читаться дополнительные аргументы (по умолчанию: `None`)124- [argument\_default](https://python-all.ru/3.6/library/argparse.html#argument-default) - глобальное значение по умолчанию для аргументов (по умолчанию: `None`)125- [conflict\_handler](https://python-all.ru/3.6/library/argparse.html#conflict-handler) - стратегия разрешения конфликтов необязательных аргументов (обычно не требуется)126- [add\_help](https://python-all.ru/3.6/library/argparse.html#add-help) - добавить опцию `-h/--help` в парсер (по умолчанию: `True`)127- [allow\_abbrev](https://python-all.ru/3.6/library/argparse.html#allow-abbrev) – позволяет сокращать длинные параметры, если сокращение однозначно. (по умолчанию: `True`)128129Изменено в версии 3.5: *allow\_abbrev* – добавлен параметр.130131В следующих разделах описывается, как используется каждый из этих параметров.132133### 16.4.2.1. prog134135По умолчанию объекты [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) используют `sys.argv[0]`, чтобы определить, как отображать имя программы в справке. Это поведение почти всегда желательно, поскольку справка будет соответствовать тому, как программа была вызвана из командной строки. Например, рассмотрим файл с именем `myprogram.py` со следующим кодом:136137```python138import argparse139parser = argparse.ArgumentParser()140parser.add_argument('--foo', help='foo help')141args = parser.parse_args()142```143144Справка этой программы будет отображать `myprogram.py` в качестве имени программы (независимо от того, откуда была вызвана программа):145146```console147$ python myprogram.py --help148usage: myprogram.py [-h] [--foo FOO]149150optional arguments:151 -h, --help  show this help message and exit152 --foo FOO   foo help153$ cd ..154$ python subdir/myprogram.py --help155usage: myprogram.py [-h] [--foo FOO]156157optional arguments:158 -h, --help  show this help message and exit159 --foo FOO   foo help160```161162Чтобы изменить это поведение по умолчанию, можно указать другое значение с помощью аргумента `prog=` конструктора [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser):163164```python165>>> parser = argparse.ArgumentParser(prog='myprogram')166>>> parser.print_help()167usage: myprogram [-h]168169optional arguments:170 -h, --help  show this help message and exit171```172173Обратите внимание, что имя программы, будь оно определено из `sys.argv[0]` или из аргумента `prog=`, доступно в справочных сообщениях через форматный спецификатор `%(prog)s`.174175```python176>>> parser = argparse.ArgumentParser(prog='myprogram')177>>> parser.add_argument('--foo', help='foo of the %(prog)s program')178>>> parser.print_help()179usage: myprogram [-h] [--foo FOO]180181optional arguments:182 -h, --help  show this help message and exit183 --foo FOO   foo of the myprogram program184```185186### 16.4.2.2. usage187188По умолчанию [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) формирует сообщение об использовании на основе своих аргументов:189190```python191>>> parser = argparse.ArgumentParser(prog='PROG')192>>> parser.add_argument('--foo', nargs='?', help='foo help')193>>> parser.add_argument('bar', nargs='+', help='bar help')194>>> parser.print_help()195usage: PROG [-h] [--foo [FOO]] bar [bar ...]196197positional arguments:198 bar          bar help199200optional arguments:201 -h, --help   show this help message and exit202 --foo [FOO]  foo help203```204205Сообщение по умолчанию можно переопределить с помощью именованного аргумента `usage=`:206207```python208>>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]')209>>> parser.add_argument('--foo', nargs='?', help='foo help')210>>> parser.add_argument('bar', nargs='+', help='bar help')211>>> parser.print_help()212usage: PROG [options]213214positional arguments:215 bar          bar help216217optional arguments:218 -h, --help   show this help message and exit219 --foo [FOO]  foo help220```221222Спецификатор формата `%(prog)s` используется для подстановки имени программы в сообщения об использовании.223224### 16.4.2.3. description225226В большинстве вызовов конструктора [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) используется именованный аргумент `description=`. Этот аргумент содержит краткое описание того, что делает программа и как она работает. В сообщениях справки это описание выводится между строкой использования командной строки и справкой по отдельным аргументам:227228```python229>>> parser = argparse.ArgumentParser(description='A foo that bars')230>>> parser.print_help()231usage: argparse.py [-h]232233A foo that bars234235optional arguments:236 -h, --help  show this help message and exit237```238239По умолчанию описание переносится по строкам, чтобы уместиться в отведённом пространстве. Чтобы изменить это поведение, обратитесь к аргументу [formatter\_class](https://python-all.ru/3.6/library/argparse.html#formatter-class).240241### 16.4.2.4. epilog242243Некоторые программы выводят дополнительное описание после описания аргументов. Такой текст можно указать с помощью аргумента `epilog=` для [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser):244245```python246>>> parser = argparse.ArgumentParser(247...     description='A foo that bars',248...     epilog="And that's how you'd foo a bar")249>>> parser.print_help()250usage: argparse.py [-h]251252A foo that bars253254optional arguments:255 -h, --help  show this help message and exit256257And that's how you'd foo a bar258```259260Как и для аргумента [description](https://python-all.ru/3.6/library/argparse.html#description), текст `epilog=` по умолчанию переносится по строкам, но это поведение можно настроить с помощью аргумента [formatter\_class](https://python-all.ru/3.6/library/argparse.html#formatter-class) для [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser).261262### 16.4.2.5. parents263264Иногда несколько парсеров используют общий набор аргументов. Вместо того чтобы повторять определения этих аргументов, можно использовать один парсер со всеми общими аргументами, передав его в аргумент `parents=` для [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser). Аргумент `parents=` принимает список объектов [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser), собирает из них все позиционные и опциональные действия и добавляет эти действия в создаваемый объект [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser):265266```python267>>> parent_parser = argparse.ArgumentParser(add_help=False)268>>> parent_parser.add_argument('--parent', type=int)269270>>> foo_parser = argparse.ArgumentParser(parents=[parent_parser])271>>> foo_parser.add_argument('foo')272>>> foo_parser.parse_args(['--parent', '2', 'XXX'])273Namespace(foo='XXX', parent=2)274275>>> bar_parser = argparse.ArgumentParser(parents=[parent_parser])276>>> bar_parser.add_argument('--bar')277>>> bar_parser.parse_args(['--bar', 'YYY'])278Namespace(bar='YYY', parent=None)279```280281Обратите внимание, что большинство родительских парсеров указывают `add_help=False`. В противном случае [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) увидит две опции `-h/--help` (одну в родительском парсере, другую – в дочернем) и вызовет ошибку.282283> **Примечание**284>285> Парсеры должны быть полностью инициализированы перед передачей через `parents=`. Если изменить родительские парсеры после создания дочернего, эти изменения не отразятся на дочернем парсере.286287### 16.4.2.6. formatter\_class288289Объекты [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) позволяют настраивать форматирование справки, указывая альтернативный класс форматирования. На данный момент существует четыре таких класса:290291#### `class argparse.RawDescriptionHelpFormatter`292293#### `class argparse.RawTextHelpFormatter`294295#### `class argparse.ArgumentDefaultsHelpFormatter`296297#### `class argparse.MetavarTypeHelpFormatter`298299[`RawDescriptionHelpFormatter`](https://python-all.ru/3.6/library/argparse.html#argparse.RawDescriptionHelpFormatter) и [`RawTextHelpFormatter`](https://python-all.ru/3.6/library/argparse.html#argparse.RawTextHelpFormatter) дают больше контроля над отображением текстовых описаний. По умолчанию объекты [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) переносят текст [description](https://python-all.ru/3.6/library/argparse.html#description) и [epilog](https://python-all.ru/3.6/library/argparse.html#epilog) в сообщениях справки командной строки:300301```python302>>> parser = argparse.ArgumentParser(303...     prog='PROG',304...     description='''this description305...         was indented weird306...             but that is okay''',307...     epilog='''308...             likewise for this epilog whose whitespace will309...         be cleaned up and whose words will be wrapped310...         across a couple lines''')311>>> parser.print_help()312usage: PROG [-h]313314this description was indented weird but that is okay315316optional arguments:317 -h, --help  show this help message and exit318319likewise for this epilog whose whitespace will be cleaned up and whose words320will be wrapped across a couple lines321```322323Передача [`RawDescriptionHelpFormatter`](https://python-all.ru/3.6/library/argparse.html#argparse.RawDescriptionHelpFormatter) в качестве `formatter_class=` означает, что [description](https://python-all.ru/3.6/library/argparse.html#description) и [epilog](https://python-all.ru/3.6/library/argparse.html#epilog) уже правильно отформатированы и не должны переноситься по строкам:324325```python326>>> parser = argparse.ArgumentParser(327...     prog='PROG',328...     formatter_class=argparse.RawDescriptionHelpFormatter,329...     description=textwrap.dedent('''\330...         Please do not mess up this text!331...         --------------------------------332...             I have indented it333...             exactly the way334...             I want it335...         '''))336>>> parser.print_help()337usage: PROG [-h]338339Please do not mess up this text!340--------------------------------341   I have indented it342   exactly the way343   I want it344345optional arguments:346 -h, --help  show this help message and exit347```348349[`RawTextHelpFormatter`](https://python-all.ru/3.6/library/argparse.html#argparse.RawTextHelpFormatter) сохраняет пробелы во всех видах текста справки, включая описания аргументов. Однако множественные переносы строк заменяются одним. Если нужно сохранить несколько пустых строк, добавьте пробелы между переносами.350351[`ArgumentDefaultsHelpFormatter`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentDefaultsHelpFormatter) автоматически добавляет информацию о значениях по умолчанию в сообщения справки каждого аргумента:352353```python354>>> parser = argparse.ArgumentParser(355...     prog='PROG',356...     formatter_class=argparse.ArgumentDefaultsHelpFormatter)357>>> parser.add_argument('--foo', type=int, default=42, help='FOO!')358>>> parser.add_argument('bar', nargs='*', default=[1, 2, 3], help='BAR!')359>>> parser.print_help()360usage: PROG [-h] [--foo FOO] [bar [bar ...]]361362positional arguments:363 bar         BAR! (default: [1, 2, 3])364365optional arguments:366 -h, --help  show this help message and exit367 --foo FOO   FOO! (default: 42)368```369370[`MetavarTypeHelpFormatter`](https://python-all.ru/3.6/library/argparse.html#argparse.MetavarTypeHelpFormatter) использует имя аргумента [type](https://python-all.ru/3.6/library/argparse.html#type) для каждого аргумента в качестве отображаемого имени для его значений (вместо [dest](https://python-all.ru/3.6/library/argparse.html#dest), как это делает обычный форматировщик):371372```python373>>> parser = argparse.ArgumentParser(374...     prog='PROG',375...     formatter_class=argparse.MetavarTypeHelpFormatter)376>>> parser.add_argument('--foo', type=int)377>>> parser.add_argument('bar', type=float)378>>> parser.print_help()379usage: PROG [-h] [--foo int] float380381positional arguments:382  float383384optional arguments:385  -h, --help  show this help message and exit386  --foo int387```388389### 16.4.2.7. prefix\_chars390391Большинство параметров командной строки используют `-` в качестве префикса, например `-f/--foo`. Парсеры, которым нужно поддерживать другие или дополнительные символы префикса, например для параметров вроде `+f` или `/foo`, могут указать их с помощью аргумента `prefix_chars=` конструктора ArgumentParser:392393```python394>>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='-+')395>>> parser.add_argument('+f')396>>> parser.add_argument('++bar')397>>> parser.parse_args('+f X ++bar Y'.split())398Namespace(bar='Y', f='X')399```400401Аргумент `prefix_chars=` по умолчанию равен `'-'`. Если указать набор символов, не включающий `-`, то опции `-f/--foo` будут запрещены.402403### 16.4.2.8. fromfile\_prefix\_chars404405Иногда, например при работе с особенно длинными списками аргументов, имеет смысл хранить список аргументов в файле, а не набирать его в командной строке. Если аргумент `fromfile_prefix_chars=` передан конструктору [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser), то аргументы, начинающиеся с любого из указанных символов, будут рассматриваться как файлы и заменяться на содержащиеся в них аргументы. Например:406407```python408>>> with open('args.txt', 'w') as fp:409...     fp.write('-f\nbar')410>>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@')411>>> parser.add_argument('-f')412>>> parser.parse_args(['-f', 'foo', '@args.txt'])413Namespace(f='bar')414```415416Аргументы, читаемые из файла, по умолчанию должны быть по одному на строку (но см. также [`convert_arg_line_to_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.convert_arg_line_to_args)) и обрабатываются так, как если бы они находились на том же месте, что и исходный файл, ссылающийся на аргумент в командной строке. Таким образом, в приведённом примере выражение `['-f', 'foo', '@args.txt']` считается эквивалентным выражению `['-f', 'foo', '-f', 'bar']`.417418Аргумент `fromfile_prefix_chars=` по умолчанию равен `None`, что означает, что аргументы никогда не будут рассматриваться как ссылки на файлы.419420### 16.4.2.9. argument\_default421422Обычно значения аргументов по умолчанию задаются либо передачей значения по умолчанию в [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument), либо вызовом методов [`set_defaults()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.set_defaults) с определённым набором пар имя-значение. Однако иногда может быть полезно указать единое значение по умолчанию для всех аргументов синтаксического анализатора. Это можно сделать, передав именованный аргумент `argument_default=` в [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser). Например, чтобы глобально отключить создание атрибутов при вызовах [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args), укажите `argument_default=SUPPRESS`:423424```python425>>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS)426>>> parser.add_argument('--foo')427>>> parser.add_argument('bar', nargs='?')428>>> parser.parse_args(['--foo', '1', 'BAR'])429Namespace(bar='BAR', foo='1')430>>> parser.parse_args([])431Namespace()432```433434### 16.4.2.10. allow\_abbrev435436Обычно при передаче списка аргументов методу [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) объекта [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) он [распознаёт сокращения](https://python-all.ru/3.6/library/argparse.html#prefix-matching) длинных опций.437438Эту возможность можно отключить, установив `allow_abbrev` в `False`:439440```python441>>> parser = argparse.ArgumentParser(prog='PROG', allow_abbrev=False)442>>> parser.add_argument('--foobar', action='store_true')443>>> parser.add_argument('--foonley', action='store_false')444>>> parser.parse_args(['--foon'])445usage: PROG [-h] [--foobar] [--foonley]446PROG: error: unrecognized arguments: --foon447```448449Новое в версии 3.5.450451### 16.4.2.11. conflict\_handler452453Объекты [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) не допускают два действия с одной и той же строкой опции. По умолчанию объекты [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) вызывают исключение при попытке создать аргумент со строкой опции, которая уже используется:454455```python456>>> parser = argparse.ArgumentParser(prog='PROG')457>>> parser.add_argument('-f', '--foo', help='old foo help')458>>> parser.add_argument('--foo', help='new foo help')459Traceback (most recent call last):460 ..461ArgumentError: argument --foo: conflicting option string(s): --foo462```463464Иногда (например, при использовании [parents](https://python-all.ru/3.6/library/argparse.html#parents)) бывает полезно просто переопределить все старые аргументы с той же строкой опции. Для получения такого поведения значение `'resolve'` можно передать в аргумент `conflict_handler=` функции [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser):465466```python467>>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve')468>>> parser.add_argument('-f', '--foo', help='old foo help')469>>> parser.add_argument('--foo', help='new foo help')470>>> parser.print_help()471usage: PROG [-h] [-f FOO] [--foo FOO]472473optional arguments:474 -h, --help  show this help message and exit475 -f FOO      old foo help476 --foo FOO   new foo help477```478479Обратите внимание, что объекты [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) удаляют действие только в том случае, если все его строки опций переопределены. Поэтому в приведённом выше примере старое действие `-f/--foo` сохраняется как действие `-f`, поскольку была переопределена только строка опции `--foo`.480481### 16.4.2.12. add\_help482483По умолчанию объекты ArgumentParser добавляют параметр, который просто показывает справку парсера. Например, рассмотрим файл с именем `myprogram.py`, содержащий следующий код:484485```python486import argparse487parser = argparse.ArgumentParser()488parser.add_argument('--foo', help='foo help')489args = parser.parse_args()490```491492Если указать `-h` или `--help` в командной строке, будет выведена справка ArgumentParser:493494```console495$ python myprogram.py --help496usage: myprogram.py [-h] [--foo FOO]497498optional arguments:499 -h, --help  show this help message and exit500 --foo FOO   foo help501```502503Иногда может быть полезно отключить добавление этой опции справки. Это можно сделать, передав `False` в качестве аргумента `add_help=` функции [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser):504505```python506>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)507>>> parser.add_argument('--foo', help='foo help')508>>> parser.print_help()509usage: PROG [--foo FOO]510511optional arguments:512 --foo FOO  foo help513```514515Обычно опция справки – это `-h/--help`. Исключение составляет случай, когда указан `prefix_chars=` и не включает `-`; в этом случае `-h` и `--help` не являются допустимыми опциями. В таком случае первый символ в `prefix_chars` используется в качестве префикса для опций справки:516517```python518>>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/')519>>> parser.print_help()520usage: PROG [+h]521522optional arguments:523  +h, ++help  show this help message and exit524```525526## 16.4.3. Метод add\_argument()527528#### `ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])`529530Определяет, как должен разбираться один аргумент командной строки. Каждый параметр подробно описан ниже, а кратко они таковы:531532- [name or flags](https://python-all.ru/3.6/library/argparse.html#name-or-flags) – имя или список строк параметров, например `foo` или `-f, --foo`.533- [action](https://python-all.ru/3.6/library/argparse.html#action) – базовый тип действия, которое выполняется при встрече этого аргумента в командной строке.534- [nargs](https://python-all.ru/3.6/library/argparse.html#nargs) – количество аргументов командной строки, которое должно быть потреблено.535- [const](https://python-all.ru/3.6/library/argparse.html#const) – постоянное значение, требуемое некоторыми значениями [action](https://python-all.ru/3.6/library/argparse.html#action) и [nargs](https://python-all.ru/3.6/library/argparse.html#nargs).536- [default](https://python-all.ru/3.6/library/argparse.html#default) – Значение, создаваемое, если аргумент отсутствует в командной строке.537- [type](https://python-all.ru/3.6/library/argparse.html#type) – тип, в который следует преобразовать аргумент командной строки.538- [choices](https://python-all.ru/3.6/library/argparse.html#choices) – Контейнер допустимых значений для аргумента.539- [required](https://python-all.ru/3.6/library/argparse.html#required) – может ли параметр командной строки быть опущен (только для опциональных параметров).540- [help](https://python-all.ru/3.6/library/argparse.html#help) – краткое описание того, что делает аргумент.541- [metavar](https://python-all.ru/3.6/library/argparse.html#metavar) – имя аргумента в сообщениях об использовании.542- [dest](https://python-all.ru/3.6/library/argparse.html#dest) – имя атрибута, добавляемого в объект, возвращаемый [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args).543544В следующих разделах описывается, как используется каждый из этих параметров.545546### 16.4.3.1. имя или флаги547548Метод [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument) должен знать, ожидается ли необязательный аргумент (например, `-f` или `--foo`) или позиционный аргумент (например, список имён файлов). Поэтому первыми аргументами, передаваемыми в [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument), должна быть либо последовательность флагов, либо просто имя аргумента. Например, необязательный аргумент можно создать так:549550```python551>>> parser.add_argument('-f', '--foo')552```553554а позиционный – так:555556```python557>>> parser.add_argument('bar')558```559560При вызове [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) опциональные аргументы опознаются по префиксу `-`, а остальные аргументы считаются позиционными:561562```python563>>> parser = argparse.ArgumentParser(prog='PROG')564>>> parser.add_argument('-f', '--foo')565>>> parser.add_argument('bar')566>>> parser.parse_args(['BAR'])567Namespace(bar='BAR', foo=None)568>>> parser.parse_args(['BAR', '--foo', 'FOO'])569Namespace(bar='BAR', foo='FOO')570>>> parser.parse_args(['--foo', 'FOO'])571usage: PROG [-h] [-f FOO] bar572PROG: error: the following arguments are required: bar573```574575### 16.4.3.2. action576577Объекты [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) связывают аргументы командной строки с действиями. Эти действия могут делать с аргументами практически что угодно, но чаще всего они просто добавляют атрибут в объект, возвращаемый [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args). Ключевой аргумент `action` определяет, как следует обрабатывать аргументы командной строки. Доступны следующие действия:578579- `'store'` – просто сохраняет значение аргумента. Это действие по умолчанию. Например:580581  ```python582  >>> parser = argparse.ArgumentParser()583  >>> parser.add_argument('--foo')584  >>> parser.parse_args('--foo 1'.split())585  Namespace(foo='1')586  ```587- `'store_const'` – сохраняет значение, заданное именованным аргументом [const](https://python-all.ru/3.6/library/argparse.html#const). Действие `'store_const'` чаще всего используется с необязательными аргументами, задающими какой-либо флаг. Например:588589  ```python590  >>> parser = argparse.ArgumentParser()591  >>> parser.add_argument('--foo', action='store_const', const=42)592  >>> parser.parse_args(['--foo'])593  Namespace(foo=42)594  ```595- `'store_true'` и `'store_false'` – это частные случаи `'store_const'`, используемые для хранения значений `True` и `False` соответственно. Кроме того, они создают значения по умолчанию `False` и `True` соответственно. Например:596597  ```python598  >>> parser = argparse.ArgumentParser()599  >>> parser.add_argument('--foo', action='store_true')600  >>> parser.add_argument('--bar', action='store_false')601  >>> parser.add_argument('--baz', action='store_false')602  >>> parser.parse_args('--foo --bar'.split())603  Namespace(foo=True, bar=False, baz=True)604  ```605- `'append'` – сохраняет список и добавляет в него каждое значение аргумента. Это полезно, чтобы разрешить указание параметра несколько раз. Пример использования:606607  ```python608  >>> parser = argparse.ArgumentParser()609  >>> parser.add_argument('--foo', action='append')610  >>> parser.parse_args('--foo 1 --foo 2'.split())611  Namespace(foo=['1', '2'])612  ```613- `'append_const'` – сохраняет список и добавляет в него значение, заданное именованным аргументом [const](https://python-all.ru/3.6/library/argparse.html#const). (Обратите внимание, что именованный аргумент [const](https://python-all.ru/3.6/library/argparse.html#const) по умолчанию равен `None`.) Действие `'append_const'` обычно полезно, когда несколько аргументов должны сохранять константы в один и тот же список. Например:614615  ```python616  >>> parser = argparse.ArgumentParser()617  >>> parser.add_argument('--str', dest='types', action='append_const', const=str)618  >>> parser.add_argument('--int', dest='types', action='append_const', const=int)619  >>> parser.parse_args('--str --int'.split())620  Namespace(types=[<class 'str'>, <class 'int'>])621  ```622- `'count'` – подсчитывает, сколько раз встречается именованный аргумент. Например, это полезно для повышения уровня подробности вывода:623624  ```python625  >>> parser = argparse.ArgumentParser()626  >>> parser.add_argument('--verbose', '-v', action='count')627  >>> parser.parse_args(['-vvv'])628  Namespace(verbose=3)629  ```630- `'help'` – выводит полное справочное сообщение для всех параметров текущего анализатора и завершает работу. По умолчанию действие справки автоматически добавляется в анализатор. Подробности о том, как формируется вывод, см. в [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser).631- `'version'` – ожидает именованный аргумент `version=` в вызове [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument) и при вызове выводит информацию о версии и завершает работу:632633  ```python634  >>> import argparse635  >>> parser = argparse.ArgumentParser(prog='PROG')636  >>> parser.add_argument('--version', action='version', version='%(prog)s 2.0')637  >>> parser.parse_args(['--version'])638  PROG 2.0639  ```640641Вы также можете указать произвольное действие, передав подкласс Action или другой объект, реализующий тот же интерфейс. Рекомендуемый способ – расширить [`Action`](https://python-all.ru/3.6/library/argparse.html#argparse.Action), переопределив метод `__call__` и, опционально, метод `__init__`.642643Пример пользовательского действия:644645```python646>>> class FooAction(argparse.Action):647...     def __init__(self, option_strings, dest, nargs=None, **kwargs):648...         if nargs is not None:649...             raise ValueError("nargs not allowed")650...         super(FooAction, self).__init__(option_strings, dest, **kwargs)651...     def __call__(self, parser, namespace, values, option_string=None):652...         print('%r %r %r' % (namespace, values, option_string))653...         setattr(namespace, self.dest, values)654...655>>> parser = argparse.ArgumentParser()656>>> parser.add_argument('--foo', action=FooAction)657>>> parser.add_argument('bar', action=FooAction)658>>> args = parser.parse_args('1 --foo 2'.split())659Namespace(bar=None, foo=None) '1' None660Namespace(bar='1', foo=None) '2' '--foo'661>>> args662Namespace(bar='1', foo='2')663```664665Подробнее см. в [`Action`](https://python-all.ru/3.6/library/argparse.html#argparse.Action).666667### 16.4.3.3. nargs668669Объекты ArgumentParser обычно связывают один аргумент командной строки с одним действием. Именованный аргумент `nargs` связывает другое количество аргументов командной строки с одним действием. Допустимые значения:670671- `N` (целое число). Аргументы `N` из командной строки будут собраны в список. Например:672673  ```python674  >>> parser = argparse.ArgumentParser()675  >>> parser.add_argument('--foo', nargs=2)676  >>> parser.add_argument('bar', nargs=1)677  >>> parser.parse_args('c --foo a b'.split())678  Namespace(bar=['c'], foo=['a', 'b'])679  ```680681  Обратите внимание, что `nargs=1` создаёт список из одного элемента. Это отличается от поведения по умолчанию, при котором элемент создаётся сам по себе.682683- `'?'`. Если возможно, будет потреблён один аргумент командной строки и выдан как отдельный элемент. Если аргумент командной строки отсутствует, будет выдано значение из [default](https://python-all.ru/3.6/library/argparse.html#default). Обратите внимание, что для необязательных аргументов есть дополнительный случай: строка параметра присутствует, но за ней не следует аргумент командной строки. В этом случае будет выдано значение из [const](https://python-all.ru/3.6/library/argparse.html#const). Некоторые примеры для иллюстрации:684685  ```python686  >>> parser = argparse.ArgumentParser()687  >>> parser.add_argument('--foo', nargs='?', const='c', default='d')688  >>> parser.add_argument('bar', nargs='?', default='d')689  >>> parser.parse_args(['XX', '--foo', 'YY'])690  Namespace(bar='XX', foo='YY')691  >>> parser.parse_args(['XX', '--foo'])692  Namespace(bar='XX', foo='c')693  >>> parser.parse_args([])694  Namespace(bar='d', foo='d')695  ```696697  Одно из наиболее распространённых применений `nargs='?'` – разрешение необязательных входных и выходных файлов:698699  ```python700  >>> parser = argparse.ArgumentParser()701  >>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'),702  ...                     default=sys.stdin)703  >>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),704  ...                     default=sys.stdout)705  >>> parser.parse_args(['input.txt', 'output.txt'])706  Namespace(infile=<_io.TextIOWrapper name='input.txt' encoding='UTF-8'>,707            outfile=<_io.TextIOWrapper name='output.txt' encoding='UTF-8'>)708  >>> parser.parse_args([])709  Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>,710            outfile=<_io.TextIOWrapper name='<stdout>' encoding='UTF-8'>)711  ```712713- `'*'`. Все присутствующие аргументы командной строки собираются в список. Обратите внимание, что обычно не имеет смысла указывать более одного позиционного аргумента с `nargs='*'`, но возможно несколько необязательных аргументов с `nargs='*'`. Например:714715  ```python716  >>> parser = argparse.ArgumentParser()717  >>> parser.add_argument('--foo', nargs='*')718  >>> parser.add_argument('--bar', nargs='*')719  >>> parser.add_argument('baz', nargs='*')720  >>> parser.parse_args('a b --foo x y --bar 1 2'.split())721  Namespace(bar=['1', '2'], baz=['a', 'b'], foo=['x', 'y'])722  ```723724- `'+'`. Как и `'*'`, все присутствующие аргументы командной строки собираются в список. Кроме того, будет выдано сообщение об ошибке, если не было хотя бы одного аргумента командной строки. Например:725726  ```python727  >>> parser = argparse.ArgumentParser(prog='PROG')728  >>> parser.add_argument('foo', nargs='+')729  >>> parser.parse_args(['a', 'b'])730  Namespace(foo=['a', 'b'])731  >>> parser.parse_args([])732  usage: PROG [-h] foo [foo ...]733  PROG: error: the following arguments are required: foo734  ```735736- `argparse.REMAINDER`. Все остальные аргументы командной строки собираются в список. Это часто полезно для утилит командной строки, которые вызывают другие утилиты командной строки:737738  ```python739  >>> parser = argparse.ArgumentParser(prog='PROG')740  >>> parser.add_argument('--foo')741  >>> parser.add_argument('command')742  >>> parser.add_argument('args', nargs=argparse.REMAINDER)743  >>> print(parser.parse_args('--foo B cmd --arg1 XX ZZ'.split()))744  Namespace(args=['--arg1', 'XX', 'ZZ'], command='cmd', foo='B')745  ```746747Если именованный аргумент `nargs` не указан, количество потребляемых аргументов определяется действием [action](https://python-all.ru/3.6/library/argparse.html#action). Обычно это означает, что будет потреблён один аргумент командной строки и создан один элемент (не список).748749### 16.4.3.4. const750751Аргумент `const` функции [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument) используется для хранения постоянных значений, которые не считываются из командной строки, но требуются для различных действий [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser). Два наиболее распространённых его применения:752753- Когда [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument) вызывается с `action='store_const'` или `action='append_const'`. Эти действия добавляют значение `const` к одному из атрибутов объекта, возвращаемого [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args). Примеры см. в описании [action](https://python-all.ru/3.6/library/argparse.html#action).754- Когда [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument) вызывается со строками параметров (например, `-f` или `--foo`) и `nargs='?'`. Это создаёт необязательный аргумент, за которым может следовать ноль или один аргумент командной строки. При разборе командной строки, если строка параметра встречается без следующего за ней аргумента, вместо него будет использоваться значение `const`. Примеры см. в описании [nargs](https://python-all.ru/3.6/library/argparse.html#nargs).755756Для действий `'store_const'` и `'append_const'` необходимо указать именованный аргумент `const`. Для других действий по умолчанию используется `None`.757758### 16.4.3.5. default759760Все необязательные аргументы и некоторые позиционные аргументы могут быть опущены в командной строке. Именованный аргумент `default` функции [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument), значение которого по умолчанию равно `None`, указывает, какое значение следует использовать, если аргумент командной строки отсутствует. Для необязательных аргументов значение `default` используется, когда строка параметра отсутствовала в командной строке:761762```python763>>> parser = argparse.ArgumentParser()764>>> parser.add_argument('--foo', default=42)765>>> parser.parse_args(['--foo', '2'])766Namespace(foo='2')767>>> parser.parse_args([])768Namespace(foo=42)769```770771Если значение `default` является строкой, анализатор разбирает его так, как если бы это был аргумент командной строки. В частности, анализатор применяет любой аргумент преобразования [type](https://python-all.ru/3.6/library/argparse.html#type), если он указан, перед установкой атрибута в возвращаемом значении [`Namespace`](https://python-all.ru/3.6/library/argparse.html#argparse.Namespace). В противном случае анализатор использует значение как есть:772773```python774>>> parser = argparse.ArgumentParser()775>>> parser.add_argument('--length', default='10', type=int)776>>> parser.add_argument('--width', default=10.5, type=int)777>>> parser.parse_args()778Namespace(length=10, width=10.5)779```780781Для позиционных аргументов с [nargs](https://python-all.ru/3.6/library/argparse.html#nargs), равным `?` или `*`, значение `default` используется, когда аргумент командной строки отсутствовал:782783```python784>>> parser = argparse.ArgumentParser()785>>> parser.add_argument('foo', nargs='?', default=42)786>>> parser.parse_args(['a'])787Namespace(foo='a')788>>> parser.parse_args([])789Namespace(foo=42)790```791792Указание `default=argparse.SUPPRESS` приводит к тому, что атрибут не добавляется, если аргумент командной строки отсутствовал:793794```python795>>> parser = argparse.ArgumentParser()796>>> parser.add_argument('--foo', default=argparse.SUPPRESS)797>>> parser.parse_args([])798Namespace()799>>> parser.parse_args(['--foo', '1'])800Namespace(foo='1')801```802803### 16.4.3.6. type804805По умолчанию объекты [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) читают аргументы командной строки как простые строки. Однако довольно часто строку командной строки нужно интерпретировать как другой тип, например [`float`](https://python-all.ru/3.6/library/functions.html#float) или [`int`](https://python-all.ru/3.6/library/functions.html#int). Ключевой аргумент `type` метода [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument) позволяет выполнять любые необходимые проверки типов и преобразования типов. Обычные встроенные типы и функции можно использовать непосредственно в качестве значения аргумента `type`:806807```python808>>> parser = argparse.ArgumentParser()809>>> parser.add_argument('foo', type=int)810>>> parser.add_argument('bar', type=open)811>>> parser.parse_args('2 temp.txt'.split())812Namespace(bar=<_io.TextIOWrapper name='temp.txt' encoding='UTF-8'>, foo=2)813```814815См. раздел о ключевом аргументе [default](https://python-all.ru/3.6/library/argparse.html#default) для получения информации о том, когда аргумент `type` применяется к аргументам по умолчанию.816817Для упрощения работы с различными типами файлов модуль argparse предоставляет фабрику FileType, которая принимает аргументы `mode=`, `bufsize=`, `encoding=` и `errors=` функции [`open()`](https://python-all.ru/3.6/library/functions.html#open). Например, `FileType('w')` можно использовать для создания файла для записи:818819```python820>>> parser = argparse.ArgumentParser()821>>> parser.add_argument('bar', type=argparse.FileType('w'))822>>> parser.parse_args(['out.txt'])823Namespace(bar=<_io.TextIOWrapper name='out.txt' encoding='UTF-8'>)824```825826`type=` может принимать любой вызываемый объект, который принимает один строковый аргумент и возвращает преобразованное значение:827828```python829>>> def perfect_square(string):830...     value = int(string)831...     sqrt = math.sqrt(value)832...     if sqrt != int(sqrt):833...         msg = "%r is not a perfect square" % string834...         raise argparse.ArgumentTypeError(msg)835...     return value836...837>>> parser = argparse.ArgumentParser(prog='PROG')838>>> parser.add_argument('foo', type=perfect_square)839>>> parser.parse_args(['9'])840Namespace(foo=9)841>>> parser.parse_args(['7'])842usage: PROG [-h] foo843PROG: error: argument foo: '7' is not a perfect square844```845846Ключевой аргумент [choices](https://python-all.ru/3.6/library/argparse.html#choices) может быть удобнее для проверок типов, которые просто проверяют попадание в диапазон значений:847848```python849>>> parser = argparse.ArgumentParser(prog='PROG')850>>> parser.add_argument('foo', type=int, choices=range(5, 10))851>>> parser.parse_args(['7'])852Namespace(foo=7)853>>> parser.parse_args(['11'])854usage: PROG [-h] {5,6,7,8,9}855PROG: error: argument foo: invalid choice: 11 (choose from 5, 6, 7, 8, 9)856```857858См. раздел [choices](https://python-all.ru/3.6/library/argparse.html#choices) для получения дополнительных сведений.859860### 16.4.3.7. choices861862Некоторые аргументы командной строки должны выбираться из ограниченного набора значений. Это можно обработать, передав контейнерный объект в качестве аргумента *choices* для [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument). Когда командная строка разбирается, значения аргументов проверяются, и будет выведено сообщение об ошибке, если аргумент не был одним из допустимых значений:863864```python865>>> parser = argparse.ArgumentParser(prog='game.py')866>>> parser.add_argument('move', choices=['rock', 'paper', 'scissors'])867>>> parser.parse_args(['rock'])868Namespace(move='rock')869>>> parser.parse_args(['fire'])870usage: game.py [-h] {rock,paper,scissors}871game.py: error: argument move: invalid choice: 'fire' (choose from 'rock',872'paper', 'scissors')873```874875Обратите внимание: вхождение в контейнер *choices* проверяется после всех преобразований типа [type](https://python-all.ru/3.6/library/argparse.html#type), поэтому тип объектов в *choices* должен соответствовать указанному [type](https://python-all.ru/3.6/library/argparse.html#type):876877```python878>>> parser = argparse.ArgumentParser(prog='doors.py')879>>> parser.add_argument('door', type=int, choices=range(1, 4))880>>> print(parser.parse_args(['3']))881Namespace(door=3)882>>> parser.parse_args(['4'])883usage: doors.py [-h] {1,2,3}884doors.py: error: argument door: invalid choice: 4 (choose from 1, 2, 3)885```886887Любой объект, поддерживающий оператор `in`, может быть передан как значение *choices* , поэтому объекты [`dict`](https://python-all.ru/3.6/library/stdtypes.html#dict), [`set`](https://python-all.ru/3.6/library/stdtypes.html#set), пользовательские контейнеры и т.д. – все поддерживаются.888889### 16.4.3.8. required890891В целом, модуль [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) предполагает, что флаги вида `-f` и `--bar` обозначают *необязательные* аргументы, которые всегда можно опустить в командной строке. Чтобы сделать опцию *обязательной*, для ключевого аргумента `required=` функции [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument) можно указать `True`:892893```python894>>> parser = argparse.ArgumentParser()895>>> parser.add_argument('--foo', required=True)896>>> parser.parse_args(['--foo', 'BAR'])897Namespace(foo='BAR')898>>> parser.parse_args([])899usage: argparse.py [-h] [--foo FOO]900argparse.py: error: option --foo is required901```902903Как показано в примере, если опция помечена как `required`, [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) сообщит об ошибке, если эта опция отсутствует в командной строке.904905> **Примечание**906>907> Обязательные опции обычно считаются дурным тоном, поскольку пользователи ожидают, что *опции* будут *необязательными*, поэтому их следует по возможности избегать.908909### 16.4.3.9. help910911Значение `help` – это строка, содержащая краткое описание аргумента. Когда пользователь запрашивает справку (обычно с помощью `-h` или `--help` в командной строке), эти описания `help` отображаются для каждого аргумента:912913```python914>>> parser = argparse.ArgumentParser(prog='frobble')915>>> parser.add_argument('--foo', action='store_true',916...                     help='foo the bars before frobbling')917>>> parser.add_argument('bar', nargs='+',918...                     help='one of the bars to be frobbled')919>>> parser.parse_args(['-h'])920usage: frobble [-h] [--foo] bar [bar ...]921922positional arguments:923 bar     one of the bars to be frobbled924925optional arguments:926 -h, --help  show this help message and exit927 --foo   foo the bars before frobbling928```929930Строки `help` могут содержать различные спецификаторы формата, чтобы избежать повторения таких элементов, как имя программы или [значение по умолчанию](https://python-all.ru/3.6/library/argparse.html#default) аргумента. Доступные спецификаторы включают имя программы, `%(prog)s` и большинство ключевых аргументов функции [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument), например `%(default)s`, `%(type)s` и т.д.:931932```python933>>> parser = argparse.ArgumentParser(prog='frobble')934>>> parser.add_argument('bar', nargs='?', type=int, default=42,935...                     help='the bar to %(prog)s (default: %(default)s)')936>>> parser.print_help()937usage: frobble [-h] [bar]938939positional arguments:940 bar     the bar to frobble (default: 42)941942optional arguments:943 -h, --help  show this help message and exit944```945946Поскольку строка справки поддерживает %-форматирование, если требуется, чтобы в ней отображался литерал `%`, его нужно экранировать как `%%`.947948[`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) поддерживает скрытие записи справки для определённых опций путём установки значения `help` в `argparse.SUPPRESS`:949950```python951>>> parser = argparse.ArgumentParser(prog='frobble')952>>> parser.add_argument('--foo', help=argparse.SUPPRESS)953>>> parser.print_help()954usage: frobble [-h]955956optional arguments:957  -h, --help  show this help message and exit958```959960### 16.4.3.10. metavar961962Когда [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) генерирует сообщения справки, ему нужен способ ссылаться на каждый ожидаемый аргумент. По умолчанию объекты ArgumentParser используют значение [dest](https://python-all.ru/3.6/library/argparse.html#dest) в качестве «имени» каждого объекта. По умолчанию для позиционных аргументов значение [dest](https://python-all.ru/3.6/library/argparse.html#dest) используется напрямую, а для опциональных аргументов значение [dest](https://python-all.ru/3.6/library/argparse.html#dest) преобразуется в верхний регистр. Таким образом, один позиционный аргумент с `dest='bar'` будет называться `bar`. Один опциональный аргумент `--foo`, за которым должен следовать один аргумент командной строки, будет называться `FOO`. Пример:963964```python965>>> parser = argparse.ArgumentParser()966>>> parser.add_argument('--foo')967>>> parser.add_argument('bar')968>>> parser.parse_args('X --foo Y'.split())969Namespace(bar='X', foo='Y')970>>> parser.print_help()971usage:  [-h] [--foo FOO] bar972973positional arguments:974 bar975976optional arguments:977 -h, --help  show this help message and exit978 --foo FOO979```980981Альтернативное имя можно указать с помощью `metavar`:982983```python984>>> parser = argparse.ArgumentParser()985>>> parser.add_argument('--foo', metavar='YYY')986>>> parser.add_argument('bar', metavar='XXX')987>>> parser.parse_args('X --foo Y'.split())988Namespace(bar='X', foo='Y')989>>> parser.print_help()990usage:  [-h] [--foo YYY] XXX991992positional arguments:993 XXX994995optional arguments:996 -h, --help  show this help message and exit997 --foo YYY998```9991000Обратите внимание, что `metavar` изменяет только *отображаемое* имя – имя атрибута объекта [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) по-прежнему определяется значением [dest](https://python-all.ru/3.6/library/argparse.html#dest).10011002Разные значения `nargs` могут привести к тому, что метапеременная будет использована несколько раз. Передача кортежа в `metavar` задаёт различное отображение для каждого из аргументов:10031004```python1005>>> parser = argparse.ArgumentParser(prog='PROG')1006>>> parser.add_argument('-x', nargs=2)1007>>> parser.add_argument('--foo', nargs=2, metavar=('bar', 'baz'))1008>>> parser.print_help()1009usage: PROG [-h] [-x X X] [--foo bar baz]10101011optional arguments:1012 -h, --help     show this help message and exit1013 -x X X1014 --foo bar baz1015```10161017### 16.4.3.11. dest10181019Большинство действий [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) добавляют некоторое значение как атрибут объекта, возвращаемого [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args). Имя этого атрибута определяется ключевым аргументом `dest` функции [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument). Для действий с позиционными аргументами `dest` обычно передаётся первым аргументом в [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument):10201021```python1022>>> parser = argparse.ArgumentParser()1023>>> parser.add_argument('bar')1024>>> parser.parse_args(['XXX'])1025Namespace(bar='XXX')1026```10271028Для действий необязательных аргументов значение `dest` обычно выводится из строк опций. [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) генерирует значение `dest`, беря первую длинную строку опции и удаляя начальную строку `--`. Если длинные строки опций не были предоставлены, `dest` будет получен из первой короткой строки опции путем удаления начального символа `-`. Любые внутренние символы `-` будут преобразованы в символы `_`, чтобы гарантировать, что строка является допустимым именем атрибута. Примеры ниже иллюстрируют это поведение:10291030```python1031>>> parser = argparse.ArgumentParser()1032>>> parser.add_argument('-f', '--foo-bar', '--foo')1033>>> parser.add_argument('-x', '-y')1034>>> parser.parse_args('-f 1 -x 2'.split())1035Namespace(foo_bar='1', x='2')1036>>> parser.parse_args('--foo 1 -y 2'.split())1037Namespace(foo_bar='1', x='2')1038```10391040`dest` позволяет указать пользовательское имя атрибута:10411042```python1043>>> parser = argparse.ArgumentParser()1044>>> parser.add_argument('--foo', dest='bar')1045>>> parser.parse_args('--foo XXX'.split())1046Namespace(bar='XXX')1047```10481049### 16.4.3.12. Классы действий10501051Классы действий реализуют API Action – вызываемый объект, который возвращает вызываемый объект, обрабатывающий аргументы командной строки. Любой объект, следующий этому API, может быть передан в качестве параметра `action` в `add_argument()`.10521053#### `class argparse.Action(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)`10541055Объекты Action используются ArgumentParser для представления информации, необходимой для разбора одного аргумента из одной или нескольких строк командной строки. Класс Action должен принимать два позиционных аргумента плюс любые именованные аргументы, переданные в [`ArgumentParser.add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument), за исключением самого `action`.10561057Экземпляры Action (или возвращаемое значение любого вызываемого объекта для параметра `action`) должны иметь определённые атрибуты «dest», «option\_strings», «default», «type», «required», «help» и т.д. Самый простой способ гарантировать, что эти атрибуты определены – вызвать `Action.__init__`.10581059Экземпляры Action должны быть вызываемыми, поэтому подклассы должны переопределять метод `__call__`, который должен принимать четыре параметра:10601061- `parser` – объект ArgumentParser, содержащий это действие.1062- `namespace` – объект [`Namespace`](https://python-all.ru/3.6/library/argparse.html#argparse.Namespace), который будет возвращён [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args). Большинство действий добавляют атрибут к этому объекту с помощью [`setattr()`](https://python-all.ru/3.6/library/functions.html#setattr).1063- `values` – соответствующие аргументы командной строки с применёнными преобразованиями типов. Преобразования типов задаются с помощью именованного аргумента [type](https://python-all.ru/3.6/library/argparse.html#type) для [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument).1064- `option_string` – строка опции, которая использовалась для вызова этого действия. Аргумент `option_string` является необязательным и будет отсутствовать, если действие связано с позиционным аргументом.10651066Метод `__call__` может выполнять произвольные действия, но обычно устанавливает атрибуты объекта `namespace` на основе `dest` и `values`.10671068## 16.4.4. Метод parse\_args()10691070#### `ArgumentParser.parse_args(args=None, namespace=None)`10711072Преобразует строки аргументов в объекты и назначает их в качестве атрибутов пространства имён. Возвращает заполненное пространство имён.10731074Предыдущие вызовы [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument) определяют, какие объекты создаются и как они назначаются. Подробнее см. документацию [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument).10751076- [args](https://python-all.ru/3.6/library/argparse.html#args) – список строк для разбора. По умолчанию берётся из [`sys.argv`](https://python-all.ru/3.6/library/sys.html#sys.argv).1077- [namespace](https://python-all.ru/3.6/library/argparse.html#namespace) – объект, в который будут помещены атрибуты. По умолчанию – новый пустой объект [`Namespace`](https://python-all.ru/3.6/library/argparse.html#argparse.Namespace).10781079### 16.4.4.1. Синтаксис значений параметров10801081Метод [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) поддерживает несколько способов указания значения параметра (если он принимает значение). В простейшем случае параметр и его значение передаются как два отдельных аргумента:10821083```python1084>>> parser = argparse.ArgumentParser(prog='PROG')1085>>> parser.add_argument('-x')1086>>> parser.add_argument('--foo')1087>>> parser.parse_args(['-x', 'X'])1088Namespace(foo=None, x='X')1089>>> parser.parse_args(['--foo', 'FOO'])1090Namespace(foo='FOO', x=None)1091```10921093Для длинных параметров (с именами длиннее одного символа) параметр и значение могут быть переданы как один аргумент командной строки, используя `=` для их разделения:10941095```python1096>>> parser.parse_args(['--foo=FOO'])1097Namespace(foo='FOO', x=None)1098```10991100Для коротких опций (опции длиной в один символ) опция и её значение могут быть объединены:11011102```python1103>>> parser.parse_args(['-xX'])1104Namespace(foo=None, x='X')1105```11061107Несколько коротких опций можно объединить, используя только один префикс `-`, при условии, что только последняя опция (или ни одна из них) требует значения:11081109```python1110>>> parser = argparse.ArgumentParser(prog='PROG')1111>>> parser.add_argument('-x', action='store_true')1112>>> parser.add_argument('-y', action='store_true')1113>>> parser.add_argument('-z')1114>>> parser.parse_args(['-xyzZ'])1115Namespace(x=True, y=True, z='Z')1116```11171118### 16.4.4.2. Недопустимые аргументы11191120При разборе командной строки [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) проверяет различные ошибки, включая неоднозначные опции, некорректные типы, неверные опции, неправильное количество позиционных аргументов и т.д. При обнаружении такой ошибки программа завершается и выводит сообщение об ошибке вместе со справкой по использованию:11211122```python1123>>> parser = argparse.ArgumentParser(prog='PROG')1124>>> parser.add_argument('--foo', type=int)1125>>> parser.add_argument('bar', nargs='?')11261127>>> # недопустимый тип1128>>> parser.parse_args(['--foo', 'spam'])1129usage: PROG [-h] [--foo FOO] [bar]1130PROG: error: argument --foo: invalid int value: 'spam'11311132>>> # недопустимая опция1133>>> parser.parse_args(['--bar'])1134usage: PROG [-h] [--foo FOO] [bar]1135PROG: error: no such option: --bar11361137>>> # неверное количество аргументов1138>>> parser.parse_args(['spam', 'badger'])1139usage: PROG [-h] [--foo FOO] [bar]1140PROG: error: extra arguments found: badger1141```11421143### 16.4.4.3. Аргументы, содержащие `-`11441145Метод [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) старается выдавать ошибки всякий раз, когда пользователь явно ошибся, но некоторые ситуации по своей природе неоднозначны. Например, аргумент командной строки `-1` может быть как попыткой указать опцию, так и попыткой передать позиционный аргумент. Метод [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) здесь действует осторожно: позиционные аргументы могут начинаться с `-` только если они похожи на отрицательные числа, и в анализаторе нет опций, которые выглядят как отрицательные числа:11461147```python1148>>> parser = argparse.ArgumentParser(prog='PROG')1149>>> parser.add_argument('-x')1150>>> parser.add_argument('foo', nargs='?')11511152>>> # нет опций с отрицательными числами, поэтому -1 – позиционный аргумент1153>>> parser.parse_args(['-x', '-1'])1154Namespace(foo=None, x='-1')11551156>>> # нет опций с отрицательными числами, поэтому -1 и -5 – позиционные аргументы1157>>> parser.parse_args(['-x', '-1', '-5'])1158Namespace(foo='-5', x='-1')11591160>>> parser = argparse.ArgumentParser(prog='PROG')1161>>> parser.add_argument('-1', dest='one')1162>>> parser.add_argument('foo', nargs='?')11631164>>> # опции с отрицательными числами присутствуют, поэтому -1 – это опция1165>>> parser.parse_args(['-1', 'X'])1166Namespace(foo=None, one='X')11671168>>> # опции с отрицательными числами присутствуют, поэтому -2 – это опция1169>>> parser.parse_args(['-2'])1170usage: PROG [-h] [-1 ONE] [foo]1171PROG: error: no such option: -211721173>>> # опции с отрицательными числами присутствуют, поэтому обе -1 – это опции1174>>> parser.parse_args(['-1', '-1'])1175usage: PROG [-h] [-1 ONE] [foo]1176PROG: error: argument -1: expected one argument1177```11781179Если позиционные аргументы должны начинаться с `-` и не похожи на отрицательные числа, можно вставить псевдоаргумент `'--'`, который сообщает [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args), что всё после него является позиционным аргументом:11801181```python1182>>> parser.parse_args(['--', '-f'])1183Namespace(foo='-f', one=None)1184```11851186### 16.4.4.4. Сокращённые аргументы (сопоставление по префиксу)11871188Метод [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) [по умолчанию](https://python-all.ru/3.6/library/argparse.html#allow-abbrev) позволяет сокращать длинные опции до префикса, если сокращение является однозначным (префикс соответствует уникальной опции):11891190```python1191>>> parser = argparse.ArgumentParser(prog='PROG')1192>>> parser.add_argument('-bacon')1193>>> parser.add_argument('-badger')1194>>> parser.parse_args('-bac MMM'.split())1195Namespace(bacon='MMM', badger=None)1196>>> parser.parse_args('-bad WOOD'.split())1197Namespace(bacon=None, badger='WOOD')1198>>> parser.parse_args('-ba BA'.split())1199usage: PROG [-h] [-bacon BACON] [-badger BADGER]1200PROG: error: ambiguous option: -ba could match -badger, -bacon1201```12021203Выдаётся ошибка для аргументов, которые могут соответствовать нескольким опциям. Эту возможность можно отключить, установив [allow\_abbrev](https://python-all.ru/3.6/library/argparse.html#allow-abbrev) в `False`.12041205### 16.4.4.5. За пределами `sys.argv`12061207Иногда может быть полезно, чтобы ArgumentParser разбирал аргументы, отличные от аргументов [`sys.argv`](https://python-all.ru/3.6/library/sys.html#sys.argv). Этого можно достичь, передав список строк в [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args). Это полезно для тестирования в интерактивной командной строке:12081209```python1210>>> parser = argparse.ArgumentParser()1211>>> parser.add_argument(1212...     'integers', metavar='int', type=int, choices=range(10),1213...     nargs='+', help='an integer in the range 0..9')1214>>> parser.add_argument(1215...     '--sum', dest='accumulate', action='store_const', const=sum,1216...     default=max, help='sum the integers (default: find the max)')1217>>> parser.parse_args(['1', '2', '3', '4'])1218Namespace(accumulate=<built-in function max>, integers=[1, 2, 3, 4])1219>>> parser.parse_args(['1', '2', '3', '4', '--sum'])1220Namespace(accumulate=<built-in function sum>, integers=[1, 2, 3, 4])1221```12221223### 16.4.4.6. Объект Namespace12241225#### `class argparse.Namespace`12261227Простой класс, используемый по умолчанию в [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) для создания объекта, содержащего атрибуты, и его возврата.12281229Этот класс намеренно прост, всего лишь подкласс [`object`](https://python-all.ru/3.6/library/functions.html#object) с читаемым строковым представлением. Если нужно dict-подобное представление атрибутов, можно воспользоваться стандартной идиомой Python, [`vars()`](https://python-all.ru/3.6/library/functions.html#vars):12301231```python1232>>> parser = argparse.ArgumentParser()1233>>> parser.add_argument('--foo')1234>>> args = parser.parse_args(['--foo', 'BAR'])1235>>> vars(args)1236{'foo': 'BAR'}1237```12381239Также может быть полезно, чтобы [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) присваивал атрибуты уже существующему объекту, а не новому объекту [`Namespace`](https://python-all.ru/3.6/library/argparse.html#argparse.Namespace). Этого можно достичь, указав именованный аргумент `namespace=`:12401241```python1242>>> class C:1243...     pass1244...1245>>> c = C()1246>>> parser = argparse.ArgumentParser()1247>>> parser.add_argument('--foo')1248>>> parser.parse_args(args=['--foo', 'BAR'], namespace=c)1249>>> c.foo1250'BAR'1251```12521253## 16.4.5. Прочие утилиты12541255### 16.4.5.1. Подкоманды12561257#### `ArgumentParser.add_subparsers([title][, description][, prog][, parser_class][, action][, option_string][, dest][, help][, metavar])`12581259Многие программы разделяют свою функциональность на несколько подкоманд, например, программа `svn` может вызывать подкоманды `svn checkout`, `svn update` и `svn commit`. Разделение функциональности таким образом может быть особенно хорошей идеей, когда программа выполняет несколько различных функций, требующих разных типов аргументов командной строки. [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) поддерживает создание таких подкоманд с помощью метода [`add_subparsers()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_subparsers). Метод [`add_subparsers()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_subparsers) обычно вызывается без аргументов и возвращает специальный объект действия. Этот объект имеет единственный метод `add_parser()`, который принимает имя команды и любые аргументы конструктора [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser), и возвращает объект [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser), который можно изменять как обычно.12601261Описание параметров:12621263- title – заголовок для группы подпарсеров в выводе справки; по умолчанию «subcommands», если указано описание, в противном случае используется заголовок для позиционных аргументов.1264- description – описание для группы подпарсеров в выводе справки, по умолчанию `None`1265- prog – информация об использовании, которая будет отображаться в справке подкоманды; по умолчанию – имя программы и любые позиционные аргументы перед аргументом подпарсера1266- parser\_class – класс, который будет использоваться для создания экземпляров подпарсера; по умолчанию – класс текущего парсера (например, ArgumentParser)1267- [action](https://python-all.ru/3.6/library/argparse.html#action) – базовый тип действия, которое будет выполнено при обнаружении этого аргумента в командной строке1268- [dest](https://python-all.ru/3.6/library/argparse.html#dest) – имя атрибута, в котором будет сохранено имя подкоманды; по умолчанию `None`, значение не сохраняется1269- [help](https://python-all.ru/3.6/library/argparse.html#help) – справка для группы подпарсеров в выводе справки; по умолчанию `None`1270- [metavar](https://python-all.ru/3.6/library/argparse.html#metavar) – строка, представляющая доступные подкоманды в справке; по умолчанию это `None` и представляет подкоманды в форме {cmd1, cmd2, ..}12711272Пример использования:12731274```python1275>>> # создать парсер верхнего уровня1276>>> parser = argparse.ArgumentParser(prog='PROG')1277>>> parser.add_argument('--foo', action='store_true', help='foo help')1278>>> subparsers = parser.add_subparsers(help='sub-command help')1279>>>1280>>> # создать парсер для команды "a"1281>>> parser_a = subparsers.add_parser('a', help='a help')1282>>> parser_a.add_argument('bar', type=int, help='bar help')1283>>>1284>>> # создать парсер для команды "b"1285>>> parser_b = subparsers.add_parser('b', help='b help')1286>>> parser_b.add_argument('--baz', choices='XYZ', help='baz help')1287>>>1288>>> # разобрать некоторые списки аргументов1289>>> parser.parse_args(['a', '12'])1290Namespace(bar=12, foo=False)1291>>> parser.parse_args(['--foo', 'b', '--baz', 'Z'])1292Namespace(baz='Z', foo=True)1293```12941295Обратите внимание, что объект, возвращаемый [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args), будет содержать только атрибуты главного парсера и того подпарсера, который был выбран из командной строки (а не любых других подпарсеров). Так, в приведённом выше примере, когда указана команда `a`, присутствуют только атрибуты `foo` и `bar`, а когда указана команда `b` – только атрибуты `foo` и `baz`.12961297Аналогично, при запросе справки от подпарсера выводится только справка этого конкретного парсера. Сообщение справки не включает сообщения родительского парсера или соседних парсеров. (Однако справку для каждой команды подпарсера можно задать, передав аргумент `help=` функции `add_parser()`, как показано выше.)12981299```python1300>>> parser.parse_args(['--help'])1301usage: PROG [-h] [--foo] {a,b} ...13021303positional arguments:1304  {a,b}   sub-command help1305    a     a help1306    b     b help13071308optional arguments:1309  -h, --help  show this help message and exit1310  --foo   foo help13111312>>> parser.parse_args(['a', '--help'])1313usage: PROG a [-h] bar13141315positional arguments:1316  bar     bar help13171318optional arguments:1319  -h, --help  show this help message and exit13201321>>> parser.parse_args(['b', '--help'])1322usage: PROG b [-h] [--baz {X,Y,Z}]13231324optional arguments:1325  -h, --help     show this help message and exit1326  --baz {X,Y,Z}  baz help1327```13281329Метод [`add_subparsers()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_subparsers) также поддерживает именованные аргументы `title` и `description`. Когда любой из них присутствует, команды подпарсера отображаются в собственной группе в выводе справки. Например:13301331```python1332>>> parser = argparse.ArgumentParser()1333>>> subparsers = parser.add_subparsers(title='subcommands',1334...                                    description='valid subcommands',1335...                                    help='additional help')1336>>> subparsers.add_parser('foo')1337>>> subparsers.add_parser('bar')1338>>> parser.parse_args(['-h'])1339usage:  [-h] {foo,bar} ...13401341optional arguments:1342  -h, --help  show this help message and exit13431344subcommands:1345  valid subcommands13461347  {foo,bar}   additional help1348```13491350Кроме того, `add_parser` поддерживает дополнительный аргумент `aliases`, позволяющий нескольким строкам ссылаться на один и тот же подпарсер. Этот пример, как и `svn`, задаёт псевдоним `co` как сокращение для `checkout`:13511352```python1353>>> parser = argparse.ArgumentParser()1354>>> subparsers = parser.add_subparsers()1355>>> checkout = subparsers.add_parser('checkout', aliases=['co'])1356>>> checkout.add_argument('foo')1357>>> parser.parse_args(['co', 'bar'])1358Namespace(foo='bar')1359```13601361Один из особенно эффективных способов работы с подкомандами – комбинировать использование метода [`add_subparsers()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_subparsers) с вызовами [`set_defaults()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.set_defaults), чтобы каждый подпарсер знал, какую функцию Python он должен выполнить. Например:13621363```python1364>>> # функции подкоманд1365>>> def foo(args):1366...     print(args.x * args.y)1367...1368>>> def bar(args):1369...     print('((%s))' % args.z)1370...1371>>> # создать парсер верхнего уровня1372>>> parser = argparse.ArgumentParser()1373>>> subparsers = parser.add_subparsers()1374>>>1375>>> # создать парсер для команды "foo"1376>>> parser_foo = subparsers.add_parser('foo')1377>>> parser_foo.add_argument('-x', type=int, default=1)1378>>> parser_foo.add_argument('y', type=float)1379>>> parser_foo.set_defaults(func=foo)1380>>>1381>>> # создать парсер для команды "bar"1382>>> parser_bar = subparsers.add_parser('bar')1383>>> parser_bar.add_argument('z')1384>>> parser_bar.set_defaults(func=bar)1385>>>1386>>> # разобрать аргументы и вызвать выбранную функцию1387>>> args = parser.parse_args('foo 1 -x 2'.split())1388>>> args.func(args)13892.01390>>>1391>>> # разобрать аргументы и вызвать выбранную функцию1392>>> args = parser.parse_args('bar XYZYX'.split())1393>>> args.func(args)1394((XYZYX))1395```13961397Таким образом, можно поручить [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) задачу вызова соответствующей функции после завершения разбора аргументов. Связывание функций с действиями таким образом – обычно самый простой способ обработать разные действия для каждого из ваших подпарсеров. Однако, если необходимо проверить имя вызванного подпарсера, сработает именованный аргумент `dest` при вызове [`add_subparsers()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_subparsers):13981399```python1400>>> parser = argparse.ArgumentParser()1401>>> subparsers = parser.add_subparsers(dest='subparser_name')1402>>> subparser1 = subparsers.add_parser('1')1403>>> subparser1.add_argument('-x')1404>>> subparser2 = subparsers.add_parser('2')1405>>> subparser2.add_argument('y')1406>>> parser.parse_args(['2', 'frobble'])1407Namespace(subparser_name='2', y='frobble')1408```14091410### 16.4.5.2. Объекты FileType14111412#### `class argparse.FileType(mode='r', bufsize=-1, encoding=None, errors=None)`14131414Фабрика [`FileType`](https://python-all.ru/3.6/library/argparse.html#argparse.FileType) создаёт объекты, которые можно передать в аргумент type функции [`ArgumentParser.add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument). Аргументы, имеющие объекты [`FileType`](https://python-all.ru/3.6/library/argparse.html#argparse.FileType) в качестве типа, будут открывать аргументы командной строки как файлы с указанными режимами, размерами буфера, кодировками и обработкой ошибок (см. функцию [`open()`](https://python-all.ru/3.6/library/functions.html#open) для подробностей):14151416```python1417>>> parser = argparse.ArgumentParser()1418>>> parser.add_argument('--raw', type=argparse.FileType('wb', 0))1419>>> parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8'))1420>>> parser.parse_args(['--raw', 'raw.dat', 'file.txt'])1421Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>)1422```14231424Объекты FileType понимают псевдоаргумент `'-'` и автоматически преобразуют его в `sys.stdin` для читаемых объектов [`FileType`](https://python-all.ru/3.6/library/argparse.html#argparse.FileType) и в `sys.stdout` для записываемых объектов [`FileType`](https://python-all.ru/3.6/library/argparse.html#argparse.FileType):14251426```python1427>>> parser = argparse.ArgumentParser()1428>>> parser.add_argument('infile', type=argparse.FileType('r'))1429>>> parser.parse_args(['-'])1430Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>)1431```14321433Новое в версии 3.4: Именованные аргументы *encodings* и *errors*.14341435### 16.4.5.3. Группы аргументов14361437#### `ArgumentParser.add_argument_group(title=None, description=None)`14381439По умолчанию [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) группирует аргументы командной строки на «позиционные аргументы» и «необязательные аргументы» при выводе справочных сообщений. Если существует более удачная концептуальная группировка аргументов, чем стандартная, подходящие группы можно создать с помощью метода [`add_argument_group()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument_group):14401441```python1442>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)1443>>> group = parser.add_argument_group('group')1444>>> group.add_argument('--foo', help='foo help')1445>>> group.add_argument('bar', help='bar help')1446>>> parser.print_help()1447usage: PROG [--foo FOO] bar14481449group:1450  bar    bar help1451  --foo FOO  foo help1452```14531454Метод [`add_argument_group()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument_group) возвращает объект группы аргументов, у которого есть метод [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument), как и у обычного [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser). Когда аргумент добавляется в группу, парсер обрабатывает его как обычный аргумент, но при выводе справки отображает его в отдельной группе. Метод [`add_argument_group()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument_group) принимает аргументы *title* и *description*, которые можно использовать для настройки этого отображения:14551456```python1457>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)1458>>> group1 = parser.add_argument_group('group1', 'group1 description')1459>>> group1.add_argument('foo', help='foo help')1460>>> group2 = parser.add_argument_group('group2', 'group2 description')1461>>> group2.add_argument('--bar', help='bar help')1462>>> parser.print_help()1463usage: PROG [--bar BAR] foo14641465group1:1466  group1 description14671468  foo    foo help14691470group2:1471  group2 description14721473  --bar BAR  bar help1474```14751476Обратите внимание, что любые аргументы, не входящие в ваши пользовательские группы, окажутся обратно в обычных разделах «позиционные аргументы» и «опциональные аргументы».14771478### 16.4.5.4. Взаимное исключение14791480#### `ArgumentParser.add_mutually_exclusive_group(required=False)`14811482Создаёт взаимоисключающую группу. [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) гарантирует, что в командной строке присутствовал только один из аргументов взаимоисключающей группы:14831484```python1485>>> parser = argparse.ArgumentParser(prog='PROG')1486>>> group = parser.add_mutually_exclusive_group()1487>>> group.add_argument('--foo', action='store_true')1488>>> group.add_argument('--bar', action='store_false')1489>>> parser.parse_args(['--foo'])1490Namespace(bar=True, foo=True)1491>>> parser.parse_args(['--bar'])1492Namespace(bar=False, foo=False)1493>>> parser.parse_args(['--foo', '--bar'])1494usage: PROG [-h] [--foo | --bar]1495PROG: error: argument --bar: not allowed with argument --foo1496```14971498Метод [`add_mutually_exclusive_group()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_mutually_exclusive_group) также принимает аргумент *required*, чтобы указать, что требуется хотя бы один из взаимоисключающих аргументов:14991500```python1501>>> parser = argparse.ArgumentParser(prog='PROG')1502>>> group = parser.add_mutually_exclusive_group(required=True)1503>>> group.add_argument('--foo', action='store_true')1504>>> group.add_argument('--bar', action='store_false')1505>>> parser.parse_args([])1506usage: PROG [-h] (--foo | --bar)1507PROG: error: one of the arguments --foo --bar is required1508```15091510Обратите внимание, что в настоящее время группы взаимоисключающих аргументов не поддерживают аргументы *title* и *description* из [`add_argument_group()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument_group).15111512### 16.4.5.5. Значения по умолчанию парсера15131514#### `ArgumentParser.set_defaults(**kwargs)`15151516В большинстве случаев атрибуты объекта, возвращаемого [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args), полностью определяются путём анализа аргументов командной строки и действий аргументов. [`set_defaults()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.set_defaults) позволяет добавить некоторые дополнительные атрибуты, которые определяются без какого-либо анализа командной строки:15171518```python1519>>> parser = argparse.ArgumentParser()1520>>> parser.add_argument('foo', type=int)1521>>> parser.set_defaults(bar=42, baz='badger')1522>>> parser.parse_args(['736'])1523Namespace(bar=42, baz='badger', foo=736)1524```15251526Обратите внимание: значения по умолчанию на уровне анализатора всегда переопределяют значения по умолчанию на уровне аргументов:15271528```python1529>>> parser = argparse.ArgumentParser()1530>>> parser.add_argument('--foo', default='bar')1531>>> parser.set_defaults(foo='spam')1532>>> parser.parse_args([])1533Namespace(foo='spam')1534```15351536Умолчания на уровне парсера могут быть особенно полезны при работе с несколькими парсерами. См. пример этого типа в методе [`add_subparsers()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_subparsers).15371538#### `ArgumentParser.get_default(dest)`15391540Возвращает значение по умолчанию для атрибута пространства имён, заданное либо [`add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument), либо [`set_defaults()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.set_defaults):15411542```python1543>>> parser = argparse.ArgumentParser()1544>>> parser.add_argument('--foo', default='badger')1545>>> parser.get_default('foo')1546'badger'1547```15481549### 16.4.5.6. Вывод справки15501551В большинстве типичных приложений [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args) берёт на себя форматирование и вывод всех сообщений об использовании и ошибок. Однако доступно несколько методов форматирования:15521553#### `ArgumentParser.print_usage(file=None)`15541555Выводит краткое описание того, как [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) должен вызываться в командной строке. Если *file* равен `None`, предполагается [`sys.stdout`](https://python-all.ru/3.6/library/sys.html#sys.stdout).15561557#### `ArgumentParser.print_help(file=None)`15581559Выводит справочное сообщение, включая использование программы и информацию об аргументах, зарегистрированных в [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser). Если *file* равен `None`, предполагается [`sys.stdout`](https://python-all.ru/3.6/library/sys.html#sys.stdout).15601561Существуют также варианты этих методов, которые просто возвращают строку вместо её вывода:15621563#### `ArgumentParser.format_usage()`15641565Возвращает строку с кратким описанием того, как [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser) должен вызываться в командной строке.15661567#### `ArgumentParser.format_help()`15681569Возвращает строку со справочным сообщением, включая использование программы и информацию об аргументах, зарегистрированных в [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser).15701571### 16.4.5.7. Частичный разбор15721573#### `ArgumentParser.parse_known_args(args=None, namespace=None)`15741575Иногда скрипт может разобрать только часть аргументов командной строки, передавая остальные другому скрипту или программе. В таких случаях может пригодиться метод [`parse_known_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_known_args). Он работает почти как [`parse_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_args), за исключением того, что не вызывает ошибку при наличии лишних аргументов. Вместо этого он возвращает кортеж из двух элементов: заполненное пространство имён и список оставшихся строк аргументов.15761577```python1578>>> parser = argparse.ArgumentParser()1579>>> parser.add_argument('--foo', action='store_true')1580>>> parser.add_argument('bar')1581>>> parser.parse_known_args(['--foo', '--badger', 'BAR', 'spam'])1582(Namespace(bar='BAR', foo=True), ['--badger', 'spam'])1583```15841585> **Предупреждение**1586>1587> Правила [совпадения по префиксу](https://python-all.ru/3.6/library/argparse.html#prefix-matching) применяются к `parse_known_args()`. Парсер может поглотить параметр, даже если он является всего лишь префиксом одного из известных параметров, вместо того чтобы оставить его в списке оставшихся аргументов.15881589### 16.4.5.8. Настройка разбора файлов15901591#### `ArgumentParser.convert_arg_line_to_args(arg_line)`15921593Аргументы, читаемые из файла (см. именованный аргумент *fromfile\_prefix\_chars* конструктора [`ArgumentParser`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser)), читаются по одному аргументу на строку. [`convert_arg_line_to_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.convert_arg_line_to_args) можно переопределить для более сложного чтения.15941595Этот метод принимает один аргумент *arg\_line* – строку, прочитанную из файла аргументов. Он возвращает список аргументов, разобранных из этой строки. Метод вызывается по одному разу для каждой строки из файла аргументов, по порядку.15961597Полезным переопределением этого метода будет то, которое рассматривает каждое отделённое пробелом слово как аргумент. Следующий пример показывает, как это сделать:15981599```python1600class MyArgumentParser(argparse.ArgumentParser):1601    def convert_arg_line_to_args(self, arg_line):1602        return arg_line.split()1603```16041605### 16.4.5.9. Методы завершения16061607#### `ArgumentParser.exit(status=0, message=None)`16081609Этот метод завершает программу, выходя с указанным *статус* и, если задан, выводит *сообщение* перед этим.16101611#### `ArgumentParser.error(message)`16121613Этот метод выводит сообщение об использовании, включая *message*, в стандартный поток ошибок и завершает программу с кодом возврата 2.16141615## 16.4.6. Обновление кода optparse16161617Изначально модуль [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) пытался сохранять совместимость с [`optparse`](https://python-all.ru/3.6/library/optparse.html#module-optparse). Однако [`optparse`](https://python-all.ru/3.6/library/optparse.html#module-optparse) было сложно прозрачно расширять, особенно с изменениями, необходимыми для поддержки новых спецификаторов `nargs=` и более качественных сообщений об использовании. Когда почти всё в [`optparse`](https://python-all.ru/3.6/library/optparse.html#module-optparse) было либо скопировано, либо пропатчено (monkey-patched), попытки поддерживать обратную совместимость перестали казаться практичными.16181619Модуль [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) превосходит стандартный модуль библиотеки [`optparse`](https://python-all.ru/3.6/library/optparse.html#module-optparse) по ряду параметров, включая:16201621- Обработка позиционных аргументов.1622- Поддержка подкоманд.1623- Разрешение альтернативных префиксов параметров, например `+` и `/`.1624- Обработка аргументов в стиле «ноль или более» и «один или более».1625- Формирование более информативных сообщений об использовании.1626- Предоставление гораздо более простого интерфейса для пользовательских `type` и `action`.16271628Частичный путь перехода с [`optparse`](https://python-all.ru/3.6/library/optparse.html#module-optparse) на [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse):16291630- Замените все вызовы [`optparse.OptionParser.add_option()`](https://python-all.ru/3.6/library/optparse.html#optparse.OptionParser.add_option) на вызовы [`ArgumentParser.add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument).1631- Замените `(options, args) = parser.parse_args()` на `args = parser.parse_args()` и добавьте дополнительные вызовы [`ArgumentParser.add_argument()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.add_argument) для позиционных аргументов. Имейте в виду, что то, что ранее называлось `options`, теперь в контексте [`argparse`](https://python-all.ru/3.6/library/argparse.html#module-argparse) называется `args`.1632- Замените [`optparse.OptionParser.disable_interspersed_args()`](https://python-all.ru/3.6/library/optparse.html#optparse.OptionParser.disable_interspersed_args), установив `nargs` позиционного аргумента в [argparse.REMAINDER](https://python-all.ru/3.6/library/argparse.html#argparse-remainder), или используйте [`parse_known_args()`](https://python-all.ru/3.6/library/argparse.html#argparse.ArgumentParser.parse_known_args) для сбора неразобранных строк аргументов в отдельном списке.1633- Замените колбэк-действия и аргументы-ключевые слова `callback_*` на аргументы `type` или `action`.1634- Замените строковые имена для ключевых аргументов `type` соответствующими объектами типов (например, int, float, complex и т.д.).1635- Замените `optparse.Values` на [`Namespace`](https://python-all.ru/3.6/library/argparse.html#argparse.Namespace), а `optparse.OptionError` и `optparse.OptionValueError` на `ArgumentError`.1636- Замените строки с неявными аргументами, такими как `%default` или `%prog`, на стандартный синтаксис Python для использования словарей при форматировании строк, то есть `%(default)s` и `%(prog)s`.1637- Замените аргумент `version` конструктора OptionParser на вызов `parser.add_argument('--version', action='version', version='<the version>')`.1638