> **Источник:** https://python-all.ru/3/library/argparse.html > > «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor. --- # `argparse` – парсер для параметров командной строки, аргументов и подкоманд Добавлено в версии 3.2. **Исходный код:** [Lib/argparse.py](https://python-all.ru/src/3.14/Lib/argparse.py) > **Примечание** > > Хотя `argparse` является рекомендуемым модулем стандартной библиотеки для реализации простых приложений командной строки, у авторов с более строгими требованиями к точному поведению их приложений командной строки может возникнуть ощущение, что он не обеспечивает необходимый уровень контроля. Обратитесь к [Выбор библиотеки для разбора аргументов](https://python-all.ru/3/library/optparse.html#choosing-an-argument-parser) для альтернатив, которые стоит рассмотреть, если `argparse` не поддерживает поведение, необходимое приложению (например, полное отключение поддержки перемешанных параметров и позиционных аргументов, или принятие значений параметров, начинающихся с `-`, даже если они соответствуют другому определённому параметру). --- Учебное пособие На этой странице содержится справочная информация по API. Для более плавного введения в разбор командной строки Python обратитесь к [учебному пособию по argparse](https://python-all.ru/3/howto/argparse.html#argparse-tutorial). Модуль `argparse` упрощает создание удобных интерфейсов командной строки. Программа определяет, какие аргументы ей требуются, а `argparse` разбирается, как извлечь их из [`sys.argv`](https://python-all.ru/3/library/sys.html#sys.argv). Модуль `argparse` также автоматически генерирует сообщения справки и использования. Модуль также выводит ошибки, когда пользователи передают программе недопустимые аргументы. Поддержка интерфейсов командной строки модуля `argparse` построена вокруг экземпляра [`argparse.ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser). Он является контейнером для спецификаций аргументов и имеет параметры, которые применяются к парсеру в целом: ```python parser = argparse.ArgumentParser( prog='ProgramName', description='What the program does', epilog='Text at the bottom of help') ``` Метод [`ArgumentParser.add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument) добавляет в парсер отдельные спецификации аргументов. Он поддерживает позиционные аргументы, опции, принимающие значения, и флаги вкл/выкл: ```python parser.add_argument('filename') # позиционный аргумент parser.add_argument('-c', '--count') # опция, которая принимает значение parser.add_argument('-v', '--verbose', action='store_true') # флаг вкл/выкл ``` Метод [`ArgumentParser.parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) запускает парсер и помещает извлечённые данные в объект [`argparse.Namespace`](https://python-all.ru/3/library/argparse.html#argparse.Namespace): ```python args = parser.parse_args() print(args.filename, args.count, args.verbose) ``` > **Примечание** > > Если вы ищете руководство по обновлению кода с [`optparse`](https://python-all.ru/3/library/optparse.html#module-optparse) на `argparse`, смотрите [Обновление кода Optparse](https://python-all.ru/3/howto/argparse-optparse.html#upgrading-optparse-code). ## Объекты ArgumentParser #### `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, exit_on_error=True, *, suggest_on_error=False, color=True)` Создаёт новый объект `ArgumentParser`. Все параметры должны передаваться как именованные аргументы. Каждый параметр имеет собственное подробное описание ниже, но вкратце они таковы: - [prog](https://python-all.ru/3/library/argparse.html#prog) - имя программы (по умолчанию генерируется из атрибутов модуля `__main__` и `sys.argv[0]`) - [usage](https://python-all.ru/3/library/argparse.html#usage) - строка, описывающая использование программы (по умолчанию генерируется из аргументов, добавленных в парсер) - [description](https://python-all.ru/3/library/argparse.html#description) - текст, отображаемый перед справкой по аргументам (по умолчанию отсутствует) - [epilog](https://python-all.ru/3/library/argparse.html#epilog) - текст, отображаемый после справки по аргументам (по умолчанию отсутствует) - [parents](https://python-all.ru/3/library/argparse.html#parents) - список объектов `ArgumentParser`, аргументы которых также должны быть включены - [formatter\_class](https://python-all.ru/3/library/argparse.html#formatter-class) - класс для настройки вывода справки - [prefix\_chars](https://python-all.ru/3/library/argparse.html#prefix-chars) - набор символов, которые являются префиксом необязательных аргументов (по умолчанию: ‘-‘) - [fromfile\_prefix\_chars](https://python-all.ru/3/library/argparse.html#fromfile-prefix-chars) - набор символов, которые являются префиксом файлов, из которых должны читаться дополнительные аргументы (по умолчанию: `None`) - [argument\_default](https://python-all.ru/3/library/argparse.html#argument-default) - глобальное значение по умолчанию для аргументов (по умолчанию: `None`) - [conflict\_handler](https://python-all.ru/3/library/argparse.html#conflict-handler) - стратегия разрешения конфликтов необязательных аргументов (обычно не требуется) - [add\_help](https://python-all.ru/3/library/argparse.html#add-help) - добавить опцию `-h/--help` в парсер (по умолчанию: `True`) - [allow\_abbrev](https://python-all.ru/3/library/argparse.html#allow-abbrev) - разрешает сокращать длинные опции, если сокращение однозначно (по умолчанию: `True`) - [exit\_on\_error](https://python-all.ru/3/library/argparse.html#exit-on-error) - определяет, завершает ли `ArgumentParser` работу с сообщением об ошибке при возникновении ошибки (по умолчанию: `True`) - [suggest\_on\_error](https://python-all.ru/3/library/argparse.html#suggest-on-error) - включает предложения для неправильно введённых значений аргументов и имён подпарсеров (по умолчанию: `False`) - [color](https://python-all.ru/3/library/argparse.html#color) - разрешает цветной вывод (по умолчанию: `True`) Изменено в версии 3.5: *allow\_abbrev* – добавлен параметр. Изменено в версии 3.8: В предыдущих версиях *allow\_abbrev* также отключал группировку коротких флагов, например `-vv` для обозначения `-v -v`. Изменено в версии 3.9: *exit\_on\_error* – добавлен параметр. Изменено в версии 3.14: *suggest\_on\_error* и *color* – добавлены параметры. В следующих разделах описывается, как используется каждый из этих параметров. ### prog По умолчанию [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) вычисляет имя программы для отображения в справочных сообщениях в зависимости от того, как был запущен интерпретатор Python: - Имя [`base name`](https://python-all.ru/3/library/os.path.html#os.path.basename) `sys.argv[0]`, если в качестве аргумента был передан файл. - Имя интерпретатора Python, за которым следует `sys.argv[0]`, если в качестве аргумента была передана директория или zip-файл. - Имя интерпретатора Python, за которым следует `-m`, а затем имя модуля или пакета, если была использована опция [`-m`](https://python-all.ru/3/using/cmdline.html#cmdoption-m). Это поведение по умолчанию почти всегда желательно, поскольку оно делает сообщения справки соответствующими строке, которая использовалась для запуска программы в командной строке. Однако чтобы изменить это поведение, можно указать другое значение с помощью аргумента `prog=` для [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser): ```python >>> parser = argparse.ArgumentParser(prog='myprogram') >>> parser.print_help() usage: myprogram [-h] options: -h, --help show this help message and exit ``` Обратите внимание, что имя программы, определённое из `sys.argv[0]`, из атрибутов модуля `__main__` или из аргумента `prog=`, доступно в сообщениях справки с помощью спецификатора формата `%(prog)s`. ```python >>> parser = argparse.ArgumentParser(prog='myprogram') >>> parser.add_argument('--foo', help='foo of the %(prog)s program') >>> parser.print_help() usage: myprogram [-h] [--foo FOO] options: -h, --help show this help message and exit --foo FOO foo of the myprogram program ``` Изменено в версии 3.14: Значение по умолчанию `prog` теперь отражает то, как на самом деле была выполнена `__main__`, а не всегда равно `os.path.basename(sys.argv[0])`. ### использование По умолчанию [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) формирует сообщение об использовании из своих аргументов. Стандартное сообщение можно переопределить с помощью именованного аргумента `usage=`: ```python >>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]') >>> parser.add_argument('--foo', nargs='?', help='foo help') >>> parser.add_argument('bar', nargs='+', help='bar help') >>> parser.print_help() usage: PROG [options] positional arguments: bar bar help options: -h, --help show this help message and exit --foo [FOO] foo help ``` Спецификатор формата `%(prog)s` используется для подстановки имени программы в сообщения об использовании. Если для главного парсера указывается собственное сообщение об использовании, возможно, стоит также передать аргумент `prog` в [`add_subparsers()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_subparsers) или аргументы `prog` и `usage` в `add_parser()`, чтобы обеспечить единообразие префиксов команд и информации об использовании во всех подпарсерах. ### описание Большинство вызовов конструктора [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) используют именованный аргумент `description=`. Этот аргумент задаёт краткое описание того, что делает программа и как она работает. В сообщениях справки описание отображается между строкой использования командной строки и справкой по различным аргументам. По умолчанию описание переносится по строкам, чтобы уместиться в отведённом пространстве. Чтобы изменить это поведение, обратитесь к аргументу [formatter\_class](https://python-all.ru/3/library/argparse.html#formatter-class). ### эпилог Некоторые программы выводят дополнительное описание после описания аргументов. Такой текст можно указать с помощью аргумента `epilog=` для [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser): ```python >>> parser = argparse.ArgumentParser( ... description='A foo that bars', ... epilog="And that's how you'd foo a bar") >>> parser.print_help() usage: argparse.py [-h] A foo that bars options: -h, --help show this help message and exit And that's how you'd foo a bar ``` Как и для аргумента [description](https://python-all.ru/3/library/argparse.html#description), текст `epilog=` по умолчанию переносится по строкам, но это поведение можно настроить с помощью аргумента [formatter\_class](https://python-all.ru/3/library/argparse.html#formatter-class) для [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser). ### родительские парсеры Иногда несколько парсеров используют общий набор аргументов. Вместо того чтобы повторять определения этих аргументов, можно использовать один парсер со всеми общими аргументами, передав его в аргумент `parents=` для [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser). Аргумент `parents=` принимает список объектов `ArgumentParser`, собирает из них все позиционные и опциональные действия и добавляет эти действия в создаваемый объект `ArgumentParser`: ```python >>> parent_parser = argparse.ArgumentParser(add_help=False) >>> parent_parser.add_argument('--parent', type=int) >>> foo_parser = argparse.ArgumentParser(parents=[parent_parser]) >>> foo_parser.add_argument('foo') >>> foo_parser.parse_args(['--parent', '2', 'XXX']) Namespace(foo='XXX', parent=2) >>> bar_parser = argparse.ArgumentParser(parents=[parent_parser]) >>> bar_parser.add_argument('--bar') >>> bar_parser.parse_args(['--bar', 'YYY']) Namespace(bar='YYY', parent=None) ``` Обратите внимание, что большинство родительских парсеров указывают `add_help=False`. В противном случае [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) увидит две опции `-h/--help` (одну в родительском парсере, другую – в дочернем) и вызовет ошибку. > **Примечание** > > Парсеры должны быть полностью инициализированы перед передачей через `parents=`. Если изменить родительские парсеры после создания дочернего, эти изменения не отразятся на дочернем парсере. ### класс форматирования Объекты [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) позволяют настраивать форматирование справки, указывая альтернативный класс форматирования. На данный момент существует четыре таких класса: #### `class argparse.RawDescriptionHelpFormatter` #### `class argparse.RawTextHelpFormatter` #### `class argparse.ArgumentDefaultsHelpFormatter` #### `class argparse.MetavarTypeHelpFormatter` [`RawDescriptionHelpFormatter`](https://python-all.ru/3/library/argparse.html#argparse.RawDescriptionHelpFormatter) и [`RawTextHelpFormatter`](https://python-all.ru/3/library/argparse.html#argparse.RawTextHelpFormatter) дают больше контроля над отображением текстовых описаний. По умолчанию объекты [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) переносят текст [description](https://python-all.ru/3/library/argparse.html#description) и [epilog](https://python-all.ru/3/library/argparse.html#epilog) в сообщениях справки командной строки: ```python >>> parser = argparse.ArgumentParser( ... prog='PROG', ... description='''this description ... was indented weird ... but that is okay''', ... epilog=''' ... likewise for this epilog whose whitespace will ... be cleaned up and whose words will be wrapped ... across a couple lines''') >>> parser.print_help() usage: PROG [-h] this description was indented weird but that is okay options: -h, --help show this help message and exit likewise for this epilog whose whitespace will be cleaned up and whose words will be wrapped across a couple lines ``` Передача [`RawDescriptionHelpFormatter`](https://python-all.ru/3/library/argparse.html#argparse.RawDescriptionHelpFormatter) в качестве `formatter_class=` означает, что [description](https://python-all.ru/3/library/argparse.html#description) и [epilog](https://python-all.ru/3/library/argparse.html#epilog) уже правильно отформатированы и не должны переноситься по строкам: ```python >>> parser = argparse.ArgumentParser( ... prog='PROG', ... formatter_class=argparse.RawDescriptionHelpFormatter, ... description=textwrap.dedent('''\ ... Please do not mess up this text! ... -------------------------------- ... I have indented it ... exactly the way ... I want it ... ''')) >>> parser.print_help() usage: PROG [-h] Please do not mess up this text! -------------------------------- I have indented it exactly the way I want it options: -h, --help show this help message and exit ``` [`RawTextHelpFormatter`](https://python-all.ru/3/library/argparse.html#argparse.RawTextHelpFormatter) сохраняет пробельные символы для всех видов текста справки, включая описания аргументов. Однако несколько символов новой строки заменяются на один. Если нужно сохранить несколько пустых строк, добавьте пробелы между ними. [`ArgumentDefaultsHelpFormatter`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentDefaultsHelpFormatter) автоматически добавляет информацию о значениях по умолчанию в сообщения справки каждого аргумента: ```python >>> parser = argparse.ArgumentParser( ... prog='PROG', ... formatter_class=argparse.ArgumentDefaultsHelpFormatter) >>> parser.add_argument('--foo', type=int, default=42, help='FOO!') >>> parser.add_argument('bar', nargs='*', default=[1, 2, 3], help='BAR!') >>> parser.print_help() usage: PROG [-h] [--foo FOO] [bar ...] positional arguments: bar BAR! (default: [1, 2, 3]) options: -h, --help show this help message and exit --foo FOO FOO! (default: 42) ``` [`MetavarTypeHelpFormatter`](https://python-all.ru/3/library/argparse.html#argparse.MetavarTypeHelpFormatter) использует имя аргумента [type](https://python-all.ru/3/library/argparse.html#type) для каждого аргумента в качестве отображаемого имени для его значений (вместо [dest](https://python-all.ru/3/library/argparse.html#dest), как это делает обычный форматировщик): ```python >>> parser = argparse.ArgumentParser( ... prog='PROG', ... formatter_class=argparse.MetavarTypeHelpFormatter) >>> parser.add_argument('--foo', type=int) >>> parser.add_argument('bar', type=float) >>> parser.print_help() usage: PROG [-h] [--foo int] float positional arguments: float options: -h, --help show this help message and exit --foo int ``` ### символы префикса Большинство опций командной строки используют `-` в качестве префикса, например `-f/--foo`. Парсеры, которым нужно поддерживать другие или дополнительные символы префикса, например для опций вроде `+f` или `/foo`, могут указать их с помощью аргумента `prefix_chars=` конструктора [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser): ```python >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='-+') >>> parser.add_argument('+f') >>> parser.add_argument('++bar') >>> parser.parse_args('+f X ++bar Y'.split()) Namespace(bar='Y', f='X') ``` Аргумент `prefix_chars=` по умолчанию равен `'-'`. Если указать набор символов, не включающий `-`, то опции `-f/--foo` будут запрещены. ### символы префикса из файла Иногда при работе с особенно длинным списком аргументов может иметь смысл хранить список аргументов в файле, а не набирать его в командной строке. Если аргумент `fromfile_prefix_chars=` передан конструктору [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser), то аргументы, начинающиеся с любого из указанных символов, будут рассматриваться как файлы и заменяться на содержащиеся в них аргументы. Например: ```python >>> with open('args.txt', 'w', encoding=sys.getfilesystemencoding()) as fp: ... fp.write('-f\nbar') ... >>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@') >>> parser.add_argument('-f') >>> parser.parse_args(['-f', 'foo', '@args.txt']) Namespace(f='bar') ``` По умолчанию аргументы из файла должны быть по одному на строку (но см. также [`convert_arg_line_to_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.convert_arg_line_to_args)) и обрабатываются так, как если бы они находились на том же месте, что и исходный аргумент, ссылающийся на файл в командной строке. Таким образом, в примере выше выражение `['-f', 'foo', '@args.txt']` считается эквивалентным выражению `['-f', 'foo', '-f', 'bar']`. > **Примечание** > > Каждая строка рассматривается как отдельный аргумент, поэтому пустая строка читается как пустая строка (`''`). [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) использует [кодировку и обработчик ошибок файловой системы](https://python-all.ru/3/glossary.html#term-filesystem-encoding-and-error-handler) для чтения файла, содержащего аргументы. Аргумент `fromfile_prefix_chars=` по умолчанию равен `None`, что означает, что аргументы никогда не будут рассматриваться как ссылки на файлы. Изменено в версии 3.12: [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) изменил кодировку и обработку ошибок при чтении файлов аргументов с используемых по умолчанию (например, [`locale.getpreferredencoding(False)`](https://python-all.ru/3/library/locale.html#locale.getpreferredencoding) и `"strict"`) на [кодировку и обработчик ошибок файловой системы](https://python-all.ru/3/glossary.html#term-filesystem-encoding-and-error-handler). Файлы аргументов должны быть закодированы в UTF-8 вместо кодовой страницы ANSI в Windows. ### argument\_default Обычно значения аргументов по умолчанию задаются либо передачей значения по умолчанию в [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument), либо вызовом методов [`set_defaults()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.set_defaults) с определённым набором пар имя-значение. Однако иногда может быть полезно указать единое значение по умолчанию для всех аргументов синтаксического анализатора. Это можно сделать, передав именованный аргумент `argument_default=` в [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser). Например, чтобы глобально отключить создание атрибутов при вызовах [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args), укажите `argument_default=SUPPRESS`: ```python >>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS) >>> parser.add_argument('--foo') >>> parser.add_argument('bar', nargs='?') >>> parser.parse_args(['--foo', '1', 'BAR']) Namespace(bar='BAR', foo='1') >>> parser.parse_args([]) Namespace() ``` ### allow\_abbrev Обычно при передаче списка аргументов методу [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) объекта [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) он [распознаёт сокращения](https://python-all.ru/3/library/argparse.html#prefix-matching) длинных опций. Эту возможность можно отключить, установив `allow_abbrev` в `False`: ```python >>> parser = argparse.ArgumentParser(prog='PROG', allow_abbrev=False) >>> parser.add_argument('--foobar', action='store_true') >>> parser.add_argument('--foonley', action='store_false') >>> parser.parse_args(['--foon']) usage: PROG [-h] [--foobar] [--foonley] PROG: error: unrecognized arguments: --foon ``` Добавлено в версии 3.5. ### conflict\_handler Объекты [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) не допускают два действия с одной и той же строкой опции. По умолчанию объекты `ArgumentParser` вызывают исключение при попытке создать аргумент со строкой опции, которая уже используется: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-f', '--foo', help='old foo help') >>> parser.add_argument('--foo', help='new foo help') Traceback (most recent call last): .. ArgumentError: argument --foo: conflicting option string(s): --foo ``` Иногда (например, при использовании [parents](https://python-all.ru/3/library/argparse.html#parents)) бывает полезно просто переопределить все старые аргументы с той же строкой опции. Для получения такого поведения значение `'resolve'` можно передать в аргумент `conflict_handler=` функции [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser): ```python >>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve') >>> parser.add_argument('-f', '--foo', help='old foo help') >>> parser.add_argument('--foo', help='new foo help') >>> parser.print_help() usage: PROG [-h] [-f FOO] [--foo FOO] options: -h, --help show this help message and exit -f FOO old foo help --foo FOO new foo help ``` Обратите внимание, что объекты [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) удаляют действие только в том случае, если все его строки опций переопределены. Поэтому в приведённом выше примере старое действие `-f/--foo` сохраняется как действие `-f`, поскольку была переопределена только строка опции `--foo`. ### add\_help По умолчанию объекты [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) добавляют опцию, которая просто отображает справочное сообщение синтаксического анализатора. Если в командной строке указано `-h` или `--help`, будет выведена справка `ArgumentParser`. Иногда может быть полезно отключить добавление этой опции справки. Это можно сделать, передав `False` в качестве аргумента `add_help=` функции [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser): ```python >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) >>> parser.add_argument('--foo', help='foo help') >>> parser.print_help() usage: PROG [--foo FOO] options: --foo FOO foo help ``` Обычно опция справки – это `-h/--help`. Исключение составляет случай, когда указан `prefix_chars=` и не включает `-`; в этом случае `-h` и `--help` не являются допустимыми опциями. В таком случае первый символ в `prefix_chars` используется в качестве префикса для опций справки: ```python >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/') >>> parser.print_help() usage: PROG [+h] options: +h, ++help show this help message and exit ``` ### exit\_on\_error Обычно при передаче недопустимого списка аргументов методу [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) объекта [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) он выводит *сообщение* в [`sys.stderr`](https://python-all.ru/3/library/sys.html#sys.stderr) и завершает работу с кодом возврата 2. Если требуется перехватывать ошибки вручную, эту возможность можно включить, установив `exit_on_error` в `False`: ```python >>> parser = argparse.ArgumentParser(exit_on_error=False) >>> parser.add_argument('--integers', type=int) _StoreAction(option_strings=['--integers'], dest='integers', nargs=None, const=None, default=None, type=, choices=None, help=None, metavar=None) >>> try: ... parser.parse_args('--integers a'.split()) ... except argparse.ArgumentError: ... print('Catching an argumentError') ... Catching an argumentError ``` Добавлено в версии 3.9. ### suggest\_on\_error По умолчанию, когда пользователь передает недопустимый выбор аргумента или имя подпарсера, [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) завершит работу с сообщением об ошибке и перечислит допустимые выборы аргументов (если указаны) или имена подпарсеров в сообщении об ошибке. Если пользователь хочет включить предложения для неправильно набранных выборов аргументов и имен подпарсеров, эту возможность можно включить, установив `suggest_on_error` в `True`. Обратите внимание, что это применимо только к аргументам, когда указанные варианты выбора являются строками: ```python >>> parser = argparse.ArgumentParser(suggest_on_error=True) >>> parser.add_argument('--action', choices=['debug', 'dryrun']) >>> parser.parse_args(['--action', 'debugg']) usage: tester.py [-h] [--action {debug,dryrun}] tester.py: error: argument --action: invalid choice: 'debugg', maybe you meant 'debug'? (choose from debug, dryrun) ``` Если вы пишете код, который должен быть совместим с более старыми версиями Python и хотите по возможности использовать `suggest_on_error`, когда он доступен, вы можете установить его как атрибут после инициализации парсера вместо использования именованного аргумента: ```python >>> parser = argparse.ArgumentParser(description='Process some integers.') >>> parser.suggest_on_error = True ``` Добавлено в версии 3.14. ### color По умолчанию справочное сообщение выводится в цвете с использованием [ANSI escape-последовательностей](https://python-all.ru/3/library/argparse.html). Если нужны неформатированные текстовые справки, можно отключить это [в локальном окружении](https://python-all.ru/3/using/cmdline.html#using-on-controlling-color) или в самом синтаксическом анализаторе, установив `color` в `False`: ```python >>> parser = argparse.ArgumentParser(description='Process some integers.', ... color=False) >>> parser.add_argument('--action', choices=['sum', 'max']) >>> parser.add_argument('integers', metavar='N', type=int, nargs='+', ... help='an integer for the accumulator') >>> parser.parse_args(['--help']) ``` Обратите внимание, что когда `color=True`, цветной вывод зависит как от переменных окружения, так и от возможностей терминала. Однако если `color=False`, цветной вывод всегда отключён, даже если установлены такие переменные окружения, как `FORCE_COLOR`. > **Примечание** > > Сообщения об ошибках будут включать цветовые коды при перенаправлении stderr в файл. Чтобы избежать этого, установите переменную окружения [`NO_COLOR`](https://python-all.ru/3/library/argparse.html), [`PYTHON_COLORS`](https://python-all.ru/3/using/cmdline.html#envvar-PYTHON_COLORS) (например, `NO_COLOR=1 python script.py 2> errors.txt`). Добавлено в версии 3.14. ## Метод add\_argument() #### `ArgumentParser.add_argument(name or flags..., *[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest][, deprecated])` Определяет, как должен разбираться один аргумент командной строки. Каждый параметр подробно описан ниже, а кратко они таковы: - [name or flags](https://python-all.ru/3/library/argparse.html#name-or-flags) – имя или список строк параметров, например `'foo'` или `'-f', '--foo'`. - [action](https://python-all.ru/3/library/argparse.html#action) – базовый тип действия, которое выполняется при встрече этого аргумента в командной строке. - [nargs](https://python-all.ru/3/library/argparse.html#nargs) – количество аргументов командной строки, которое должно быть потреблено. - [const](https://python-all.ru/3/library/argparse.html#const) – постоянное значение, требуемое некоторыми значениями [action](https://python-all.ru/3/library/argparse.html#action) и [nargs](https://python-all.ru/3/library/argparse.html#nargs). - [default](https://python-all.ru/3/library/argparse.html#default) – значение, которое используется, если аргумент отсутствует в командной строке и в объекте namespace. - [type](https://python-all.ru/3/library/argparse.html#type) – тип, в который следует преобразовать аргумент командной строки. - [choices](https://python-all.ru/3/library/argparse.html#choices) – последовательность допустимых значений для аргумента. - [required](https://python-all.ru/3/library/argparse.html#required) – может ли параметр командной строки быть опущен (только для опциональных параметров). - [help](https://python-all.ru/3/library/argparse.html#help) – краткое описание того, что делает аргумент. - [metavar](https://python-all.ru/3/library/argparse.html#metavar) – имя аргумента в сообщениях об использовании. - [dest](https://python-all.ru/3/library/argparse.html#dest) – имя атрибута, добавляемого в объект, возвращаемый [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args). - [deprecated](https://python-all.ru/3/library/argparse.html#deprecated) – указывает, устарел ли аргумент. Метод возвращает объект [`Action`](https://python-all.ru/3/library/argparse.html#argparse.Action), представляющий аргумент. В следующих разделах описывается, как используется каждый из этих параметров. ### name or flags Методу [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument) необходимо знать, ожидается ли опциональный аргумент (например, `-f` или `--foo`) или позиционный (например, список имён файлов). Поэтому первыми аргументами, передаваемыми в `add_argument()`, должны быть либо серия флагов, либо просто имя аргумента. Например, опциональный аргумент можно создать так: ```python >>> parser.add_argument('-f', '--foo') ``` а позиционный – так: ```python >>> parser.add_argument('bar') ``` При вызове [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) опциональные аргументы опознаются по префиксу `-`, а остальные аргументы считаются позиционными: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-f', '--foo') >>> parser.add_argument('bar') >>> parser.parse_args(['BAR']) Namespace(bar='BAR', foo=None) >>> parser.parse_args(['BAR', '--foo', 'FOO']) Namespace(bar='BAR', foo='FOO') >>> parser.parse_args(['--foo', 'FOO']) usage: PROG [-h] [-f FOO] bar PROG: error: the following arguments are required: bar ``` По умолчанию `argparse` автоматически управляет внутренними и отображаемыми именами аргументов, упрощая процесс без необходимости дополнительной настройки. Таким образом, не требуется указывать параметры [dest](https://python-all.ru/3/library/argparse.html#dest) и [metavar](https://python-all.ru/3/library/argparse.html#metavar). Для опциональных аргументов [dest](https://python-all.ru/3/library/argparse.html#dest) по умолчанию равен имени аргумента, причём символы подчёркивания `_` заменяют дефисы `-`. Параметр [metavar](https://python-all.ru/3/library/argparse.html#metavar) по умолчанию равен имени в верхнем регистре. Например: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('--foo-bar') >>> parser.parse_args(['--foo-bar', 'FOO-BAR']) Namespace(foo_bar='FOO-BAR') >>> parser.print_help() usage: [-h] [--foo-bar FOO-BAR] optional arguments: -h, --help show this help message and exit --foo-bar FOO-BAR ``` ### action Объекты [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) связывают аргументы командной строки с действиями. Эти действия могут делать с аргументами практически что угодно, но чаще всего они просто добавляют атрибут в объект, возвращаемый [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args). Ключевой аргумент `action` определяет, как следует обрабатывать аргументы командной строки. Доступны следующие действия: - `'store'` – просто сохраняет значение аргумента. Это действие по умолчанию. - `'store_const'` – сохраняет значение, указанное ключевым аргументом [const](https://python-all.ru/3/library/argparse.html#const); обратите внимание, что ключевой аргумент [const](https://python-all.ru/3/library/argparse.html#const) по умолчанию равен `None`. Действие `'store_const'` чаще всего используется с опциональными аргументами, задающими какой-либо флаг. Например: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action='store_const', const=42) >>> parser.parse_args(['--foo']) Namespace(foo=42) ``` - `'store_true'` и `'store_false'` – частные случаи `'store_const'`, которые сохраняют значения `True` и `False` соответственно, со значениями по умолчанию `False` и `True`: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action='store_true') >>> parser.add_argument('--bar', action='store_false') >>> parser.add_argument('--baz', action='store_false') >>> parser.parse_args('--foo --bar'.split()) Namespace(foo=True, bar=False, baz=True) ``` - `'append'` – добавляет каждое значение аргумента в список. Удобно, когда параметр можно указать несколько раз. Если значением по умолчанию является непустой список, разобранное значение будет начинаться с элементов этого списка, а все значения из командной строки будут добавлены после них. Пример использования: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action='append', default=['0']) >>> parser.parse_args('--foo 1 --foo 2'.split()) Namespace(foo=['0', '1', '2']) ``` - `'append_const'` – добавляет значение, указанное ключевым аргументом [const](https://python-all.ru/3/library/argparse.html#const), в список; обратите внимание, что [const](https://python-all.ru/3/library/argparse.html#const) по умолчанию равно `None`. Действие `'append_const'` обычно полезно, когда несколько аргументов должны сохранять константы в один и тот же список. Например: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--str', dest='types', action='append_const', const=str) >>> parser.add_argument('--int', dest='types', action='append_const', const=int) >>> parser.parse_args('--str --int'.split()) Namespace(types=[, ]) ``` - `'extend'` – добавляет каждый элемент многозначного аргумента в список. Действие `'extend'` обычно используется с ключевым аргументом [nargs](https://python-all.ru/3/library/argparse.html#nargs), имеющим значение `'+'` или `'*'`. Обратите внимание: если [nargs](https://python-all.ru/3/library/argparse.html#nargs) равно `None` (по умолчанию) или `'?'`, каждый символ строки аргумента будет добавлен в список. Пример использования: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument("--foo", action="extend", nargs="+", type=str) >>> parser.parse_args(["--foo", "f1", "--foo", "f2", "f3", "f4"]) Namespace(foo=['f1', 'f2', 'f3', 'f4']) ``` Добавлено в версии 3.8. - `'count'` – подсчитывает, сколько раз встречается аргумент. Например, это удобно для увеличения уровня подробности вывода: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--verbose', '-v', action='count', default=0) >>> parser.parse_args(['-vvv']) Namespace(verbose=3) ``` Обратите внимание: значение *default* будет `None`, если только оно явно не установлено в *0*. - `'help'` – выводит полное справочное сообщение для всех параметров текущего анализатора и завершает работу. По умолчанию действие справки автоматически добавляется в анализатор. Подробности о том, как формируется вывод, см. в [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser). - `'version'` – ожидает именованный аргумент `version=` в вызове [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument) и при вызове выводит информацию о версии и завершает работу: ```python >>> import argparse >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('--version', action='version', version='%(prog)s 2.0') >>> parser.parse_args(['--version']) PROG 2.0 ``` Можно также указать произвольное действие, передав подкласс [`Action`](https://python-all.ru/3/library/argparse.html#argparse.Action) (например, [`BooleanOptionalAction`](https://python-all.ru/3/library/argparse.html#argparse.BooleanOptionalAction)) или другой объект, реализующий тот же интерфейс. Только действия, которые потребляют аргументы командной строки (например, `'store'`, `'append'`, `'extend'` или пользовательские действия с ненулевым `nargs`), могут использоваться с позиционными аргументами. Рекомендуемый способ создания пользовательского действия – расширить [`Action`](https://python-all.ru/3/library/argparse.html#argparse.Action), переопределив метод `__call__()` и, при необходимости, методы `__init__()` и `format_usage()`. Также можно зарегистрировать пользовательские действия с помощью метода [`register()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.register) и ссылаться на них по зарегистрированному имени. Пример пользовательского действия: ```python >>> class FooAction(argparse.Action): ... def __init__(self, option_strings, dest, nargs=None, **kwargs): ... if nargs is not None: ... raise ValueError("nargs not allowed") ... super().__init__(option_strings, dest, **kwargs) ... def __call__(self, parser, namespace, values, option_string=None): ... print('%r %r %r' % (namespace, values, option_string)) ... setattr(namespace, self.dest, values) ... >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action=FooAction) >>> parser.add_argument('bar', action=FooAction) >>> args = parser.parse_args('1 --foo 2'.split()) Namespace(bar=None, foo=None) '1' None Namespace(bar='1', foo=None) '2' '--foo' >>> args Namespace(bar='1', foo='2') ``` Подробнее см. в [`Action`](https://python-all.ru/3/library/argparse.html#argparse.Action). ### nargs Объекты [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) обычно связывают один аргумент командной строки с одним выполняемым действием. Именованный аргумент `nargs` связывает другое количество аргументов командной строки с одним действием. См. также [Указание неоднозначных аргументов](https://python-all.ru/3/howto/argparse.html#specifying-ambiguous-arguments). Поддерживаемые значения: - `N` (целое число). Аргументы `N` из командной строки будут собраны в список. Например: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', nargs=2) >>> parser.add_argument('bar', nargs=1) >>> parser.parse_args('c --foo a b'.split()) Namespace(bar=['c'], foo=['a', 'b']) ``` Обратите внимание, что `nargs=1` создаёт список из одного элемента. Это отличается от поведения по умолчанию, при котором элемент создаётся сам по себе. - `'?'`. Если возможно, будет потреблён один аргумент командной строки и выдан как отдельный элемент. Если аргумент командной строки отсутствует, будет выдано значение из [default](https://python-all.ru/3/library/argparse.html#default). Обратите внимание, что для необязательных аргументов есть дополнительный случай: строка параметра присутствует, но за ней не следует аргумент командной строки. В этом случае будет выдано значение из [const](https://python-all.ru/3/library/argparse.html#const). Некоторые примеры для иллюстрации: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', nargs='?', const='c', default='d') >>> parser.add_argument('bar', nargs='?', default='d') >>> parser.parse_args(['XX', '--foo', 'YY']) Namespace(bar='XX', foo='YY') >>> parser.parse_args(['XX', '--foo']) Namespace(bar='XX', foo='c') >>> parser.parse_args([]) Namespace(bar='d', foo='d') ``` Одно из наиболее распространённых применений `nargs='?'` – разрешение необязательных входных и выходных файлов: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('infile', nargs='?') >>> parser.add_argument('outfile', nargs='?') >>> parser.parse_args(['input.txt', 'output.txt']) Namespace(infile='input.txt', outfile='output.txt') >>> parser.parse_args(['input.txt']) Namespace(infile='input.txt', outfile=None) >>> parser.parse_args([]) Namespace(infile=None, outfile=None) ``` - `'*'`. Все присутствующие аргументы командной строки собираются в список. Обратите внимание, что обычно не имеет смысла указывать более одного позиционного аргумента с `nargs='*'`, но возможно несколько необязательных аргументов с `nargs='*'`. Например: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', nargs='*') >>> parser.add_argument('--bar', nargs='*') >>> parser.add_argument('baz', nargs='*') >>> parser.parse_args('a b --foo x y --bar 1 2'.split()) Namespace(bar=['1', '2'], baz=['a', 'b'], foo=['x', 'y']) ``` - `'+'`. Как и `'*'`, все присутствующие аргументы командной строки собираются в список. Дополнительно будет сгенерировано сообщение об ошибке, если не было хотя бы одного аргумента командной строки. Например: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('foo', nargs='+') >>> parser.parse_args(['a', 'b']) Namespace(foo=['a', 'b']) >>> parser.parse_args([]) usage: PROG [-h] foo [foo ...] PROG: error: the following arguments are required: foo ``` Если именованный аргумент `nargs` не указан, количество потребляемых аргументов определяется действием [action](https://python-all.ru/3/library/argparse.html#action). Обычно это означает, что будет потреблён один аргумент командной строки и выдан один элемент (не список). Действия, которые не потребляют аргументы командной строки (например, `'store_const'`), устанавливают `nargs=0`. ### const Аргумент `const` функции [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument) используется для хранения постоянных значений, которые не считываются из командной строки, но требуются для различных действий [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser). Два наиболее распространённых его применения: - Когда [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument) вызывается с `action='store_const'` или `action='append_const'`. Эти действия добавляют значение `const` к одному из атрибутов объекта, возвращаемого [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args). Примеры см. в описании [action](https://python-all.ru/3/library/argparse.html#action). Если `const` не передан в `add_argument()`, он получит значение по умолчанию `None`. - Когда [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument) вызывается со строками параметров (например, `-f` или `--foo`) и `nargs='?'`. Это создаёт необязательный аргумент, за которым может следовать ноль или один аргумент командной строки. При разборе командной строки, если встречена строка параметра без следующего за ней аргумента командной строки, будет использовано значение из `const`. Примеры см. в описании [nargs](https://python-all.ru/3/library/argparse.html#nargs). Изменено в версии 3.11: `const=None` по умолчанию, в том числе когда `action='append_const'` или `action='store_const'`. ### default Все необязательные аргументы и некоторые позиционные аргументы могут быть опущены в командной строке. Именованный аргумент `default` функции [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument), значение которого по умолчанию равно `None`, указывает, какое значение следует использовать, если аргумент командной строки отсутствует. Для необязательных аргументов значение `default` используется, когда строка параметра отсутствовала в командной строке: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default=42) >>> parser.parse_args(['--foo', '2']) Namespace(foo='2') >>> parser.parse_args([]) Namespace(foo=42) ``` Если в целевом пространстве имён уже установлен атрибут, действие *default* не перезапишет его: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default=42) >>> parser.parse_args([], namespace=argparse.Namespace(foo=101)) Namespace(foo=101) ``` Если значение `default` является строкой, анализатор разбирает его так, как если бы это был аргумент командной строки. В частности, анализатор применяет любой аргумент преобразования [type](https://python-all.ru/3/library/argparse.html#type), если он указан, перед установкой атрибута в возвращаемом значении [`Namespace`](https://python-all.ru/3/library/argparse.html#argparse.Namespace). В противном случае анализатор использует значение как есть: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--length', default='10', type=int) >>> parser.add_argument('--width', default=10.5, type=int) >>> parser.parse_args() Namespace(length=10, width=10.5) ``` Для позиционных аргументов с [nargs](https://python-all.ru/3/library/argparse.html#nargs), равным `?` или `*`, значение `default` используется, когда аргумент командной строки отсутствовал: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('foo', nargs='?', default=42) >>> parser.parse_args(['a']) Namespace(foo='a') >>> parser.parse_args([]) Namespace(foo=42) ``` Поскольку `nargs='*'` собирает все предоставленные значения в список, отсутствующий позиционный аргумент даёт пустой список (`[]`). Только значение *default*, не равное `None`, переопределяет это (поэтому `default=None` по-прежнему даёт `[]`). Для аргументов [required](https://python-all.ru/3/library/argparse.html#required) значение `default` игнорируется. Например, это относится к позиционным аргументам со значениями [nargs](https://python-all.ru/3/library/argparse.html#nargs), отличными от `?` или `*`, или к необязательным аргументам, помеченным как `required=True`. Указание `default=argparse.SUPPRESS` приводит к тому, что атрибут не добавляется, если аргумент командной строки отсутствовал: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default=argparse.SUPPRESS) >>> parser.parse_args([]) Namespace() >>> parser.parse_args(['--foo', '1']) Namespace(foo='1') ``` ### тип По умолчанию анализатор считывает аргументы командной строки как простые строки. Однако довольно часто строку командной строки следует интерпретировать как другой тип, например [`float`](https://python-all.ru/3/library/functions.html#float) или [`int`](https://python-all.ru/3/library/functions.html#int). Именованный аргумент `type` функции [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument) позволяет выполнять любые необходимые проверки и преобразования типов. Если именованный аргумент [type](https://python-all.ru/3/library/argparse.html#type) используется вместе с [default](https://python-all.ru/3/library/argparse.html#default), преобразователь типа применяется только в том случае, если значение по умолчанию является строкой. Аргумент `type` может быть вызываемым объектом, принимающим одну строку, или именем зарегистрированного типа (см. [`register()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.register)). Если функция вызывает исключение [`ArgumentTypeError`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentTypeError), [`TypeError`](https://python-all.ru/3/library/exceptions.html#TypeError) или [`ValueError`](https://python-all.ru/3/library/exceptions.html#ValueError), исключение перехватывается и выводится хорошо оформленное сообщение об ошибке. Другие типы исключений не обрабатываются. Распространённые встроенные типы и функции можно использовать в качестве преобразователей типов: ```python import argparse import pathlib parser = argparse.ArgumentParser() parser.add_argument('count', type=int) parser.add_argument('distance', type=float) parser.add_argument('street', type=ascii) parser.add_argument('code_point', type=ord) parser.add_argument('datapath', type=pathlib.Path) ``` Пользовательские функции также можно использовать: ```pycon >>> def hyphenated(string): ... return '-'.join([word[:4] for word in string.casefold().split()]) ... >>> parser = argparse.ArgumentParser() >>> _ = parser.add_argument('short_title', type=hyphenated) >>> parser.parse_args(['"The Tale of Two Cities"']) Namespace(short_title='"the-tale-of-two-citi') ``` Функция [`bool()`](https://python-all.ru/3/library/functions.html#bool) не рекомендуется в качестве преобразователя типа. Всё, что она делает – преобразует пустые строки в `False`, а непустые в `True`. Обычно это не то, что нужно: ```python >>> parser = argparse.ArgumentParser() >>> _ = parser.add_argument('--verbose', type=bool) >>> parser.parse_args(['--verbose', 'False']) Namespace(verbose=True) ``` См. [`BooleanOptionalAction`](https://python-all.ru/3/library/argparse.html#argparse.BooleanOptionalAction) или `action='store_true'` для распространённых альтернатив. В целом, ключевое слово `type` – это удобство, которое следует использовать только для простых преобразований, способных вызывать лишь одно из трёх поддерживаемых исключений. Всё, что связано с более сложной обработкой ошибок или управлением ресурсами, должно выполняться ниже по потоку после разбора аргументов. Например, преобразования JSON или YAML содержат сложные случаи ошибок, которые требуют более детального отчёта, чем может дать ключевое слово `type`. Сообщение [`JSONDecodeError`](https://python-all.ru/3/library/json.html#json.JSONDecodeError) не будет хорошо отформатировано, а исключение [`FileNotFoundError`](https://python-all.ru/3/library/exceptions.html#FileNotFoundError) вообще не будет обработано. Даже [`FileType`](https://python-all.ru/3/library/argparse.html#argparse.FileType) имеет ограничения при использовании с ключевым словом `type`. Если один аргумент использует `FileType`, а затем следующий аргумент завершается ошибкой, сообщается об ошибке, но файл не закрывается автоматически. В этом случае лучше подождать, пока завершит работу парсер, а затем использовать оператор [`with`](https://python-all.ru/3/reference/compound_stmts.html#with) для управления файлами. Для проверок типов, которые просто сравнивают с фиксированным набором значений, рассмотрите вместо этого использование ключевого слова [choices](https://python-all.ru/3/library/argparse.html#choices). ### choices Некоторые аргументы командной строки должны выбираться из ограниченного набора значений. Это можно обработать, передав объект-последовательность в качестве ключевого аргумента *choices* в [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument). При разборе командной строки значения аргументов будут проверены, и если аргумент не окажется среди допустимых значений, будет выведено сообщение об ошибке: ```python >>> parser = argparse.ArgumentParser(prog='game.py') >>> parser.add_argument('move', choices=['rock', 'paper', 'scissors']) >>> parser.parse_args(['rock']) Namespace(move='rock') >>> parser.parse_args(['fire']) usage: game.py [-h] {rock,paper,scissors} game.py: error: argument move: invalid choice: 'fire' (choose from 'rock', 'paper', 'scissors') ``` В качестве значения *choices* можно передать любую последовательность, поэтому поддерживаются объекты [`list`](https://python-all.ru/3/library/stdtypes.html#list), объекты [`tuple`](https://python-all.ru/3/library/stdtypes.html#tuple) и пользовательские последовательности. Использование [`enum.Enum`](https://python-all.ru/3/library/enum.html#enum.Enum) не рекомендуется, поскольку сложно контролировать его отображение в сообщениях об использовании, справке и ошибках. Обратите внимание, что *choices* проверяются после применения любых преобразований [type](https://python-all.ru/3/library/argparse.html#type), поэтому объекты в *choices* должны соответствовать указанному [type](https://python-all.ru/3/library/argparse.html#type). Из-за этого *choices* могут выглядеть непривычно в сообщениях об использовании, справке или ошибках. Чтобы *choices* оставались удобными для пользователя, рассмотрите пользовательскую обёртку типа, которая преобразует и форматирует значения, либо опустите [type](https://python-all.ru/3/library/argparse.html#type) и обрабатывайте преобразование в коде приложения. Форматированные choices переопределяют значение *metavar* по умолчанию, которое обычно выводится из *dest*. Обычно это именно то, что нужно, поскольку пользователь никогда не видит параметр *dest*. Если такое отображение нежелательно (например, из-за большого количества вариантов), просто укажите явный [metavar](https://python-all.ru/3/library/argparse.html#metavar). ### required В целом, модуль `argparse` предполагает, что флаги вида `-f` и `--bar` обозначают *необязательные* аргументы, которые всегда можно опустить в командной строке. Чтобы сделать опцию *обязательной*, для ключевого аргумента `required=` функции [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument) можно указать `True`: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', required=True) >>> parser.parse_args(['--foo', 'BAR']) Namespace(foo='BAR') >>> parser.parse_args([]) usage: [-h] --foo FOO : error: the following arguments are required: --foo ``` Как показано в примере, если опция помечена как `required`, [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) сообщит об ошибке, если эта опция отсутствует в командной строке. > **Примечание** > > Обязательные опции обычно считаются дурным тоном, поскольку пользователи ожидают, что *опции* будут *необязательными*, поэтому их следует по возможности избегать. ### help Значение `help` – это строка с кратким описанием аргумента. Когда пользователь запрашивает справку (обычно с помощью `-h` или `--help` в командной строке), эти описания `help` отображаются для каждого аргумента. Строки `help` могут содержать различные спецификаторы формата, чтобы избежать повторения таких элементов, как имя программы или [значение по умолчанию](https://python-all.ru/3/library/argparse.html#default) аргумента. Доступные спецификаторы включают имя программы, `%(prog)s` и большинство ключевых аргументов функции [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument), например `%(default)s`, `%(type)s` и т.д.: ```python >>> parser = argparse.ArgumentParser(prog='frobble') >>> parser.add_argument('bar', nargs='?', type=int, default=42, ... help='the bar to %(prog)s (default: %(default)s)') >>> parser.print_help() usage: frobble [-h] [bar] positional arguments: bar the bar to frobble (default: 42) options: -h, --help show this help message and exit ``` Поскольку строка справки поддерживает %-форматирование, если требуется, чтобы в ней отображался литерал `%`, его нужно экранировать как `%%`. `argparse` поддерживает скрытие записи справки для определённых опций путём установки значения `help` в `argparse.SUPPRESS`: ```python >>> parser = argparse.ArgumentParser(prog='frobble') >>> parser.add_argument('--foo', help=argparse.SUPPRESS) >>> parser.print_help() usage: frobble [-h] options: -h, --help show this help message and exit ``` ### metavar Когда [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) генерирует сообщения справки, ему нужен способ ссылаться на каждый ожидаемый аргумент. По умолчанию объекты `ArgumentParser` используют значение [dest](https://python-all.ru/3/library/argparse.html#dest) в качестве «имени» каждого объекта. Для действий с позиционными аргументами значение [dest](https://python-all.ru/3/library/argparse.html#dest) используется напрямую, а для действий с необязательными аргументами значение [dest](https://python-all.ru/3/library/argparse.html#dest) пишется заглавными буквами. Таким образом, одиночный позиционный аргумент с `dest='bar'` будет называться `bar`. Одиночный необязательный аргумент `--foo`, за которым должен следовать один аргумент командной строки, будет называться `FOO`. Пример: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo') >>> parser.add_argument('bar') >>> parser.parse_args('X --foo Y'.split()) Namespace(bar='X', foo='Y') >>> parser.print_help() usage: [-h] [--foo FOO] bar positional arguments: bar options: -h, --help show this help message and exit --foo FOO ``` Альтернативное имя можно указать с помощью `metavar`: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', metavar='YYY') >>> parser.add_argument('bar', metavar='XXX') >>> parser.parse_args('X --foo Y'.split()) Namespace(bar='X', foo='Y') >>> parser.print_help() usage: [-h] [--foo YYY] XXX positional arguments: XXX options: -h, --help show this help message and exit --foo YYY ``` Обратите внимание, что `metavar` изменяет только *отображаемое* имя – имя атрибута объекта [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) по-прежнему определяется значением [dest](https://python-all.ru/3/library/argparse.html#dest). Разные значения `nargs` могут привести к тому, что метапеременная будет использована несколько раз. Передача кортежа в `metavar` задаёт различное отображение для каждого из аргументов: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-x', nargs=2) >>> parser.add_argument('--foo', nargs=2, metavar=('bar', 'baz')) >>> parser.print_help() usage: PROG [-h] [-x X X] [--foo bar baz] options: -h, --help show this help message and exit -x X X --foo bar baz ``` ### dest Большинство действий [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) добавляют некоторое значение как атрибут объекта, возвращаемого [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args). Имя этого атрибута определяется ключевым аргументом `dest` функции [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument). Для действий с позиционными аргументами `dest` обычно передаётся первым аргументом в `add_argument()`: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('bar') >>> parser.parse_args(['XXX']) Namespace(bar='XXX') ``` Для действий необязательных аргументов значение `dest` обычно выводится из строк опций. [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) генерирует значение `dest`, беря первую длинную строку опции и удаляя начальную строку `--`. Если длинные строки опций не были предоставлены, `dest` будет получен из первой короткой строки опции путем удаления начального символа `-`. Любые внутренние символы `-` будут преобразованы в символы `_`, чтобы гарантировать, что строка является допустимым именем атрибута. Примеры ниже иллюстрируют это поведение: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('-f', '--foo-bar', '--foo') >>> parser.add_argument('-x', '-y') >>> parser.parse_args('-f 1 -x 2'.split()) Namespace(foo_bar='1', x='2') >>> parser.parse_args('--foo 1 -y 2'.split()) Namespace(foo_bar='1', x='2') ``` `dest` позволяет указать пользовательское имя атрибута: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', dest='bar') >>> parser.parse_args('--foo XXX'.split()) Namespace(bar='XXX') ``` Несколько аргументов могут ссылаться на один и тот же `dest`. По умолчанию используется значение из последнего такого аргумента, переданного в командной строке. Используйте `action='append'`, чтобы собирать значения от всех таких аргументов в список. Для конфликтующих *строк параметров*, а не`dest` имён, см. [conflict\_handler](https://python-all.ru/3/library/argparse.html#conflict-handler). ### устарело В течение жизненного цикла проекта некоторые аргументы могут потребовать удаления из командной строки. Перед удалением следует сообщить пользователям, что эти аргументы устарели и будут удалены. Ключевой аргумент `deprecated` метода [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument), который по умолчанию равен `False`, указывает, что аргумент устарел и будет удалён в будущем. Для аргументов, если `deprecated` равно `True`, то при использовании аргумента будет выведено предупреждение в [`sys.stderr`](https://python-all.ru/3/library/sys.html#sys.stderr): ```python >>> import argparse >>> parser = argparse.ArgumentParser(prog='snake.py') >>> parser.add_argument('--legs', default=0, type=int, deprecated=True) >>> parser.parse_args([]) Namespace(legs=0) >>> parser.parse_args(['--legs', '4']) snake.py: warning: option '--legs' is deprecated Namespace(legs=4) ``` Добавлено в версии 3.13. ### Классы действий `Action` классы реализуют Action API – вызываемый объект, который возвращает вызываемый объект, обрабатывающий аргументы из командной строки. Любой объект, соответствующий этому API, может быть передан в качестве параметра `action` в [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument). #### `class argparse.Action(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)` `Action` объекты используются [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) для представления информации, необходимой для разбора одного аргумента из одной или нескольких строк командной строки. Класс `Action` должен принимать два позиционных аргумента и любые ключевые аргументы, переданные в [`ArgumentParser.add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument), кроме самого `action`. Экземпляры `Action` (или возвращаемое значение любого вызываемого объекта для параметра `action`) должны иметь атрибуты `dest`, `option_strings`, `default`, `type`, `required`, `help` и т.д. Проще всего гарантировать наличие этих атрибутов – вызвать `Action.__init__()`. #### `__call__(parser, namespace, values, option_string=None)` Экземпляры `Action` должны быть вызываемыми, поэтому подклассы должны переопределять метод `__call__()`, который принимает четыре параметра: - *parser* – объект [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser), содержащий это действие. - *namespace* – объект [`Namespace`](https://python-all.ru/3/library/argparse.html#argparse.Namespace), который будет возвращён [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args). Обычно действия добавляют атрибут к этому объекту с помощью [`setattr()`](https://python-all.ru/3/library/functions.html#setattr). - *values* – связанные аргументы командной строки с применёнными преобразованиями типов. Преобразования типов задаются ключевым аргументом [type](https://python-all.ru/3/library/argparse.html#type) в [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument). - *option\_string* – строка параметра, которая использовалась для вызова этого действия. Аргумент `option_string` необязателен и будет отсутствовать, если действие связано с позиционным аргументом. Метод `__call__()` может выполнять произвольные действия, но обычно устанавливает атрибуты объекта `namespace` на основе `dest` и `values`. #### `format_usage()` Подклассы `Action` могут определить метод `format_usage()` без аргументов, возвращающий строку, которая будет использоваться при выводе справки об использовании программы. Если такой метод не предоставлен, используется разумное значение по умолчанию. #### `class argparse.BooleanOptionalAction` Подкласс [`Action`](https://python-all.ru/3/library/argparse.html#argparse.Action) для обработки булевых флагов с положительными и отрицательными параметрами. Добавление одного аргумента, например `--foo`, автоматически создаёт оба параметра `--foo` и `--no-foo`, сохраняя `True` и `False` соответственно: ```python >>> import argparse >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action=argparse.BooleanOptionalAction) >>> parser.parse_args(['--no-foo']) Namespace(foo=False) ``` Добавлено в версии 3.9. ## Метод parse\_args() #### `ArgumentParser.parse_args(args=None, namespace=None)` Преобразует строки аргументов в объекты и назначает их в качестве атрибутов пространства имён. Возвращает заполненное пространство имён. Предыдущие вызовы [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument) определяют, какие объекты создаются и как они назначаются. Подробнее см. документацию `add_argument()`. - [args](https://python-all.ru/3/library/argparse.html#args) – список строк для разбора. По умолчанию берётся из [`sys.argv`](https://python-all.ru/3/library/sys.html#sys.argv). - [namespace](https://python-all.ru/3/library/argparse.html#namespace) – объект, в который будут помещены атрибуты. По умолчанию – новый пустой объект [`Namespace`](https://python-all.ru/3/library/argparse.html#argparse.Namespace). ### Синтаксис значений параметров Метод [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) поддерживает несколько способов указания значения параметра (если он принимает значение). В простейшем случае параметр и его значение передаются как два отдельных аргумента: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-x') >>> parser.add_argument('--foo') >>> parser.parse_args(['-x', 'X']) Namespace(foo=None, x='X') >>> parser.parse_args(['--foo', 'FOO']) Namespace(foo='FOO', x=None) ``` Для длинных параметров (с именами длиннее одного символа) параметр и значение могут быть переданы как один аргумент командной строки, используя `=` для их разделения: ```python >>> parser.parse_args(['--foo=FOO']) Namespace(foo='FOO', x=None) ``` Для коротких опций (опции длиной в один символ) опция и её значение могут быть объединены: ```python >>> parser.parse_args(['-xX']) Namespace(foo=None, x='X') ``` Несколько коротких опций можно объединить, используя только один префикс `-`, при условии, что только последняя опция (или ни одна из них) требует значения: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-x', action='store_true') >>> parser.add_argument('-y', action='store_true') >>> parser.add_argument('-z') >>> parser.parse_args(['-xyzZ']) Namespace(x=True, y=True, z='Z') ``` ### Недопустимые аргументы При разборе командной строки [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) проверяет различные ошибки, включая неоднозначные опции, некорректные типы, неверные опции, неправильное количество позиционных аргументов и т.д. При обнаружении такой ошибки программа завершается и выводит сообщение об ошибке вместе со справкой по использованию: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('--foo', type=int) >>> parser.add_argument('bar', nargs='?') >>> # недопустимый тип >>> parser.parse_args(['--foo', 'spam']) usage: PROG [-h] [--foo FOO] [bar] PROG: error: argument --foo: invalid int value: 'spam' >>> # недопустимая опция >>> parser.parse_args(['--bar']) usage: PROG [-h] [--foo FOO] [bar] PROG: error: no such option: --bar >>> # неверное количество аргументов >>> parser.parse_args(['spam', 'badger']) usage: PROG [-h] [--foo FOO] [bar] PROG: error: extra arguments found: badger ``` ### Аргументы, содержащие `-` Метод [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) старается выдавать ошибки всякий раз, когда пользователь явно ошибся, но некоторые ситуации по своей природе неоднозначны. Например, аргумент командной строки `-1` может быть как попыткой указать опцию, так и попыткой передать позиционный аргумент. Метод `parse_args()` здесь действует осторожно: позиционные аргументы могут начинаться с `-` только если они похожи на отрицательные числа, и в анализаторе нет опций, которые выглядят как отрицательные числа: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-x') >>> parser.add_argument('foo', nargs='?') >>> # нет опций с отрицательными числами, поэтому -1 – позиционный аргумент >>> parser.parse_args(['-x', '-1']) Namespace(foo=None, x='-1') >>> # нет опций с отрицательными числами, поэтому -1 и -5 – позиционные аргументы >>> parser.parse_args(['-x', '-1', '-5']) Namespace(foo='-5', x='-1') >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-1', dest='one') >>> parser.add_argument('foo', nargs='?') >>> # опции с отрицательными числами присутствуют, поэтому -1 – это опция >>> parser.parse_args(['-1', 'X']) Namespace(foo=None, one='X') >>> # опции с отрицательными числами присутствуют, поэтому -2 – это опция >>> parser.parse_args(['-2']) usage: PROG [-h] [-1 ONE] [foo] PROG: error: no such option: -2 >>> # опции с отрицательными числами присутствуют, поэтому обе -1 – это опции >>> parser.parse_args(['-1', '-1']) usage: PROG [-h] [-1 ONE] [foo] PROG: error: argument -1: expected one argument ``` Если позиционные аргументы должны начинаться с `-` и не похожи на отрицательные числа, можно вставить псевдоаргумент `'--'`, который сообщает [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args), что всё после него является позиционным аргументом: ```python >>> parser.parse_args(['--', '-f']) Namespace(foo='-f', one=None) ``` См. также [руководство по argparse о неоднозначных аргументах](https://python-all.ru/3/howto/argparse.html#specifying-ambiguous-arguments) для получения дополнительных сведений. ### Сокращения аргументов (совпадение по префиксу) Метод [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) [по умолчанию](https://python-all.ru/3/library/argparse.html#allow-abbrev) позволяет сокращать длинные опции до префикса, если сокращение является однозначным (префикс соответствует уникальной опции): ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-bacon') >>> parser.add_argument('-badger') >>> parser.parse_args('-bac MMM'.split()) Namespace(bacon='MMM', badger=None) >>> parser.parse_args('-bad WOOD'.split()) Namespace(bacon=None, badger='WOOD') >>> parser.parse_args('-ba BA'.split()) usage: PROG [-h] [-bacon BACON] [-badger BADGER] PROG: error: ambiguous option: -ba could match -badger, -bacon ``` Выдаётся ошибка для аргументов, которые могут соответствовать нескольким опциям. Эту возможность можно отключить, установив [allow\_abbrev](https://python-all.ru/3/library/argparse.html#allow-abbrev) в `False`. ### За пределами `sys.argv` Иногда бывает полезно, чтобы [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) разбирал аргументы, отличные от аргументов [`sys.argv`](https://python-all.ru/3/library/sys.html#sys.argv). Это можно сделать, передав список строк в [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args). Это удобно для тестирования в интерактивной оболочке: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument( ... 'integers', metavar='int', type=int, choices=range(10), ... nargs='+', help='an integer in the range 0..9') >>> parser.add_argument( ... '--sum', dest='accumulate', action='store_const', const=sum, ... default=max, help='sum the integers (default: find the max)') >>> parser.parse_args(['1', '2', '3', '4']) Namespace(accumulate=, integers=[1, 2, 3, 4]) >>> parser.parse_args(['1', '2', '3', '4', '--sum']) Namespace(accumulate=, integers=[1, 2, 3, 4]) ``` ### Объект Namespace #### `class argparse.Namespace` Простой класс, используемый по умолчанию в [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) для создания объекта, содержащего атрибуты, и его возврата. Этот класс намеренно прост, всего лишь подкласс [`object`](https://python-all.ru/3/library/functions.html#object) с читаемым строковым представлением. Если нужно dict-подобное представление атрибутов, можно воспользоваться стандартной идиомой Python, [`vars()`](https://python-all.ru/3/library/functions.html#vars): ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo') >>> args = parser.parse_args(['--foo', 'BAR']) >>> vars(args) {'foo': 'BAR'} ``` Также может быть полезно, чтобы [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) присваивал атрибуты уже существующему объекту, а не новому объекту `Namespace`. Этого можно достичь, указав именованный аргумент `namespace=`: ```python >>> class C: ... pass ... >>> c = C() >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo') >>> parser.parse_args(args=['--foo', 'BAR'], namespace=c) >>> c.foo 'BAR' ``` ## Другие утилиты ### Подкоманды #### `ArgumentParser.add_subparsers(*[, title][, description][, prog][, parser_class][, action][, dest][, required][, help][, metavar])` Многие программы разделяют свою функциональность на несколько подкоманд; например, программа `svn` может вызывать подкоманды `svn checkout`, `svn update` и `svn commit`. Такое разделение функциональности может быть особенно удачной идеей, когда программа выполняет несколько различных функций, требующих разных видов аргументов командной строки. [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) поддерживает создание таких подкоманд с помощью метода `add_subparsers()`. Метод `add_subparsers()` обычно вызывается без аргументов и возвращает специальный объект действия. Этот объект имеет единственный метод, `add_parser()`, который принимает имя команды и любые аргументы конструктора `ArgumentParser`, и возвращает объект `ArgumentParser`, который можно изменять обычным образом. Описание параметров: - *title* – заголовок для группы подпарсеров в выводе справки; по умолчанию «subcommands», если указано описание, в противном случае используется заголовок для позиционных аргументов - *description* – описание для группы подпарсеров в выводе справки; по умолчанию `None` - *prog* – информация об использовании, которая будет отображаться в справке подкоманды; по умолчанию – имя программы и любые позиционные аргументы перед аргументом подпарсера - *parser\_class* – класс, который будет использоваться для создания экземпляров подпарсеров; по умолчанию – класс текущего парсера (например, [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser)) - [action](https://python-all.ru/3/library/argparse.html#action) – базовый тип действия, которое будет выполнено при обнаружении этого аргумента в командной строке - [dest](https://python-all.ru/3/library/argparse.html#dest) – имя атрибута, в котором будет сохранено имя подкоманды; по умолчанию `None` и значение не сохраняется - [required](https://python-all.ru/3/library/argparse.html#required) – указывает, обязательно ли должна быть указана подкоманда; по умолчанию `False` (добавлено в версии 3.7) - [help](https://python-all.ru/3/library/argparse.html#help) – справка для группы подпарсеров в выводе справки; по умолчанию `None` - [metavar](https://python-all.ru/3/library/argparse.html#metavar) – строка, представляющая доступные подкоманды в справке; по умолчанию `None`, и подкоманды отображаются в виде {cmd1, cmd2, ..} Пример использования: ```python >>> # создать парсер верхнего уровня >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('--foo', action='store_true', help='foo help') >>> subparsers = parser.add_subparsers(help='subcommand help') >>> >>> # создать парсер для команды "a" >>> parser_a = subparsers.add_parser('a', help='a help') >>> parser_a.add_argument('bar', type=int, help='bar help') >>> >>> # создать парсер для команды "b" >>> parser_b = subparsers.add_parser('b', help='b help') >>> parser_b.add_argument('--baz', choices=('X', 'Y', 'Z'), help='baz help') >>> >>> # разобрать некоторые списки аргументов >>> parser.parse_args(['a', '12']) Namespace(bar=12, foo=False) >>> parser.parse_args(['--foo', 'b', '--baz', 'Z']) Namespace(baz='Z', foo=True) ``` Обратите внимание, что объект, возвращаемый [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args), будет содержать только атрибуты главного парсера и того подпарсера, который был выбран из командной строки (а не любых других подпарсеров). Так, в приведённом выше примере, когда указана команда `a`, присутствуют только атрибуты `foo` и `bar`, а когда указана команда `b` – только атрибуты `foo` и `baz`. Если подпарсер определяет аргумент с тем же `dest`, что и родительский парсер, они разделяют один атрибут пространства имён, поэтому значение родителя не будет сохранено. Пользователям следует задать им разные значения `dest`, чтобы сохранить оба. Аналогично, при запросе справки от подпарсера выводится только справка этого конкретного парсера. Сообщение справки не включает сообщения родительского парсера или соседних парсеров. (Однако справку для каждой команды подпарсера можно задать, передав аргумент `help=` функции `add_parser()`, как показано выше.) ```python >>> parser.parse_args(['--help']) usage: PROG [-h] [--foo] {a,b} ... positional arguments: {a,b} subcommand help a a help b b help options: -h, --help show this help message and exit --foo foo help >>> parser.parse_args(['a', '--help']) usage: PROG a [-h] bar positional arguments: bar bar help options: -h, --help show this help message and exit >>> parser.parse_args(['b', '--help']) usage: PROG b [-h] [--baz {X,Y,Z}] options: -h, --help show this help message and exit --baz {X,Y,Z} baz help ``` Метод `add_subparsers()` также поддерживает именованные аргументы `title` и `description`. Когда любой из них присутствует, команды подпарсера отображаются в собственной группе в выводе справки. Например: ```python >>> parser = argparse.ArgumentParser() >>> subparsers = parser.add_subparsers(title='subcommands', ... description='valid subcommands', ... help='additional help') >>> subparsers.add_parser('foo') >>> subparsers.add_parser('bar') >>> parser.parse_args(['-h']) usage: [-h] {foo,bar} ... options: -h, --help show this help message and exit subcommands: valid subcommands {foo,bar} additional help ``` Кроме того, `add_parser()` поддерживает дополнительный аргумент *aliases*, который позволяет нескольким строкам ссылаться на один и тот же подпарсер. Этот пример, как и `svn`, использует псевдоним `co` как сокращение для `checkout`: ```python >>> parser = argparse.ArgumentParser() >>> subparsers = parser.add_subparsers() >>> checkout = subparsers.add_parser('checkout', aliases=['co']) >>> checkout.add_argument('foo') >>> parser.parse_args(['co', 'bar']) Namespace(foo='bar') ``` `add_parser()` также поддерживает дополнительный аргумент *устарело*, который позволяет пометить подпарсер как устаревший. ```python >>> import argparse >>> parser = argparse.ArgumentParser(prog='chicken.py') >>> subparsers = parser.add_subparsers() >>> run = subparsers.add_parser('run') >>> fly = subparsers.add_parser('fly', deprecated=True) >>> parser.parse_args(['fly']) chicken.py: warning: command 'fly' is deprecated Namespace() ``` Добавлено в версии 3.13. Один из особенно эффективных способов обработки подкоманд – комбинировать использование метода `add_subparsers()` с вызовами [`set_defaults()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.set_defaults), чтобы каждый подпарсер знал, какую функцию Python он должен выполнить. Например: ```python >>> # функции подкоманд >>> def foo(args): ... print(args.x * args.y) ... >>> def bar(args): ... print('((%s))' % args.z) ... >>> # создать парсер верхнего уровня >>> parser = argparse.ArgumentParser() >>> subparsers = parser.add_subparsers(required=True) >>> >>> # создать парсер для команды "foo" >>> parser_foo = subparsers.add_parser('foo') >>> parser_foo.add_argument('-x', type=int, default=1) >>> parser_foo.add_argument('y', type=float) >>> parser_foo.set_defaults(func=foo) >>> >>> # создать парсер для команды "bar" >>> parser_bar = subparsers.add_parser('bar') >>> parser_bar.add_argument('z') >>> parser_bar.set_defaults(func=bar) >>> >>> # разобрать аргументы и вызвать выбранную функцию >>> args = parser.parse_args('foo 1 -x 2'.split()) >>> args.func(args) 2.0 >>> >>> # разобрать аргументы и вызвать выбранную функцию >>> args = parser.parse_args('bar XYZYX'.split()) >>> args.func(args) ((XYZYX)) ``` Таким образом, можно поручить [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) задачу вызова соответствующей функции после завершения разбора аргументов. Связывание функций с действиями таким образом – обычно самый простой способ обработать разные действия для каждого из ваших подпарсеров. Однако, если необходимо проверить имя вызванного подпарсера, сработает именованный аргумент `dest` при вызове `add_subparsers()`: ```python >>> parser = argparse.ArgumentParser() >>> subparsers = parser.add_subparsers(dest='subparser_name') >>> subparser1 = subparsers.add_parser('1') >>> subparser1.add_argument('-x') >>> subparser2 = subparsers.add_parser('2') >>> subparser2.add_argument('y') >>> parser.parse_args(['2', 'frobble']) Namespace(subparser_name='2', y='frobble') ``` Изменено в версии 3.7: Новый именованный параметр *required*. Изменено в версии 3.14: На *prog* подпарсера больше не влияет пользовательское сообщение об использовании в главном парсере. ### Объекты FileType #### `class argparse.FileType(mode='r', bufsize=-1, encoding=None, errors=None)` Фабрика `FileType` создаёт объекты, которые можно передать в аргумент type функции [`ArgumentParser.add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument). Аргументы, имеющие объекты `FileType` в качестве типа, будут открывать аргументы командной строки как файлы с указанными режимами, размерами буфера, кодировками и обработкой ошибок (см. функцию [`open()`](https://python-all.ru/3/library/functions.html#open) для подробностей): ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--raw', type=argparse.FileType('wb', 0)) >>> parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8')) >>> parser.parse_args(['--raw', 'raw.dat', 'file.txt']) Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>) ``` Объекты FileType понимают псевдоаргумент `'-'` и автоматически преобразуют его в [`sys.stdin`](https://python-all.ru/3/library/sys.html#sys.stdin) для читаемых объектов `FileType` и в [`sys.stdout`](https://python-all.ru/3/library/sys.html#sys.stdout) для записываемых объектов `FileType`: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('infile', type=argparse.FileType('r')) >>> parser.parse_args(['-']) Namespace(infile=<_io.TextIOWrapper name='' encoding='UTF-8'>) ``` > **Примечание** > > Если один аргумент использует *FileType*, а затем последующий аргумент завершается ошибкой, сообщается об ошибке, но файл не закрывается автоматически. Это также может повредить выходные файлы. В этом случае лучше дождаться завершения работы парсера, а затем использовать оператор [`with`](https://python-all.ru/3/reference/compound_stmts.html#with) для управления файлами. Изменено в версии 3.4: Добавлены параметры *encoding* и *errors*. Устарело с версии 3.14. ### Группы аргументов #### `ArgumentParser.add_argument_group(title=None, description=None, *[, argument_default][, conflict_handler])` По умолчанию [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) группирует аргументы командной строки на «позиционные аргументы» и «опции» при отображении сообщений справки. Если существует более осмысленная концептуальная группировка аргументов, чем эта, можно создать соответствующие группы с помощью метода `add_argument_group()`: ```python >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) >>> group = parser.add_argument_group('group') >>> group.add_argument('--foo', help='foo help') >>> group.add_argument('bar', help='bar help') >>> parser.print_help() usage: PROG [--foo FOO] bar group: bar bar help --foo FOO foo help ``` Метод `add_argument_group()` возвращает объект группы аргументов, у которого есть метод [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument), как и у обычного [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser). Когда аргумент добавляется в группу, парсер обрабатывает его как обычный аргумент, но при выводе справки отображает его в отдельной группе. Метод `add_argument_group()` принимает аргументы *title* и *description*, которые можно использовать для настройки этого отображения: ```python >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) >>> group1 = parser.add_argument_group('group1', 'group1 description') >>> group1.add_argument('foo', help='foo help') >>> group2 = parser.add_argument_group('group2', 'group2 description') >>> group2.add_argument('--bar', help='bar help') >>> parser.print_help() usage: PROG [--bar BAR] foo group1: group1 description foo foo help group2: group2 description --bar BAR bar help ``` Необязательные именованные параметры [argument\_default](https://python-all.ru/3/library/argparse.html#argument-default) и [conflict\_handler](https://python-all.ru/3/library/argparse.html#conflict-handler) позволяют более детально управлять поведением группы аргументов. Эти параметры имеют тот же смысл, что и в конструкторе [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser), но применяются именно к группе аргументов, а не ко всему парсеру. Обратите внимание, что любые аргументы, не входящие в ваши пользовательские группы, окажутся обратно в обычных разделах «позиционные аргументы» и «опциональные аргументы». Внутри каждой группы аргументов они отображаются в выводе справки в порядке их добавления. Устарело с версии 3.11, удалено в версии 3.14: Вызов `add_argument_group()` для группы аргументов теперь вызывает исключение. Это вложение никогда не поддерживалось, часто работало некорректно и было случайно доступно через наследование. Устарело с версии 3.14: Передача [prefix\_chars](https://python-all.ru/3/library/argparse.html#prefix-chars) в `add_argument_group()` теперь устарела. ### Взаимное исключение #### `ArgumentParser.add_mutually_exclusive_group(required=False)` Создаёт взаимоисключающую группу. `argparse` гарантирует, что в командной строке присутствовал только один из аргументов взаимоисключающей группы: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> group = parser.add_mutually_exclusive_group() >>> group.add_argument('--foo', action='store_true') >>> group.add_argument('--bar', action='store_false') >>> parser.parse_args(['--foo']) Namespace(bar=True, foo=True) >>> parser.parse_args(['--bar']) Namespace(bar=False, foo=False) >>> parser.parse_args(['--foo', '--bar']) usage: PROG [-h] [--foo | --bar] PROG: error: argument --bar: not allowed with argument --foo ``` Метод `add_mutually_exclusive_group()` также принимает аргумент *required*, чтобы указать, что требуется хотя бы один из взаимоисключающих аргументов: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> group = parser.add_mutually_exclusive_group(required=True) >>> group.add_argument('--foo', action='store_true') >>> group.add_argument('--bar', action='store_false') >>> parser.parse_args([]) usage: PROG [-h] (--foo | --bar) PROG: error: one of the arguments --foo --bar is required ``` Обратите внимание: в настоящее время взаимоисключающие группы аргументов не поддерживают аргументы *title* и *description* метода [`add_argument_group()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument_group). Однако взаимоисключающую группу можно добавить к группе аргументов, у которой есть заголовок и описание. Например: ```python >>> parser = argparse.ArgumentParser(prog='PROG') >>> group = parser.add_argument_group('Group title', 'Group description') >>> exclusive_group = group.add_mutually_exclusive_group(required=True) >>> exclusive_group.add_argument('--foo', help='foo help') >>> exclusive_group.add_argument('--bar', help='bar help') >>> parser.print_help() usage: PROG [-h] (--foo FOO | --bar BAR) options: -h, --help show this help message and exit Group title: Group description --foo FOO foo help --bar BAR bar help ``` Устарело с версии 3.11, удалено в версии 3.14: Вызов [`add_argument_group()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument_group) или `add_mutually_exclusive_group()` для взаимоисключающей группы теперь вызывает исключение. Такая вложенность никогда не поддерживалась, часто работала некорректно и была случайно раскрыта через наследование. ### Умолчания парсера #### `ArgumentParser.set_defaults(**kwargs)` В большинстве случаев атрибуты объекта, возвращаемого [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args), полностью определяются путём анализа аргументов командной строки и действий аргументов. `set_defaults()` позволяет добавить некоторые дополнительные атрибуты, которые определяются без какого-либо анализа командной строки: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('foo', type=int) >>> parser.set_defaults(bar=42, baz='badger') >>> parser.parse_args(['736']) Namespace(bar=42, baz='badger', foo=736) ``` Обратите внимание: умолчания можно задать как на уровне парсера с помощью `set_defaults()`, так и на уровне аргумента с помощью [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument). Если оба метода вызываются для одного и того же аргумента, используется последнее установленное умолчание: ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default='bar') >>> parser.set_defaults(foo='spam') >>> parser.parse_args([]) Namespace(foo='spam') ``` Умолчания на уровне парсера могут быть особенно полезны при работе с несколькими парсерами. См. пример этого типа в методе [`add_subparsers()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_subparsers). #### `ArgumentParser.get_default(dest)` Возвращает значение по умолчанию для атрибута пространства имён, заданное либо [`add_argument()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.add_argument), либо [`set_defaults()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.set_defaults): ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default='badger') >>> parser.get_default('foo') 'badger' ``` ### Вывод справки В большинстве типичных приложений [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args) берёт на себя форматирование и вывод всех сообщений об использовании и ошибок. Однако доступно несколько методов форматирования: #### `ArgumentParser.print_usage(file=None)` Выводит краткое описание того, как [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) должен вызываться в командной строке. Если *file* равен `None`, предполагается [`sys.stdout`](https://python-all.ru/3/library/sys.html#sys.stdout). #### `ArgumentParser.print_help(file=None)` Выводит справочное сообщение, включая использование программы и информацию об аргументах, зарегистрированных в [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser). Если *file* равен `None`, предполагается [`sys.stdout`](https://python-all.ru/3/library/sys.html#sys.stdout). Существуют также варианты этих методов, которые просто возвращают строку вместо её вывода: #### `ArgumentParser.format_usage()` Возвращает строку с кратким описанием того, как [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser) должен вызываться в командной строке. #### `ArgumentParser.format_help()` Возвращает строку со справочным сообщением, включая использование программы и информацию об аргументах, зарегистрированных в [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser). ### Частичный разбор #### `ArgumentParser.parse_known_args(args=None, namespace=None)` Иногда скрипту нужно обрабатывать только определённый набор аргументов командной строки, оставляя нераспознанные аргументы для другого скрипта или программы. В таких случаях может быть полезен метод `parse_known_args()`. Этот метод работает аналогично [`parse_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_args), но не вызывает ошибку для лишних нераспознанных аргументов. Вместо этого он разбирает известные аргументы и возвращает кортеж из двух элементов, содержащий заполненное пространство имён и список всех нераспознанных аргументов. ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action='store_true') >>> parser.add_argument('bar') >>> parser.parse_known_args(['--foo', '--badger', 'BAR', 'spam']) (Namespace(bar='BAR', foo=True), ['--badger', 'spam']) ``` > **Предупреждение** > > Правила [совпадения по префиксу](https://python-all.ru/3/library/argparse.html#prefix-matching) применяются к [`parse_known_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_known_args). Парсер может поглотить параметр, даже если он является всего лишь префиксом одного из известных параметров, вместо того чтобы оставить его в списке оставшихся аргументов. ### Настройка разбора файлов #### `ArgumentParser.convert_arg_line_to_args(arg_line)` Аргументы, читаемые из файла (см. именованный аргумент *fromfile\_prefix\_chars* конструктора [`ArgumentParser`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser)), читаются по одному аргументу на строку. `convert_arg_line_to_args()` можно переопределить для более сложного чтения. Этот метод принимает один аргумент *arg\_line* – строку, прочитанную из файла аргументов. Он возвращает список аргументов, разобранных из этой строки. Метод вызывается по одному разу для каждой строки из файла аргументов, по порядку. Полезным переопределением этого метода будет то, которое рассматривает каждое отделённое пробелом слово как аргумент. Следующий пример показывает, как это сделать: ```python class MyArgumentParser(argparse.ArgumentParser): def convert_arg_line_to_args(self, arg_line): return arg_line.split() ``` Обратите внимание: при таком переопределении аргумент больше не может содержать пробелы, поскольку каждое отделённое пробелом слово становится отдельным аргументом. ### Методы завершения #### `ArgumentParser.exit(status=0, message=None)` Этот метод завершает программу с указанным *status* и, если задано, выводит *message* в [`sys.stderr`](https://python-all.ru/3/library/sys.html#sys.stderr) перед этим. Пользователь может переопределить этот метод, чтобы выполнять эти действия иначе: ```python class ErrorCatchingArgumentParser(argparse.ArgumentParser): def exit(self, status=0, message=None): if status: raise Exception(f'Exiting because of an error: {message}') exit(status) ``` #### `ArgumentParser.error(message)` Этот метод выводит сообщение об использовании, включая *message*, в [`sys.stderr`](https://python-all.ru/3/library/sys.html#sys.stderr) и завершает программу с кодом возврата 2. ### Смешанный разбор #### `ArgumentParser.parse_intermixed_args(args=None, namespace=None)` #### `ArgumentParser.parse_known_intermixed_args(args=None, namespace=None)` Многие команды Unix позволяют пользователю смешивать опциональные аргументы с позиционными. Методы [`parse_intermixed_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_intermixed_args) и `parse_known_intermixed_args()` поддерживают такой стиль разбора. Эти анализаторы не поддерживают все возможности `argparse` и будут вызывать исключения при использовании неподдерживаемых возможностей. В частности, не поддерживаются подпарсеры и взаимоисключающие группы, содержащие как опциональные, так и позиционные аргументы. Следующий пример показывает разницу между [`parse_known_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_known_args) и [`parse_intermixed_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_intermixed_args): первый возвращает `['2', '3']` как неразобранные аргументы, в то время как второй собирает все позиционные аргументы в `rest`. ```python >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo') >>> parser.add_argument('cmd') >>> parser.add_argument('rest', nargs='*', type=int) >>> parser.parse_known_args('doit 1 --foo bar 2 3'.split()) (Namespace(cmd='doit', foo='bar', rest=[1]), ['2', '3']) >>> parser.parse_intermixed_args('doit 1 --foo bar 2 3'.split()) Namespace(cmd='doit', foo='bar', rest=[1, 2, 3]) ``` `parse_known_intermixed_args()` возвращает кортеж из двух элементов, содержащий заполненное пространство имён и список оставшихся строк аргументов. [`parse_intermixed_args()`](https://python-all.ru/3/library/argparse.html#argparse.ArgumentParser.parse_intermixed_args) вызывает ошибку, если остаются какие-либо неразобранные строки аргументов. Добавлено в версии 3.7. ### Регистрация пользовательских типов или действий #### `ArgumentParser.register(registry_name, value, object)` Иногда бывает удобно использовать произвольную строку в сообщениях об ошибках, чтобы сделать вывод более понятным для пользователя. В таких случаях `register()` можно использовать для регистрации пользовательских действий или типов в анализаторе и ссылаться на тип по его зарегистрированному имени, а не по имени вызываемого объекта. Метод `register()` принимает три аргумента: *registry\_name*, указывающий внутренний реестр, в котором будет сохранён объект (например, `action`, `type`); *value* – ключ, под которым объект будет зарегистрирован; и object – вызываемый объект, который нужно зарегистрировать. Следующий пример показывает, как зарегистрировать пользовательский тип в анализаторе: ```python >>> import argparse >>> parser = argparse.ArgumentParser() >>> parser.register('type', 'hexadecimal integer', lambda s: int(s, 16)) >>> parser.add_argument('--foo', type='hexadecimal integer') _StoreAction(option_strings=['--foo'], dest='foo', nargs=None, const=None, default=None, type='hexadecimal integer', choices=None, required=False, help=None, metavar=None, deprecated=False) >>> parser.parse_args(['--foo', '0xFA']) Namespace(foo=250) >>> parser.parse_args(['--foo', '1.2']) usage: PROG [-h] [--foo FOO] PROG: error: argument --foo: invalid 'hexadecimal integer' value: '1.2' ``` ## Исключения #### `exception argparse.ArgumentError` Ошибка при создании или использовании аргумента (опционального или позиционного). Строковое значение этого исключения – это сообщение, дополненное информацией об аргументе, который его вызвал. #### `exception argparse.ArgumentTypeError` Вызывается, когда что-то идёт не так при преобразовании строки командной строки в тип. Руководства и учебные пособия - [Учебное пособие по argparse](https://python-all.ru/3/howto/argparse.html) - [Перенос кода `optparse` на `argparse`](https://python-all.ru/3/howto/argparse-optparse.html)