optparse.md

1> **Источник:** https://python-all.ru/3.12/library/optparse.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `optparse` – Парсер параметров командной строки89**Исходный код:** [Lib/optparse.py](https://python-all.ru/src/3.12/Lib/optparse.py)1011Устарело с версии 3.2: Модуль [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) устарел и не будет развиваться дальше; разработка будет продолжена с модулем [`argparse`](https://python-all.ru/3.12/library/argparse.html#module-argparse).1213---1415[`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) – это более удобная, гибкая и мощная библиотека для разбора параметров командной строки, чем старый модуль [`getopt`](https://python-all.ru/3.12/library/getopt.html#module-getopt). [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) использует более декларативный стиль разбора командной строки: вы создаёте экземпляр [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser), заполняете его параметрами и разбираете командную строку. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) позволяет пользователям указывать параметры в стандартном синтаксисе GNU/POSIX, а также автоматически генерирует для вас сообщения об использовании и справку.1617Вот пример использования [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) в простом скрипте:1819```python20from optparse import OptionParser21...22parser = OptionParser()23parser.add_option("-f", "--file", dest="filename",24                  help="write report to FILE", metavar="FILE")25parser.add_option("-q", "--quiet",26                  action="store_false", dest="verbose", default=True,27                  help="don't print status messages to stdout")2829(options, args) = parser.parse_args()30```3132С помощью этих нескольких строк кода пользователи вашего скрипта теперь могут делать «обычные вещи» в командной строке, например:3334```python35<yourscript> --file=outfile -q36```3738По мере разбора командной строки [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) устанавливает атрибуты объекта `options`, возвращаемого [`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args), на основе предоставленных пользователем значений командной строки. Когда [`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args) завершает разбор этой командной строки, `options.filename` будет `"outfile"`, а `options.verbose` будет `False`. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) поддерживает как длинные, так и короткие параметры, позволяет объединять короткие параметры, а также позволяет связывать параметры с их аргументами различными способами. Таким образом, следующие командные строки эквивалентны приведённому выше примеру:3940```python41<yourscript> -f outfile --quiet42<yourscript> --quiet --file outfile43<yourscript> -q -foutfile44<yourscript> -qfoutfile45```4647Кроме того, пользователи могут выполнить одну из следующих команд:4849```python50<yourscript> -h51<yourscript> --help52```5354и [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) выведет краткую сводку параметров вашего скрипта:5556```text57Usage: <yourscript> [options]5859Options:60  -h, --help            show this help message and exit61  -f FILE, --file=FILE  write report to FILE62  -q, --quiet           don't print status messages to stdout63```6465где значение *yourscript* определяется во время выполнения (обычно из `sys.argv[0]`).6667## Предыстория6869[`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) был явно спроектирован для поощрения создания программ с простыми и стандартными интерфейсами командной строки. Для этого он поддерживает только самые распространённые синтаксис и семантику командной строки, традиционно используемые в Unix. Если вы не знакомы с этими соглашениями, прочитайте этот раздел, чтобы ознакомиться с ними.7071### Терминология7273**аргумент**7475строка, введенная в командной строке и переданная оболочкой в `execl()` или `execv()`. В Python аргументами являются элементы `sys.argv[1:]` (`sys.argv[0]` – это имя выполняемой программы). Оболочки Unix также используют термин «слово».7677Иногда желательно подставить список аргументов, отличный от `sys.argv[1:]`, поэтому под «аргументом» следует понимать «элемент `sys.argv[1:]` или любого другого списка, предоставленного взамен `sys.argv[1:]`».7879**опция**8081аргумент, используемый для предоставления дополнительной информации для управления или настройки выполнения программы. Существует много разных синтаксисов для опций; традиционный синтаксис Unix – это дефис («-») с последующей одной буквой, например `-x` или `-F`. Также традиционный синтаксис Unix позволяет объединять несколько опций в один аргумент, например `-x -F` эквивалентно `-xF`. Проект GNU ввел `--` с последующей последовательностью слов, разделенных дефисом, например `--file` или `--dry-run`. Это единственные два синтаксиса опций, предоставляемые [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse).8283Некоторые другие синтаксисы опций, которые встречались в мире, включают:8485- дефис с последующими несколькими буквами, например `-pf` (это *не* то же самое, что несколько опций, объединенных в один аргумент)86- дефис с последующим целым словом, например `-file` (технически это эквивалентно предыдущему синтаксису, но они обычно не встречаются в одной программе)87- знак плюс с последующей одной буквой, или несколькими буквами, или словом, например `+f`, `+rgb`88- косая черта с последующей буквой, или несколькими буквами, или словом, например `/f`, `/file`8990Эти синтаксисы опций не поддерживаются [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) и никогда не будут поддерживаться. Это сделано намеренно: первые три являются нестандартными в любом окружении, а последний имеет смысл только если вы ориентируетесь исключительно на Windows или определенные устаревшие платформы (например, VMS, MS-DOS).9192**аргумент опции**9394аргумент, который следует за опцией, тесно связан с этой опцией и извлекается из списка аргументов вместе с ней. В [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) аргументы опций могут находиться как в отдельном аргументе от своей опции:9596```text97-f foo98--file foo99```100101или включены в тот же аргумент:102103```text104-ffoo105--file=foo106```107108Обычно конкретная опция либо принимает аргумент, либо нет. Многие хотят функцию «необязательных аргументов опций», то есть некоторые опции будут принимать аргумент, если он есть, и не будут, если его нет. Это несколько спорно, поскольку делает разбор неоднозначным: если `-a` принимает необязательный аргумент, а `-b` – это совершенно другая опция, как интерпретировать `-ab`? Из-за этой неоднозначности [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) не поддерживает такую функцию.109110**позиционный аргумент**111112то, что осталось в списке аргументов после разбора опций, т.е. после того, как опции и их аргументы были разобраны и удалены из списка аргументов.113114**обязательная опция**115116опция, которая должна быть указана в командной строке; обратите внимание, что фраза «обязательная опция» противоречива по своей сути. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) не препятствует реализации обязательных опций, но и не оказывает большой помощи в этом.117118Например, рассмотрим эту гипотетическую командную строку:119120```python121prog -v --report report.txt foo bar122```123124`-v` и `--report` являются опциями. Предполагая, что `--report` принимает один аргумент, `report.txt` является аргументом опции. `foo` и `bar` являются позиционными аргументами.125126### Для чего нужны опции?127128Опции используются для предоставления дополнительной информации для настройки или кастомизации выполнения программы. Если это не было очевидно, опции обычно *необязательны*. Программа должна нормально работать вообще без опций. (Возьмите случайную программу из инструментария Unix или GNU. Может ли она работать без каких-либо опций и при этом иметь смысл? Главные исключения – `find`, `tar` и `dd` – все они мутанты-чудаки, которые по праву критикуются за нестандартный синтаксис и запутанные интерфейсы.)129130Многие хотят, чтобы в их программах были «обязательные опции». Подумайте об этом. Если это обязательно, значит, это *не необязательно*! Если есть информация, которая absolutely необходима вашей программе для успешного выполнения, для этого существуют позиционные аргументы.131132В качестве примера хорошего дизайна интерфейса командной строки рассмотрим скромную утилиту `cp` для копирования файлов. Копировать файлы без указания назначения и хотя бы одного источника не имеет особого смысла. Поэтому `cp` завершается с ошибкой, если запустить ее без аргументов. Однако у нее гибкий, полезный синтаксис, который вообще не требует опций:133134```python135cp SOURCE DEST136cp SOURCE ... DEST-DIR137```138139На этом можно многого добиться. Большинство реализаций `cp` предоставляют множество опций для точной настройки копирования: можно сохранять права и время модификации, не следовать симлинкам, спрашивать перед перезаписью существующих файлов и т.д. Но ничто из этого не отвлекает от основной задачи `cp` – скопировать один файл в другой или несколько файлов в другой каталог.140141### Для чего нужны позиционные аргументы?142143Позиционные аргументы предназначены для тех частей информации, которые absolutely и однозначно необходимы вашей программе для работы.144145Хороший пользовательский интерфейс должен иметь как можно меньше абсолютных требований. Если вашей программе требуется 17 различных частей информации для успешного запуска, не имеет большого значения *как* вы получаете эту информацию от пользователя – большинство людей сдадутся и уйдут, так и не запустив программу. Это справедливо независимо от того, является ли интерфейс командной строкой, файлом конфигурации или графическим интерфейсом: если вы предъявляете столько требований к пользователям, большинство из них просто сдадутся.146147Короче говоря, старайтесь минимизировать объем информации, которую пользователи absolutely обязаны предоставить – используйте разумные значения по умолчанию, когда это возможно. Конечно, вы также хотите сделать свои программы достаточно гибкими. Для этого и нужны опции. Опять же, неважно, являются ли они записями в файле конфигурации, виджетами в диалоге «Настройки» графического интерфейса или опциями командной строки – чем больше опций вы реализуете, тем гибче становится ваша программа, и тем сложнее становится ее реализация. Слишком большая гибкость тоже имеет недостатки; слишком много опций может перегрузить пользователей и сделать ваш код гораздо сложнее в поддержке.148149## Учебное руководство150151Хотя [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) довольно гибкий и мощный, он также прост в использовании в большинстве случаев. В этом разделе рассматриваются шаблоны кода, общие для любой программы на основе [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse).152153Сначала необходимо импортировать класс OptionParser; затем, в начале основной программы, создать экземпляр OptionParser:154155```python156from optparse import OptionParser157...158parser = OptionParser()159```160161Затем можно приступить к определению опций. Базовый синтаксис:162163```python164parser.add_option(opt_str, ...,165                  attr=value, ...)166```167168Каждая опция имеет одну или несколько строк опций, например `-f` или `--file`, и несколько атрибутов, которые сообщают [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse), что ожидать и что делать, когда он встречает эту опцию в командной строке.169170Обычно каждая опция имеет одну короткую и одну длинную строку опции, например:171172```python173parser.add_option("-f", "--file", ...)174```175176Вы можете определить любое количество коротких и длинных строк опций (включая ноль), при условии, что в целом есть хотя бы одна строка опции.177178Строки опций, передаваемые в [`OptionParser.add_option()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.add_option), по сути являются метками для опции, определяемой этим вызовом. Для краткости мы часто будем ссылаться на *встречу опции* в командной строке; на самом деле [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) встречает *строки опций* и ищет опции по ним.179180Когда все опции определены, укажите [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) разобрать командную строку вашей программы:181182```python183(options, args) = parser.parse_args()184```185186(При желании можно передать собственный список аргументов в [`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args), но это редко необходимо: по умолчанию он использует `sys.argv[1:]`.)187188[`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args) возвращает два значения:189190- `options` – объект, содержащий значения для всех опций. Например, если `--file` принимает один строковый аргумент, то `options.file` будет именем файла, указанным пользователем, или `None`, если пользователь не указал эту опцию.191- `args` – список позиционных аргументов, оставшихся после разбора опций192193В этом учебном разделе рассматриваются только четыре наиболее важных атрибута опций: [`action`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.action), [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type), [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) (destination) и [`help`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.help). Из них [`action`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.action) является самым основным.194195### Понимание действий опций196197Действия сообщают [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse), что делать, когда он встречает опцию в командной строке. Существует фиксированный набор действий, встроенных в [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse); добавление новых действий – продвинутая тема, рассматриваемая в разделе [Расширение optparse](https://python-all.ru/3.12/library/optparse.html#optparse-extending-optparse). Большинство действий говорят [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) сохранить значение в некоторую переменную – например, взять строку из командной строки и сохранить её в атрибуте `options`.198199Если не указано действие опции, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) по умолчанию использует `store`.200201### Действие store202203Наиболее распространенное действие опции – `store`, которое говорит [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) взять следующий аргумент (или остаток текущего аргумента), убедиться, что он имеет правильный тип, и сохранить его в выбранное место назначения.204205Например:206207```python208parser.add_option("-f", "--file",209                  action="store", type="string", dest="filename")210```211212Теперь давайте создадим фиктивную командную строку и попросим [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) разобрать её:213214```python215args = ["-f", "foo.txt"]216(options, args) = parser.parse_args(args)217```218219Когда [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) видит строку опции `-f`, он потребляет следующий аргумент, `foo.txt`, и сохраняет его в `options.filename`. Итак, после этого вызова [`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args), `options.filename` равно `"foo.txt"`.220221Некоторые другие типы опций, поддерживаемые [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse): `int` и `float`. Вот опция, которая ожидает целочисленный аргумент:222223```python224parser.add_option("-n", type="int", dest="num")225```226227Обратите внимание, что эта опция не имеет длинной строки опции, что вполне допустимо. Кроме того, отсутствует явное действие, поскольку по умолчанию используется `store`.228229Давайте разберём другую фиктивную командную строку. На этот раз мы поместим аргумент опции непосредственно рядом с опцией: поскольку `-n42` (один аргумент) эквивалентно `-n 42` (два аргумента), код230231```python232(options, args) = parser.parse_args(["-n42"])233print(options.num)234```235236выведет `42`.237238Если тип не указан, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) предполагает `string`. В сочетании с тем, что действие по умолчанию – `store`, это означает, что наш первый пример можно сделать гораздо короче:239240```python241parser.add_option("-f", "--file", dest="filename")242```243244Если место назначения не указано, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) определяет разумное значение по умолчанию из строк опций: если первая длинная строка опции – `--foo-bar`, то по умолчанию местом назначения будет `foo_bar`. Если длинных строк опций нет, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) смотрит на первую короткую строку опции: местом назначения по умолчанию для `-f` будет `f`.245246[`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) также включает встроенный тип `complex`. Добавление типов рассматривается в разделе [Расширение optparse](https://python-all.ru/3.12/library/optparse.html#optparse-extending-optparse).247248### Обработка булевых (флаговых) опций249250Флаговые опции – установка переменной в true или false при обнаружении определённой опции – довольно распространены. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) поддерживает их с помощью двух отдельных действий: `store_true` и `store_false`. Например, у вас может быть флаг `verbose`, который включается опцией `-v` и выключается опцией `-q`:251252```python253parser.add_option("-v", action="store_true", dest="verbose")254parser.add_option("-q", action="store_false", dest="verbose")255```256257Здесь у нас две разные опции с одним и тем же местом назначения, что совершенно нормально. (Это просто означает, что нужно быть немного осторожнее при установке значений по умолчанию – см. ниже.)258259Когда [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) встречает `-v` в командной строке, он устанавливает `options.verbose` в `True`; когда он встречает `-q`, `options.verbose` устанавливается в `False`.260261### Другие действия262263Некоторые другие действия, поддерживаемые [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse):264265**`"store_const"`**266267сохранить постоянное значение, предварительно заданное через [`Option.const`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.const)268269**`"append"`**270271добавить аргумент этой опции в список272273**`"count"`**274275увеличить счётчик на единицу276277**`"callback"`**278279вызвать указанную функцию280281Они описаны в разделе [Справочное руководство](https://python-all.ru/3.12/library/optparse.html#optparse-reference-guide), и в разделе [Колбэки параметров](https://python-all.ru/3.12/library/optparse.html#optparse-option-callbacks).282283### Значения по умолчанию284285Все приведённые выше примеры предполагают установку некоторой переменной («назначения») при обнаружении определённых параметров командной строки. Что произойдёт, если эти параметры никогда не встретятся? Поскольку мы не указали значения по умолчанию, все они будут установлены в `None`. Обычно это нормально, но иногда требуется больший контроль. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) позволяет указать значение по умолчанию для каждого назначения, которое присваивается до разбора командной строки.286287Сначала рассмотрим пример с подробным/тихим режимом. Если мы хотим, чтобы [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) устанавливал `verbose` в `True`, если не встречен `-q`, то можно сделать так:288289```python290parser.add_option("-v", action="store_true", dest="verbose", default=True)291parser.add_option("-q", action="store_false", dest="verbose")292```293294Поскольку значения по умолчанию применяются к *назначению*, а не к какому-либо конкретному параметру, и эти два параметра имеют одно и то же назначение, это полностью эквивалентно:295296```python297parser.add_option("-v", action="store_true", dest="verbose")298parser.add_option("-q", action="store_false", dest="verbose", default=True)299```300301Рассмотрим это:302303```python304parser.add_option("-v", action="store_true", dest="verbose", default=False)305parser.add_option("-q", action="store_false", dest="verbose", default=True)306```307308Опять же, значение по умолчанию для `verbose` будет `True`: последнее указанное значение по умолчанию для любого конкретного назначения и будет использоваться.309310Более понятный способ указать значения по умолчанию – метод `set_defaults()` объекта OptionParser, который можно вызвать в любое время до вызова [`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args):311312```python313parser.set_defaults(verbose=True)314parser.add_option(...)315(options, args) = parser.parse_args()316```317318Как и прежде, последнее указанное значение для данного назначения параметра и будет использоваться. Для ясности старайтесь использовать какой-то один способ задания значений по умолчанию, а не оба сразу.319320### Генерация справки321322Возможность [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) автоматически генерировать текст справки и использования полезна для создания удобных интерфейсов командной строки. Всё, что нужно сделать – указать значение [`help`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.help) для каждого параметра и, опционально, краткое сообщение об использовании для всей программы. Вот OptionParser, заполненный удобными (документированными) параметрами:323324```python325usage = "usage: %prog [options] arg1 arg2"326parser = OptionParser(usage=usage)327parser.add_option("-v", "--verbose",328                  action="store_true", dest="verbose", default=True,329                  help="make lots of noise [default]")330parser.add_option("-q", "--quiet",331                  action="store_false", dest="verbose",332                  help="be vewwy quiet (I'm hunting wabbits)")333parser.add_option("-f", "--filename",334                  metavar="FILE", help="write output to FILE")335parser.add_option("-m", "--mode",336                  default="intermediate",337                  help="interaction mode: novice, intermediate, "338                       "or expert [default: %default]")339```340341Если [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) встречает в командной строке `-h` или `--help`, или если просто вызвать `parser.print_help()`, он выводит следующее в стандартный вывод:342343```text344Usage: <yourscript> [options] arg1 arg2345346Options:347  -h, --help            show this help message and exit348  -v, --verbose         make lots of noise [default]349  -q, --quiet           be vewwy quiet (I'm hunting wabbits)350  -f FILE, --filename=FILE351                        write output to FILE352  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or353                        expert [default: intermediate]354```355356(Если вывод справки вызван опцией помощи, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) завершает работу после печати текста справки.)357358Здесь много деталей, помогающих [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) сгенерировать наилучшее сообщение справки:359360- сценарий определяет собственное сообщение об использовании:361362  ```python363  usage = "usage: %prog [options] arg1 arg2"364  ```365366  [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) заменяет `%prog` в строке использования на имя текущей программы, т.е. `os.path.basename(sys.argv[0])`. Затем расширенная строка выводится перед подробной справкой по параметрам.367368  Если не указать строку использования, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) использует простое, но разумное значение по умолчанию: `"Usage: %prog [options]"`, что подходит, если сценарий не принимает позиционные аргументы.369- каждый параметр определяет строку справки и не заботится о переносе строк – [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) заботится о переносе и о том, чтобы вывод справки выглядел хорошо.370- параметры, принимающие значение, указывают на это в автоматически сгенерированном сообщении справки, например, для параметра «mode»:371372  ```python373  -m MODE, --mode=MODE374  ```375376  Здесь «MODE» называется мета-переменной: она представляет аргумент, который пользователь должен передать `-m`/`--mode`. По умолчанию [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) преобразует имя переменной назначения в верхний регистр и использует его для мета-переменной. Иногда это не то, что нужно – например, параметр `--filename` явно устанавливает `metavar="FILE"`, что приводит к такому автоматически сгенерированному описанию параметра:377378  ```python379  -f FILE, --filename=FILE380  ```381382  Это важно не только для экономии места: вручную написанный текст справки использует мета-переменную `FILE`, чтобы подсказать пользователю, что существует связь между полуформальным синтаксисом `-f FILE` и неформальным семантическим описанием «записать вывод в FILE». Это простой, но эффективный способ сделать текст справки гораздо понятнее и полезнее для конечных пользователей.383- Параметры, имеющие значение по умолчанию, могут включать `%default` в строку справки – [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) заменит его на [`str()`](https://python-all.ru/3.12/library/stdtypes.html#str) значения по умолчанию этого параметра. Если параметр не имеет значения по умолчанию (или значение по умолчанию равно `None`), `%default` раскрывается в `none`.384385#### Группировка параметров386387При работе с большим количеством параметров удобно группировать их для улучшения вывода справки. [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser) может содержать несколько групп параметров, каждая из которых может содержать несколько параметров.388389Группа параметров создаётся с помощью класса [`OptionGroup`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionGroup):390391#### `class optparse.OptionGroup(parser, title, description=None)`392393где394395- parser – это экземпляр [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser), в который будет вставлена группа396- title – это заголовок группы397- description (необязательно) – это подробное описание группы398399[`OptionGroup`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionGroup) наследуется от `OptionContainer` (как [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser)), поэтому метод `add_option()` можно использовать для добавления опции в группу.400401После объявления всех опций с помощью метода [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser) `add_option_group()` группа добавляется в ранее определённый парсер.402403Продолжая с парсером, определённым в предыдущем разделе, добавить [`OptionGroup`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionGroup) в парсер несложно:404405```python406group = OptionGroup(parser, "Dangerous Options",407                    "Caution: use these options at your own risk.  "408                    "It is believed that some of them bite.")409group.add_option("-g", action="store_true", help="Group option.")410parser.add_option_group(group)411```412413Это приведёт к следующему выводу справки:414415```text416Usage: <yourscript> [options] arg1 arg2417418Options:419  -h, --help            show this help message and exit420  -v, --verbose         make lots of noise [default]421  -q, --quiet           be vewwy quiet (I'm hunting wabbits)422  -f FILE, --filename=FILE423                        write output to FILE424  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or425                        expert [default: intermediate]426427  Dangerous Options:428    Caution: use these options at your own risk.  It is believed that some429    of them bite.430431    -g                  Group option.432```433434Несколько более полный пример может включать использование более одной группы: всё так же расширяя предыдущий пример:435436```python437group = OptionGroup(parser, "Dangerous Options",438                    "Caution: use these options at your own risk.  "439                    "It is believed that some of them bite.")440group.add_option("-g", action="store_true", help="Group option.")441parser.add_option_group(group)442443group = OptionGroup(parser, "Debug Options")444group.add_option("-d", "--debug", action="store_true",445                 help="Print debug information")446group.add_option("-s", "--sql", action="store_true",447                 help="Print all SQL statements executed")448group.add_option("-e", action="store_true", help="Print every action done")449parser.add_option_group(group)450```451452что приводит к следующему выводу:453454```text455Usage: <yourscript> [options] arg1 arg2456457Options:458  -h, --help            show this help message and exit459  -v, --verbose         make lots of noise [default]460  -q, --quiet           be vewwy quiet (I'm hunting wabbits)461  -f FILE, --filename=FILE462                        write output to FILE463  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or expert464                        [default: intermediate]465466  Dangerous Options:467    Caution: use these options at your own risk.  It is believed that some468    of them bite.469470    -g                  Group option.471472  Debug Options:473    -d, --debug         Print debug information474    -s, --sql           Print all SQL statements executed475    -e                  Print every action done476```477478Ещё один интересный метод, особенно при программной работе с группами опций:479480#### `OptionParser.get_option_group(opt_str)`481482Возвращает [`OptionGroup`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionGroup), которому принадлежит короткая или длинная строка опции *opt\_str* (например, `'-o'` или `'--option'`). Если такого [`OptionGroup`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionGroup) нет, возвращает `None`.483484### Печать строки версии485486Подобно краткой строке использования, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) также может выводить строку версии для программы. Строку нужно передать в качестве аргумента `version` конструктору OptionParser:487488```python489parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")490```491492`%prog` раскрывается так же, как в `usage`. Кроме того, `version` может содержать что угодно. При передаче строки [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) автоматически добавляет опцию `--version` в парсер. Если эта опция встречается в командной строке, строка `version` раскрывается (заменой `%prog`), выводится в stdout, и программа завершается.493494Например, если скрипт называется `/usr/bin/foo`:495496```console497$ /usr/bin/foo --version498foo 1.0499```500501Следующие два метода можно использовать для вывода и получения строки `version`:502503#### `OptionParser.print_version(file=None)`504505Выводит сообщение о версии текущей программы (`self.version`) в *file* (по умолчанию stdout). Как и в [`print_usage()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.print_usage), любое вхождение `%prog` в `self.version` заменяется на имя текущей программы. Ничего не делает, если `self.version` пусто или не определено.506507#### `OptionParser.get_version()`508509То же, что и [`print_version()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.print_version), но возвращает строку версии вместо её вывода.510511### Как [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) обрабатывает ошибки512513Существует два широких класса ошибок, с которыми приходится иметь дело [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse): ошибки программиста и ошибки пользователя. Ошибки программиста – это обычно неверные вызовы [`OptionParser.add_option()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.add_option), например, некорректные строки опций, неизвестные атрибуты опций, отсутствующие атрибуты опций и т.д. Они обрабатываются обычным способом: возбуждается исключение ([`optparse.OptionError`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionError) или [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError)), и программа завершается аварийно.514515Обработка ошибок пользователя гораздо важнее, поскольку они гарантированно возникают независимо от стабильности кода. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) может автоматически обнаруживать некоторые ошибки пользователя, такие как неверные аргументы опций (передача `-n 4x`, когда `-n` принимает целочисленный аргумент), отсутствие аргументов (`-n` в конце командной строки, когда `-n` принимает аргумент любого типа). Кроме того, можно вызвать `OptionParser.error()` для сигнализации об ошибке, определённой приложением:516517```python518(options, args) = parser.parse_args()519...520if options.a and options.b:521    parser.error("options -a and -b are mutually exclusive")522```523524В любом случае [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) обрабатывает ошибку одинаково: выводит сообщение об использовании программы и сообщение об ошибке в стандартный поток ошибок и завершается с кодом ошибки 2.525526Рассмотрим первый пример выше, где пользователь передаёт `4x` опции, которая принимает целое число:527528```console529$ /usr/bin/foo -n 4x530Usage: foo [options]531532foo: error: option -n: invalid integer value: '4x'533```534535Или когда пользователь вообще не передаёт значение:536537```console538$ /usr/bin/foo -n539Usage: foo [options]540541foo: error: -n option requires an argument542```543544Сообщения об ошибках, сгенерированные [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse), всегда содержат упоминание опции, вызвавшей ошибку; обязательно делайте то же самое при вызове `OptionParser.error()` из кода приложения.545546Если поведение обработки ошибок по умолчанию в [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) не соответствует требованиям, нужно создать подкласс OptionParser и переопределить его методы `exit()` и/или `error()`.547548### Собираем всё вместе549550Вот как обычно выглядят скрипты на основе [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse):551552```python553from optparse import OptionParser554...555def main():556    usage = "usage: %prog [options] arg"557    parser = OptionParser(usage)558    parser.add_option("-f", "--file", dest="filename",559                      help="read data from FILENAME")560    parser.add_option("-v", "--verbose",561                      action="store_true", dest="verbose")562    parser.add_option("-q", "--quiet",563                      action="store_false", dest="verbose")564    ...565    (options, args) = parser.parse_args()566    if len(args) != 1:567        parser.error("incorrect number of arguments")568    if options.verbose:569        print("reading %s..." % options.filename)570    ...571572if __name__ == "__main__":573    main()574```575576## Справочное руководство577578### Создание парсера579580Первым шагом при использовании [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) является создание экземпляра OptionParser.581582#### `class optparse.OptionParser(...)`583584Конструктор OptionParser не требует обязательных аргументов, но принимает ряд необязательных именованных аргументов. Их всегда следует передавать как именованные аргументы, т.е. не полагаться на порядок объявления аргументов.585586**`usage` (по умолчанию: `"%prog [options]"`)**587588Краткая справка по использованию, выводимая при неправильном запуске программы или по запросу справки. Когда [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) выводит строку использования, он заменяет `%prog` на `os.path.basename(sys.argv[0])` (или на `prog`, если был передан соответствующий именованный аргумент). Чтобы отключить сообщение об использовании, передайте специальное значение `optparse.SUPPRESS_USAGE`.589590**`option_list` (по умолчанию: `[]`)**591592Список объектов Option для заполнения парсера. Опции из `option_list` добавляются после любых опций из `standard_option_list` (атрибута класса, который может быть установлен подклассами OptionParser), но перед опциями версии и справки. Устарело; вместо этого используйте [`add_option()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.add_option) после создания парсера.593594**`option_class` (по умолчанию: optparse.Option)**595596Класс, используемый при добавлении опций в парсер в [`add_option()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.add_option).597598**`version` (по умолчанию: `None`)**599600Строка версии, выводимая по запросу опции версии. Если задать истинное значение для `version`, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) автоматически добавляет опцию версии с единственной строкой опции `--version`. Подстрока `%prog` заменяется так же, как для `usage`.601602**`conflict_handler` (по умолчанию: `"error"`)**603604Определяет, что делать, когда в парсер добавляются опции с конфликтующими строками опций; см. раздел [Конфликты между опциями](https://python-all.ru/3.12/library/optparse.html#optparse-conflicts-between-options).605606**`description` (по умолчанию: `None`)**607608Абзац текста с кратким обзором программы. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) переформатирует этот абзац под текущую ширину терминала и выводит его по запросу справки (после `usage`, но перед списком опций).609610**`formatter` (по умолчанию: новый `IndentedHelpFormatter`)**611612Экземпляр optparse.HelpFormatter, используемый для вывода текста справки. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) предоставляет два конкретных класса для этой цели: IndentedHelpFormatter и TitledHelpFormatter.613614**`add_help_option` (по умолчанию: `True`)**615616Если истина, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) добавит в парсер опцию справки (со строками опций `-h` и `--help`).617618**`prog`**619620Строка, используемая при замене `%prog` в `usage` и `version` вместо `os.path.basename(sys.argv[0])`.621622**`epilog` (по умолчанию: `None`)**623624Абзац текста справки, выводимый после справки по опциям.625626### Заполнение парсера627628Есть несколько способов заполнить парсер опциями. Предпочтительный способ – использовать [`OptionParser.add_option()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.add_option), как показано в разделе [Учебное пособие](https://python-all.ru/3.12/library/optparse.html#optparse-tutorial). `add_option()` можно вызывать одним из двух способов:629630- передать ему экземпляр Option (как возвращается `make_option()`)631- передать ему любую комбинацию позиционных и именованных аргументов, приемлемую для `make_option()` (т.е. для конструктора Option), и он создаст экземпляр Option автоматически632633Другой способ – передать список предварительно созданных экземпляров Option конструктору OptionParser, например:634635```python636option_list = [637    make_option("-f", "--filename",638                action="store", type="string", dest="filename"),639    make_option("-q", "--quiet",640                action="store_false", dest="verbose"),641    ]642parser = OptionParser(option_list=option_list)643```644645(`make_option()` – фабричная функция для создания экземпляров Option; в настоящее время это псевдоним конструктора Option. Будущая версия [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) может разделить Option на несколько классов, и `make_option()` будет выбирать нужный класс для создания экземпляра. Не создавайте экземпляры Option напрямую.)646647### Определение опций648649Каждый экземпляр Option представляет набор синонимичных строк опций командной строки, например `-f` и `--file`. Можно указать любое количество коротких или длинных строк опций, но необходимо указать хотя бы одну общую строку опции.650651Канонический способ создания экземпляра [`Option`](https://python-all.ru/3.12/library/optparse.html#optparse.Option) – это метод `add_option()` объекта [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser).652653#### `OptionParser.add_option(option)`654655#### `OptionParser.add_option(*opt_str, attr=value, ...)`656657Для определения опции только с короткой строкой опции:658659```python660parser.add_option("-f", attr=value, ...)661```662663А для определения опции только с длинной строкой опции:664665```python666parser.add_option("--foo", attr=value, ...)667```668669Именованные аргументы определяют атрибуты нового объекта Option. Самый важный атрибут опции – [`action`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.action), и он в значительной степени определяет, какие другие атрибуты являются релевантными или обязательными. Если передать нерелевантные атрибуты опции или не указать обязательные, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) вызовет исключение [`OptionError`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionError), поясняющее ошибку.670671Атрибут *action* опции определяет, что делает [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse), когда встречает эту опцию в командной строке. Стандартные действия опций, встроенные в [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse):672673**`"store"`**674675сохранить аргумент опции (по умолчанию)676677**`"store_const"`**678679сохранить постоянное значение, предварительно заданное через [`Option.const`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.const)680681**`"store_true"`**682683сохранить `True`684685**`"store_false"`**686687сохранить `False`688689**`"append"`**690691добавить аргумент этой опции в список692693**`"append_const"`**694695добавить постоянное значение в список, предварительно заданное через [`Option.const`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.const)696697**`"count"`**698699увеличить счётчик на единицу700701**`"callback"`**702703вызвать указанную функцию704705**`"help"`**706707вывести сообщение об использовании, включающее все опции и документацию к ним708709(Если не указать действие, по умолчанию используется `"store"`. Для этого действия можно также указать атрибуты опций [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type) и [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest); см. [Стандартные действия опций](https://python-all.ru/3.12/library/optparse.html#optparse-standard-option-actions).)710711Как видно, большинство действий связано с сохранением или обновлением значения где-либо. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) всегда создаёт для этого специальный объект, традиционно называемый `options`, который является экземпляром [`optparse.Values`](https://python-all.ru/3.12/library/optparse.html#optparse.Values).712713#### `class optparse.Values`714715Объект, содержащий имена и значения разобранных аргументов в виде атрибутов. Обычно создаётся при вызове [`OptionParser.parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args), и может быть заменён пользовательским подклассом, переданным в аргумент *values* функции [`OptionParser.parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args) (как описано в [Разбор аргументов](https://python-all.ru/3.12/library/optparse.html#optparse-parsing-arguments)).716717Аргументы опции (и различные другие значения) сохраняются как атрибуты этого объекта в соответствии с атрибутом опции [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) (назначение).718719Например, при вызове720721```python722parser.parse_args()723```724725одно из первых действий [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) – создание объекта `options`:726727```python728options = Values()729```730731Если одна из опций в этом анализаторе определена с помощью732733```python734parser.add_option("-f", "--file", action="store", type="string", dest="filename")735```736737и разбираемая командная строка включает любую из следующих:738739```python740-ffoo741-f foo742--file=foo743--file foo744```745746тогда [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse), увидев эту опцию, сделает эквивалент747748```python749options.filename = "foo"750```751752Атрибуты опций [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type) и [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) почти так же важны, как [`action`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.action), но [`action`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.action) – единственный, который имеет смысл для *всех* опций.753754### Атрибуты опций755756#### `class optparse.Option`757758Один аргумент командной строки, с различными атрибутами, передаваемыми по ключу конструктору. Обычно создаётся с помощью [`OptionParser.add_option()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.add_option), а не напрямую, и может быть заменён пользовательским классом через аргумент *option\_class* функции [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser).759760Следующие атрибуты опций могут быть переданы как именованные аргументы в [`OptionParser.add_option()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.add_option). Если передать атрибут опции, который не является релевантным для конкретной опции, или не указать обязательный атрибут опции, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) вызовет [`OptionError`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionError).761762#### `Option.action`763764(по умолчанию: `"store"`)765766Determines [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse)’s behaviour when this option is seen on the command line; the available options are documented [here](https://python-all.ru/3.12/library/optparse.html#optparse-standard-option-actions).767768#### `Option.type`769770(по умолчанию: `"string"`)771772The argument type expected by this option (e.g., `"string"` or `"int"`); the available option types are documented [here](https://python-all.ru/3.12/library/optparse.html#optparse-standard-option-types).773774#### `Option.dest`775776(по умолчанию: выводится из строк опций)777778Если действие опции подразумевает запись или изменение какого-либо значения, этот параметр указывает [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse), куда его записать: [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) задаёт имя атрибута объекта `options`, который [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) создаёт по мере разбора командной строки.779780#### `Option.default`781782Значение, используемое для целевого атрибута этой опции, если опция не встречена в командной строке. См. также [`OptionParser.set_defaults()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.set_defaults).783784#### `Option.nargs`785786(по умолчанию: 1)787788Сколько аргументов типа [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type) должно быть потреблено, когда эта опция встречена. Если \> 1, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) сохранит кортеж значений в [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest).789790#### `Option.const`791792Для действий, сохраняющих постоянное значение, – само это постоянное значение.793794#### `Option.choices`795796Для опций типа `"choice"` – список строк, из которых пользователь может выбирать.797798#### `Option.callback`799800For options with action `"callback"`, the callable to call when this option is seen. See section [Option Callbacks](https://python-all.ru/3.12/library/optparse.html#optparse-option-callbacks) for detail on the arguments passed to the callable.801802#### `Option.callback_args`803804#### `Option.callback_kwargs`805806Дополнительные позиционные и именованные аргументы, передаваемые в `callback` после четырёх стандартных аргументов колбэка.807808#### `Option.help`809810Текст справки для этой опции, выводимый при перечислении всех доступных опций после того, как пользователь укажет опцию [`help`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.help) (например, `--help`). Если текст справки не указан, опция будет выведена без него. Чтобы скрыть опцию, используйте специальное значение `optparse.SUPPRESS_HELP`.811812#### `Option.metavar`813814(по умолчанию: выводится из строк опций)815816Stand-in for the option argument(s) to use when printing help text. See section [Tutorial](https://python-all.ru/3.12/library/optparse.html#optparse-tutorial) for an example.817818### Стандартные действия опций819820Различные действия опций имеют слегка разные требования и эффекты. У большинства действий есть несколько соответствующих атрибутов опции, которые вы можете указать, чтобы управлять поведением [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse); некоторые имеют обязательные атрибуты, которые необходимо указывать для любой опции, использующей это действие.821822- `"store"` \[относится: [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type), [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest), [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs), [`choices`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.choices)\]823824  The option must be followed by an argument, which is converted to a value according to [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type) and stored in [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest). If [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs) \> 1, multiple arguments will be consumed from the command line; all will be converted according to [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type) and stored to [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) as a tuple. See the [Standard option types](https://python-all.ru/3.12/library/optparse.html#optparse-standard-option-types) section.825826  Если указан [`choices`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.choices) (список или кортеж строк), тип по умолчанию `"choice"`.827828  Если [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type) не указан, по умолчанию используется `"string"`.829830  Если [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) не указан, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) выводит destination из первой длинной строки опции (например, `--foo-bar` подразумевает `foo_bar`). Если длинных строк опций нет, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) выводит destination из первой короткой строки опции (например, `-f` подразумевает `f`).831832  Пример:833834  ```python835  parser.add_option("-f")836  parser.add_option("-p", type="float", nargs=3, dest="point")837  ```838839  В процессе разбора командной строки840841  ```python842  -f foo.txt -p 1 -3.5 4 -fbar.txt843  ```844845  [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) установит846847  ```python848  options.f = "foo.txt"849  options.point = (1.0, -3.5, 4.0)850  options.f = "bar.txt"851  ```852- `"store_const"` \[обязательно: [`const`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.const); относится: [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest)\]853854  Значение [`const`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.const) сохраняется в [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest).855856  Пример:857858  ```python859  parser.add_option("-q", "--quiet",860                    action="store_const", const=0, dest="verbose")861  parser.add_option("-v", "--verbose",862                    action="store_const", const=1, dest="verbose")863  parser.add_option("--noisy",864                    action="store_const", const=2, dest="verbose")865  ```866867  Если встречается `--noisy`, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) установит868869  ```python870  options.verbose = 2871  ```872- `"store_true"` \[относится: [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest)\]873874  Частный случай `"store_const"`, который сохраняет `True` в [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest).875- `"store_false"` \[относится: [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest)\]876877  Как `"store_true"`, но сохраняет `False`.878879  Пример:880881  ```python882  parser.add_option("--clobber", action="store_true", dest="clobber")883  parser.add_option("--no-clobber", action="store_false", dest="clobber")884  ```885- `"append"` \[относится: [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type), [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest), [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs), [`choices`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.choices)\]886887  За опцией должен следовать аргумент, который добавляется в список [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest). Если значение по умолчанию для [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) не указано, пустой список автоматически создаётся, когда [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) впервые встречает эту опцию в командной строке. Если [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs) \> 1, потребляется несколько аргументов, и кортеж длины [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs) добавляется в [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest).888889  Значения по умолчанию для [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type) и [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) такие же, как для действия `"store"`.890891  Пример:892893  ```python894  parser.add_option("-t", "--tracks", action="append", type="int")895  ```896897  Если в командной строке встречается `-t3`, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) делает то же самое, что:898899  ```python900  options.tracks = []901  options.tracks.append(int("3"))902  ```903904  Если чуть позже встречается `--tracks=4`, выполняется:905906  ```python907  options.tracks.append(int("4"))908  ```909910  Действие `append` вызывает метод `append` для текущего значения опции. Это означает, что любое указанное значение по умолчанию должно иметь метод `append`. Это также означает, что если значение по умолчанию непустое, элементы по умолчанию будут присутствовать в разобранном значении для опции, а любые значения из командной строки будут добавлены после этих значений по умолчанию:911912  ```python913  >>> parser.add_option("--files", action="append", default=['~/.mypkg/defaults'])914  >>> opts, args = parser.parse_args(['--files', 'overrides.mypkg'])915  >>> opts.files916  ['~/.mypkg/defaults', 'overrides.mypkg']917  ```918- `"append_const"` \[обязательно: [`const`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.const); относится: [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest)\]919920  Как `"store_const"`, но значение [`const`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.const) добавляется в [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest); как и в `"append"`, [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) по умолчанию равен `None`, и пустой список автоматически создаётся при первом обнаружении опции.921- `"count"` \[относится: [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest)\]922923  Увеличивает целое число, хранящееся в [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest). Если значение по умолчанию не указано, [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest) устанавливается в ноль перед первым увеличением.924925  Пример:926927  ```python928  parser.add_option("-v", action="count", dest="verbosity")929  ```930931  При первом появлении `-v` в командной строке [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) делает то же самое, что:932933  ```python934  options.verbosity = 0935  options.verbosity += 1936  ```937938  Каждое последующее появление `-v` приводит к939940  ```python941  options.verbosity += 1942  ```943- `"callback"` \[обязательно: [`callback`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback); относится: [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type), [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs), [`callback_args`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback_args), [`callback_kwargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback_kwargs)\]944945  Вызывает функцию, указанную в [`callback`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback), которая вызывается как946947  ```python948  func(option, opt_str, value, parser, *args, **kwargs)949  ```950951  Смотрите раздел [Колбэки опций](https://python-all.ru/3.12/library/optparse.html#optparse-option-callbacks) для подробностей.952- `"help"`953954  Выводит полное справочное сообщение для всех опций текущего парсера опций. Справочное сообщение формируется из строки `usage`, переданной конструктору OptionParser, и строки [`help`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.help), переданной каждой опции.955956  Если для опции не указана строка [`help`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.help), она всё равно будет перечислена в справочном сообщении. Чтобы полностью исключить опцию, используйте специальное значение `optparse.SUPPRESS_HELP`.957958  [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) автоматически добавляет опцию [`help`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.help) для всех объектов OptionParser, поэтому обычно не требуется создавать его отдельно.959960  Пример:961962  ```python963  from optparse import OptionParser, SUPPRESS_HELP964965  # обычно опция справки добавляется автоматически, но её можно966  # подавить, используя аргумент add_help_option967  parser = OptionParser(add_help_option=False)968969  parser.add_option("-h", "--help", action="help")970  parser.add_option("-v", action="store_true", dest="verbose",971                    help="Be moderately verbose")972  parser.add_option("--file", dest="filename",973                    help="Input file to read data from")974  parser.add_option("--secret", help=SUPPRESS_HELP)975  ```976977  Если [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) обнаруживает в командной строке `-h` или `--help`, он выводит примерно такое справочное сообщение в stdout (при условии, что `sys.argv[0]` равно `"foo.py"`):978979  ```text980  Usage: foo.py [options]981982  Options:983    -h, --help        Show this help message and exit984    -v                Be moderately verbose985    --file=FILENAME   Input file to read data from986  ```987988  После вывода справочного сообщения [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) завершает процесс с кодом `sys.exit(0)`.989- `"version"`990991  Выводит номер версии, переданный OptionParser, в stdout и завершает работу. Номер версии форматируется и выводится методом `print_version()` объекта OptionParser. Обычно актуально только если аргумент `version` передан конструктору OptionParser. Как и для опций [`help`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.help), `version` редко создаются вручную, так как [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) добавляет их автоматически при необходимости.992993### Стандартные типы опций994995[`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) содержит пять встроенных типов опций: `"string"`, `"int"`, `"choice"`, `"float"` и `"complex"`. Если требуется добавить новые типы опций, см. раздел [Расширение optparse](https://python-all.ru/3.12/library/optparse.html#optparse-extending-optparse).996997Аргументы строковых опций никак не проверяются и не преобразуются: текст из командной строки сохраняется в целевом атрибуте (или передаётся колбэку) как есть.998999Целочисленные аргументы (тип `"int"`) разбираются следующим образом:10001001- если число начинается с `0x`, оно разбирается как шестнадцатеричное1002- если число начинается с `0`, оно разбирается как восьмеричное1003- если число начинается с `0b`, оно разбирается как двоичное1004- в противном случае число разбирается как десятичное10051006Преобразование выполняется вызовом [`int()`](https://python-all.ru/3.12/library/functions.html#int) с соответствующим основанием (2, 8, 10 или 16). В случае неудачи так же поступит и [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse), хотя и с более полезным сообщением об ошибке.10071008Аргументы опций `"float"` и `"complex"` преобразуются напрямую с помощью [`float()`](https://python-all.ru/3.12/library/functions.html#float) и [`complex()`](https://python-all.ru/3.12/library/functions.html#complex), с аналогичной обработкой ошибок.10091010Опции `"choice"` являются подтипом опций `"string"`. Атрибут опции [`choices`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.choices) (последовательность строк) определяет набор допустимых аргументов опции. `optparse.check_choice()` сравнивает предоставленные пользователем аргументы опции с этим основным списком и возбуждает [`OptionValueError`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionValueError), если указана недопустимая строка.10111012### Разбор аргументов10131014Весь смысл создания и заполнения OptionParser заключается в вызове его метода [`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args).10151016#### `OptionParser.parse_args(args=None, values=None)`10171018Разбирает параметры командной строки, переданные в *args*.10191020Входные параметры:10211022**`args`**10231024список аргументов для обработки (по умолчанию: `sys.argv[1:]`)10251026**`values`**10271028объект [`Values`](https://python-all.ru/3.12/library/optparse.html#optparse.Values) для сохранения аргументов опций (по умолчанию – новый экземпляр [`Values`](https://python-all.ru/3.12/library/optparse.html#optparse.Values)); если передать существующий объект, значения опций по умолчанию не будут в него инициализированы10291030а возвращаемое значение – это пара `(options, args)`, где10311032**`options`**10331034тот же объект, который был передан как *values*, или экземпляр `optparse.Values`, созданный с помощью [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse)10351036**`args`**10371038оставшиеся позиционные аргументы после обработки всех опций10391040Наиболее распространённый способ использования – не указывать ни один из именованных аргументов. Если передать `values`, он будет изменён многократными вызовами [`setattr()`](https://python-all.ru/3.12/library/functions.html#setattr) (примерно по одному на каждый аргумент опции, сохраняемый в целевой атрибут) и возвращён [`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args).10411042Если [`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args) обнаруживает ошибки в списке аргументов, он вызывает метод `error()` объекта OptionParser с подходящим сообщением об ошибке для конечного пользователя. В итоге процесс завершается с кодом возврата 2 (традиционный код выхода Unix для ошибок командной строки).10431044### Запросы и изменение вашего парсера опций10451046Поведение парсера опций по умолчанию можно слегка настроить, а также можно заглянуть внутрь парсера и посмотреть, что там есть. OptionParser предоставляет несколько методов, которые в этом помогут:10471048#### `OptionParser.disable_interspersed_args()`10491050Настраивает разбор на остановку при первом не-опции. Например, если `-a` и `-b` – простые опции, не принимающие аргументов, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) обычно принимает такой синтаксис:10511052```python1053prog -a arg1 -b arg21054```10551056и обрабатывает его как эквивалент10571058```python1059prog -a -b arg1 arg21060```10611062Чтобы отключить эту возможность, вызовите [`disable_interspersed_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.disable_interspersed_args). Это восстанавливает традиционный синтаксис Unix, где разбор опций останавливается на первом аргументе, не являющемся опцией.10631064Используйте это, если у вас есть обработчик команд, который запускает другую команду с собственными опциями, и нужно гарантировать, что эти опции не будут перепутаны. Например, каждая команда может иметь свой набор опций.10651066#### `OptionParser.enable_interspersed_args()`10671068Настраивает разбор на то, чтобы не останавливаться на первом не-опции, позволяя перемешивать ключи с аргументами команды. Это поведение по умолчанию.10691070#### `OptionParser.get_option(opt_str)`10711072Возвращает экземпляр Option с строкой опции *opt\_str* или `None`, если ни одна опция не имеет такой строки.10731074#### `OptionParser.has_option(opt_str)`10751076Возвращает `True`, если OptionParser имеет опцию с строкой опции *opt\_str* (например, `-q` или `--verbose`).10771078#### `OptionParser.remove_option(opt_str)`10791080Если [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser) имеет опцию, соответствующую *opt\_str*, эта опция удаляется. Если эта опция предоставляла какие-либо другие строки опций, все эти строки опций становятся недействительными. Если *opt\_str* не встречается ни в одной опции, принадлежащей этому [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser), возбуждается [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError).10811082### Конфликты между опциями10831084Если быть невнимательным, легко определить опции с конфликтующими строками опций:10851086```python1087parser.add_option("-n", "--dry-run", ...)1088...1089parser.add_option("-n", "--noisy", ...)1090```10911092(Это особенно актуально, если определён собственный подкласс OptionParser с некоторыми стандартными опциями.)10931094При каждом добавлении опции [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) проверяет наличие конфликтов с существующими опциями. Если они обнаружены, вызывается текущий механизм обработки конфликтов. Механизм обработки конфликтов можно задать либо в конструкторе:10951096```python1097parser = OptionParser(..., conflict_handler=handler)1098```10991100или отдельным вызовом:11011102```python1103parser.set_conflict_handler(handler)1104```11051106Доступные обработчики конфликтов:11071108> **`"error"` (по умолчанию)**1109>1110> считать конфликты опций программной ошибкой и возбуждать [`OptionConflictError`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionConflictError)1111>1112> **`"resolve"`**1113>1114> разрешать конфликты опций интеллектуально (см. ниже)11151116В качестве примера определим [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser), который разрешает конфликты интеллектуально, и добавим к нему конфликтующие опции:11171118```python1119parser = OptionParser(conflict_handler="resolve")1120parser.add_option("-n", "--dry-run", ..., help="do no harm")1121parser.add_option("-n", "--noisy", ..., help="be noisy")1122```11231124На этом этапе [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) обнаруживает, что ранее добавленная опция уже использует строку опции `-n`. Поскольку `conflict_handler` имеет значение `"resolve"`, ситуация разрешается удалением `-n` из списка строк опций предыдущей опции. Теперь `--dry-run` – единственный способ для пользователя активировать эту опцию. Если пользователь запросит справку, сообщение справки будет отражать это:11251126```python1127Options:1128  --dry-run     do no harm1129  ...1130  -n, --noisy   be noisy1131```11321133Можно постепенно удалять строки опций ранее добавленной опции, пока их не останется, и у пользователя не будет возможности вызвать эту опцию из командной строки. В этом случае [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) полностью удаляет эту опцию, так что она не появляется в тексте справки и где-либо ещё. Продолжая работу с существующим OptionParser:11341135```python1136parser.add_option("--dry-run", ..., help="new dry-run option")1137```11381139На этом этапе исходная опция `-n`/`--dry-run` больше не доступна, поэтому [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) удаляет её, оставляя такой текст справки:11401141```python1142Options:1143  ...1144  -n, --noisy   be noisy1145  --dry-run     new dry-run option1146```11471148### Очистка11491150Экземпляры OptionParser содержат несколько циклических ссылок. Это не должно быть проблемой для сборщика мусора Python, но можно явно разорвать циклические ссылки, вызвав `destroy()` для вашего OptionParser после завершения работы с ним. Это особенно полезно в долго работающих приложениях, где из OptionParser достижимы большие графы объектов.11511152### Другие методы11531154OptionParser поддерживает несколько других открытых методов:11551156#### `OptionParser.set_usage(usage)`11571158Устанавливает строку использования в соответствии с правилами, описанными выше для аргумента конструктора `usage`. Передача `None` устанавливает строку использования по умолчанию; используйте `optparse.SUPPRESS_USAGE`, чтобы подавить сообщение об использовании.11591160#### `OptionParser.print_usage(file=None)`11611162Выводит сообщение об использовании для текущей программы (`self.usage`) в *file* (по умолчанию stdout). Любое вхождение строки `%prog` в `self.usage` заменяется именем текущей программы. Ничего не делает, если `self.usage` пусто или не определено.11631164#### `OptionParser.get_usage()`11651166То же, что и [`print_usage()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.print_usage), но возвращает строку использования вместо её вывода.11671168#### `OptionParser.set_defaults(dest=value, ...)`11691170Устанавливает значения по умолчанию для нескольких целевых параметров опций одновременно. Использование [`set_defaults()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.set_defaults) является предпочтительным способом установки значений по умолчанию для опций, поскольку несколько опций могут совместно использовать один и тот же целевой параметр. Например, если несколько опций «режим» устанавливают один и тот же целевой параметр, любая из них может задать значение по умолчанию, и последняя имеет преимущество:11711172```python1173parser.add_option("--advanced", action="store_const",1174                  dest="mode", const="advanced",1175                  default="novice")    # переопределено ниже1176parser.add_option("--novice", action="store_const",1177                  dest="mode", const="novice",1178                  default="advanced")  # переопределяет вышеуказанную настройку1179```11801181Чтобы избежать этой путаницы, используйте [`set_defaults()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.set_defaults):11821183```python1184parser.set_defaults(mode="advanced")1185parser.add_option("--advanced", action="store_const",1186                  dest="mode", const="advanced")1187parser.add_option("--novice", action="store_const",1188                  dest="mode", const="novice")1189```11901191## Колбэки опций11921193Когда встроенных действий и типов [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) недостаточно, есть два варианта: расширить [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) или определить опцию-колбэк. Расширение [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) более универсально, но для многих простых случаев избыточно. Зачастую простого колбэка вполне достаточно.11941195Определение опции-колбэка состоит из двух шагов:11961197- определить саму опцию с помощью действия `"callback"`1198- написать колбэк – функцию (или метод), которая принимает как минимум четыре аргумента, как описано ниже11991200### Определение опции-колбэка12011202Как всегда, проще всего определить опцию-колбэк с помощью метода [`OptionParser.add_option()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.add_option). Кроме [`action`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.action), единственный атрибут опции, который необходимо указать, – это `callback`, вызываемая функция:12031204```python1205parser.add_option("-c", action="callback", callback=my_callback)1206```12071208`callback` – это функция (или другой вызываемый объект), поэтому к моменту создания опции-колбэка `my_callback()` должна быть уже определена. В этом простом случае [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) даже не знает, принимает ли `-c` какие-либо аргументы, что обычно означает, что опция не принимает аргументов – достаточно одного присутствия `-c` в командной строке. Однако в некоторых ситуациях может потребоваться, чтобы колбэк обрабатывал произвольное количество аргументов командной строки. Здесь написание колбэков становится сложнее; об этом рассказывается далее в этом разделе.12091210[`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) всегда передаёт колбэку четыре определённых аргумента и передаёт дополнительные, только если они указаны через [`callback_args`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback_args) и [`callback_kwargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback_kwargs). Таким образом, минимальная сигнатура функции колбэка выглядит так:12111212```python1213def my_callback(option, opt, value, parser):1214```12151216Четыре аргумента колбэка описаны ниже.12171218Есть ещё несколько атрибутов опции, которые можно указать при определении опции-колбэка:12191220**[`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type)**12211222имеет обычный смысл: как и действия `"store"` или `"append"`, он указывает [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) потребить один аргумент и преобразовать его в [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type). Однако вместо сохранения преобразованного значения где-либо, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) передаёт его функции колбэка.12231224**[`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs)**12251226также имеет обычный смысл: если он указан и больше 1, [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) потребит [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs) аргументов, каждый из которых должен быть преобразуем в [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type). Затем он передаёт колбэку кортеж преобразованных значений.12271228**[`callback_args`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback_args)**12291230кортеж дополнительных позиционных аргументов, передаваемых колбэку12311232**[`callback_kwargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback_kwargs)**12331234словарь дополнительных именованных аргументов, передаваемых колбэку12351236### Как вызываются колбэки12371238Все колбэки вызываются следующим образом:12391240```python1241func(option, opt_str, value, parser, *args, **kwargs)1242```12431244где12451246**`option`**12471248это экземпляр Option, который вызывает колбэк12491250**`opt_str`**12511252это строка опции, указанная в командной строке, которая запускает колбэк. (Если использовалась сокращённая длинная опция, `opt_str` будет полной канонической строкой опции – например, если пользователь ввёл `--foo` в командной строке как сокращение для `--foobar`, то `opt_str` будет `"--foobar"`.)12531254**`value`**12551256это аргумент данной опции, указанный в командной строке. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) будет ожидать аргумент, только если установлен [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type); тип `value` будет типом, подразумеваемым типом опции. Если [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type) для этой опции равно `None` (аргумент не ожидается), то `value` будет `None`. Если [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs) \> 1, `value` будет кортежем значений соответствующего типа.12571258**`parser`**12591260это экземпляр OptionParser, управляющий всем процессом; он полезен тем, что через его атрибуты можно получить доступ к некоторым другим интересным данным:12611262**`parser.largs`**12631264текущий список оставшихся аргументов, то есть аргументов, которые были потреблены, но не являются ни опциями, ни аргументами опций. `parser.largs` можно изменять, например, добавляя в него новые аргументы. (Этот список станет `args`, вторым возвращаемым значением [`parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args).)12651266**`parser.rargs`**12671268текущий список оставшихся аргументов, то есть после удаления `opt_str` и `value` (если применимо), в котором остались только следующие за ними аргументы. `parser.rargs` можно изменять, например, потребляя дополнительные аргументы.12691270**`parser.values`**12711272объект, в котором по умолчанию хранятся значения опций (экземпляр optparse.OptionValues). Это позволяет колбэкам использовать тот же механизм хранения значений опций, что и остальная часть [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse); не нужно возиться с глобальными переменными или замыканиями. Также можно получать или изменять значения любых опций, уже встреченных в командной строке.12731274**`args`**12751276это кортеж произвольных позиционных аргументов, переданных через атрибут опции [`callback_args`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback_args).12771278**`kwargs`**12791280это словарь произвольных именованных аргументов, переданных через [`callback_kwargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.callback_kwargs).12811282### Возбуждение ошибок в колбэке12831284Функция колбэка должна возбуждать [`OptionValueError`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionValueError) при любых проблемах с опцией или её аргументами. [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) перехватывает это исключение и завершает программу, выводя сообщение об ошибке, указанное вами, в stderr. Сообщение должно быть ясным, кратким, точным и содержать указание на опцию, вызвавшую ошибку. В противном случае пользователю будет сложно понять, что он сделал не так.12851286### Пример колбэка 1: тривиальный колбэк12871288Вот пример опции-колбэка, которая не принимает аргументов и просто записывает факт своего появления:12891290```python1291def record_foo_seen(option, opt_str, value, parser):1292    parser.values.saw_foo = True12931294parser.add_option("--foo", action="callback", callback=record_foo_seen)1295```12961297Конечно, это можно было бы сделать с помощью действия `"store_true"`.12981299### Пример колбэка 2: проверка порядка опций13001301Вот чуть более интересный пример: запоминать, что `-a` был замечен, но завершаться с ошибкой, если он встречается после `-b` в командной строке.13021303```python1304def check_order(option, opt_str, value, parser):1305    if parser.values.b:1306        raise OptionValueError("can't use -a after -b")1307    parser.values.a = 11308...1309parser.add_option("-a", action="callback", callback=check_order)1310parser.add_option("-b", action="store_true", dest="b")1311```13121313### Пример колбэка 3: проверка порядка параметров (обобщённый)13141315Если нужно переиспользовать этот колбэк для нескольких похожих параметров (устанавливать флаг, но завершаться с ошибкой, если `-b` уже был замечен), потребуется доработка: сообщение об ошибке и устанавливаемый флаг должны быть обобщены.13161317```python1318def check_order(option, opt_str, value, parser):1319    if parser.values.b:1320        raise OptionValueError("can't use %s after -b" % opt_str)1321    setattr(parser.values, option.dest, 1)1322...1323parser.add_option("-a", action="callback", callback=check_order, dest='a')1324parser.add_option("-b", action="store_true", dest="b")1325parser.add_option("-c", action="callback", callback=check_order, dest='c')1326```13271328### Пример колбэка 4: проверка произвольного условия13291330Конечно, можно задать любое условие – вы не ограничены проверкой значений уже определённых параметров. Например, если есть параметры, которые не должны вызываться в полнолуние, достаточно сделать так:13311332```python1333def check_moon(option, opt_str, value, parser):1334    if is_moon_full():1335        raise OptionValueError("%s option invalid when moon is full"1336                               % opt_str)1337    setattr(parser.values, option.dest, 1)1338...1339parser.add_option("--foo",1340                  action="callback", callback=check_moon, dest="foo")1341```13421343(Определение `is_moon_full()` оставляется читателю в качестве упражнения.)13441345### Пример колбэка 5: фиксированное число аргументов13461347Ситуация становится немного интереснее, когда определяется параметр-колбэк с фиксированным числом аргументов. Указание, что параметр-колбэк принимает аргументы, аналогично определению параметра `"store"` или `"append"`: если задано [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type), то параметр принимает один аргумент, который должен быть преобразуем к этому типу; если дополнительно задано [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs), то параметр принимает [`nargs`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.nargs) аргументов.13481349Вот пример, который просто эмулирует стандартное действие `"store"`:13501351```python1352def store_value(option, opt_str, value, parser):1353    setattr(parser.values, option.dest, value)1354...1355parser.add_option("--foo",1356                  action="callback", callback=store_value,1357                  type="int", nargs=3, dest="foo")1358```13591360Обратите внимание, что [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) сам заботится о потреблении 3 аргументов и преобразовании их в целые числа; остаётся только сохранить их. (Или что угодно; очевидно, для этого примера колбэк не нужен.)13611362### Пример колбэка 6: переменное число аргументов13631364Всё становится сложнее, когда требуется, чтобы параметр принимал переменное число аргументов. В этом случае нужно писать колбэк, так как [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) не предоставляет встроенных средств для этого. И придётся разбираться с определёнными тонкостями традиционного разбора командной строки Unix, которые [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) обычно обрабатывает автоматически. В частности, колбэки должны реализовывать обычные правила для голых аргументов `--` и `-`:13651366- как `--`, так и `-` могут быть аргументами параметра1367- голый `--` (если не является аргументом какого-либо параметра): остановить обработку командной строки и отбросить `--`1368- голый `-` (если не является аргументом какого-либо параметра): остановить обработку командной строки, но сохранить `-` (добавить его к `parser.largs`)13691370Если нужен параметр, принимающий переменное число аргументов, возникает несколько тонких и сложных моментов. Конкретная реализация будет зависеть от того, на какие компромиссы вы готовы пойти для своего приложения (именно поэтому [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) не поддерживает такое напрямую).13711372Тем не менее, вот пример попытки создать колбэк для параметра с переменным числом аргументов:13731374```python1375def vararg_callback(option, opt_str, value, parser):1376    assert value is None1377    value = []13781379    def floatable(str):1380        try:1381            float(str)1382            return True1383        except ValueError:1384            return False13851386    for arg in parser.rargs:1387        # останавливаться на опциях вида --foo1388        if arg[:2] == "--" and len(arg) > 2:1389            break1390        # останавливаться на -a, но не на -3 или -3.01391        if arg[:1] == "-" and len(arg) > 1 and not floatable(arg):1392            break1393        value.append(arg)13941395    del parser.rargs[:len(value)]1396    setattr(parser.values, option.dest, value)13971398...1399parser.add_option("-c", "--callback", dest="vararg_attr",1400                  action="callback", callback=vararg_callback)1401```14021403## Расширение [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse)14041405Поскольку двумя основными управляющими факторами того, как [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) интерпретирует параметры командной строки, являются действие и тип каждого параметра, наиболее вероятное направление расширения – добавление новых действий и новых типов.14061407### Добавление новых типов14081409Чтобы добавить новые типы, нужно определить собственный подкласс класса [`Option`](https://python-all.ru/3.12/library/optparse.html#optparse.Option) из [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse). У этого класса есть пара атрибутов, определяющих типы [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse): [`TYPES`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.TYPES) и [`TYPE_CHECKER`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.TYPE_CHECKER).14101411#### `Option.TYPES`14121413Кортеж имён типов; в своём подклассе просто определите новый кортеж [`TYPES`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.TYPES), основанный на стандартном.14141415#### `Option.TYPE_CHECKER`14161417Словарь, отображающий имена типов в функции проверки типа. Функция проверки типа имеет следующую сигнатуру:14181419```python1420def check_mytype(option, opt, value)1421```14221423где `option` – это экземпляр [`Option`](https://python-all.ru/3.12/library/optparse.html#optparse.Option), `opt` – строка параметра (например, `-f`), а `value` – строка из командной строки, которую нужно проверить и преобразовать в желаемый тип. `check_mytype()` должна возвращать объект гипотетического типа `mytype`. Значение, возвращаемое функцией проверки типа, окажется в экземпляре OptionValues, возвращаемом [`OptionParser.parse_args()`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser.parse_args), или будет передано колбэку как параметр `value`.14241425Функция проверки типа должна возбуждать [`OptionValueError`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionValueError) при возникновении проблем. [`OptionValueError`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionValueError) принимает единственный строковый аргумент, который передаётся как есть методу `error()` объекта [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser), который, в свою очередь, добавляет имя программы и строку `"error:"` и печатает всё в stderr перед завершением процесса.14261427Вот глуповатый пример, демонстрирующий добавление типа параметра `"complex"` для разбора комплексных чисел в стиле Python в командной строке. (Этот пример стал ещё глупее, чем был, потому что в [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) 1.3 добавлена встроенная поддержка комплексных чисел, но не будем обращать внимания.)14281429Сначала необходимые импорты:14301431```python1432from copy import copy1433from optparse import Option, OptionValueError1434```14351436Сначала нужно определить проверщик типов, так как на него будет ссылка позже (в атрибуте класса [`TYPE_CHECKER`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.TYPE_CHECKER) вашего подкласса Option):14371438```python1439def check_complex(option, opt, value):1440    try:1441        return complex(value)1442    except ValueError:1443        raise OptionValueError(1444            "option %s: invalid complex value: %r" % (opt, value))1445```14461447Наконец, подкласс Option:14481449```python1450class MyOption (Option):1451    TYPES = Option.TYPES + ("complex",)1452    TYPE_CHECKER = copy(Option.TYPE_CHECKER)1453    TYPE_CHECKER["complex"] = check_complex1454```14551456(Если бы мы не создали [`copy()`](https://python-all.ru/3.12/library/copy.html#module-copy) для [`Option.TYPE_CHECKER`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.TYPE_CHECKER), мы бы в итоге изменили атрибут [`TYPE_CHECKER`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.TYPE_CHECKER) класса Option из [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse). Поскольку это Python, ничто не мешает это сделать, кроме хороших манер и здравого смысла.)14571458Вот и всё! Теперь можно написать скрипт, использующий новый тип опции, точно так же, как и любой другой скрипт на основе [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse), за исключением того, что нужно указать своему OptionParser использовать MyOption вместо Option:14591460```python1461parser = OptionParser(option_class=MyOption)1462parser.add_option("-c", type="complex")1463```14641465Либо можно собрать собственный список опций и передать его в OptionParser; если не использовать `add_option()` описанным выше способом, не требуется сообщать OptionParser, какой класс опции использовать:14661467```python1468option_list = [MyOption("-c", action="store", type="complex", dest="c")]1469parser = OptionParser(option_list=option_list)1470```14711472### Добавление новых действий14731474Добавление новых действий немного сложнее, потому что нужно понимать, что [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) разделяет действия на несколько категорий:14751476**«store»-действия**14771478действия, в результате которых [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) сохраняет значение в атрибут текущего экземпляра OptionValues; для таких опций в конструктор Option требуется передать атрибут [`dest`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.dest).14791480**«typed»-действия**14811482действия, которые берут значение из командной строки и ожидают, что оно будет определённого типа; точнее, ожидают строку, которую можно преобразовать в заданный тип. Для таких опций в конструктор Option требуется передать атрибут [`type`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.type).14831484Это пересекающиеся множества: к стандартным «store»-действиям относятся `"store"`, `"store_const"`, `"append"` и `"count"`, а к стандартным «typed»-действиям – `"store"`, `"append"` и `"callback"`.14851486При добавлении действия его нужно отнести к категории, включив как минимум в один из следующих атрибутов класса Option (все они являются списками строк):14871488#### `Option.ACTIONS`14891490Все действия должны быть перечислены в ACTIONS.14911492#### `Option.STORE_ACTIONS`14931494«store»-действия дополнительно перечисляются здесь.14951496#### `Option.TYPED_ACTIONS`14971498«typed»-действия дополнительно перечисляются здесь.14991500#### `Option.ALWAYS_TYPED_ACTIONS`15011502Действия, которые всегда принимают тип (то есть их опции всегда получают значение), дополнительно перечисляются здесь. Единственный эффект этого состоит в том, что [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) назначает тип по умолчанию `"string"` опциям без явно указанного типа, чьё действие перечислено в [`ALWAYS_TYPED_ACTIONS`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.ALWAYS_TYPED_ACTIONS).15031504Чтобы реализовать новое действие, нужно переопределить метод `take_action()` класса Option и добавить ветвь, распознающую это действие.15051506Например, добавим действие `"extend"`. Оно похоже на стандартное `"append"`, но вместо того, чтобы взять из командной строки одно значение и добавить его в конец существующего списка, `"extend"` принимает несколько значений в одной строке с разделителями-запятыми и расширяет ими существующий список. То есть, если `--names` является опцией `"extend"` с типом `"string"`, то командная строка15071508```python1509--names=foo,bar --names blah --names ding,dong1510```15111512приведёт к списку15131514```python1515["foo", "bar", "blah", "ding", "dong"]1516```15171518Снова определим подкласс Option:15191520```python1521class MyOption(Option):15221523    ACTIONS = Option.ACTIONS + ("extend",)1524    STORE_ACTIONS = Option.STORE_ACTIONS + ("extend",)1525    TYPED_ACTIONS = Option.TYPED_ACTIONS + ("extend",)1526    ALWAYS_TYPED_ACTIONS = Option.ALWAYS_TYPED_ACTIONS + ("extend",)15271528    def take_action(self, action, dest, opt, value, values, parser):1529        if action == "extend":1530            lvalue = value.split(",")1531            values.ensure_value(dest, []).extend(lvalue)1532        else:1533            Option.take_action(1534                self, action, dest, opt, value, values, parser)1535```15361537Что следует отметить:15381539- `"extend"` одновременно ожидает значение в командной строке и сохраняет его, поэтому попадает как в [`STORE_ACTIONS`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.STORE_ACTIONS), так и в [`TYPED_ACTIONS`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.TYPED_ACTIONS).1540- чтобы [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse) назначал тип по умолчанию `"string"` действиям `"extend"`, мы помещаем действие `"extend"` также в [`ALWAYS_TYPED_ACTIONS`](https://python-all.ru/3.12/library/optparse.html#optparse.Option.ALWAYS_TYPED_ACTIONS).1541- `MyOption.take_action()` реализует только это одно новое действие и передаёт управление обратно `Option.take_action()` для стандартных действий [`optparse`](https://python-all.ru/3.12/library/optparse.html#module-optparse).1542- `values` – это экземпляр класса optparse\_parser.Values, предоставляющий очень полезный метод `ensure_value()`. `ensure_value()` – это по сути [`getattr()`](https://python-all.ru/3.12/library/functions.html#getattr) с предохранительным клапаном; он вызывается как15431544  ```python1545  values.ensure_value(attr, value)1546  ```15471548  Если атрибут `attr` у `values` не существует или равен `None`, то ensure\_value() сначала устанавливает его в `value`, а затем возвращает `value`. Это очень удобно для таких действий, как `"extend"`, `"append"` и `"count"`, которые накапливают данные в переменной и ожидают, что эта переменная будет определённого типа (список для первых двух, целое число для последнего). Использование `ensure_value()` означает, что скриптам, использующим ваше действие, не нужно беспокоиться о задании значения по умолчанию для соответствующих назначений опций; они могут просто оставить значение по умолчанию равным `None`, и `ensure_value()` позаботится о том, чтобы при необходимости установить его правильно.15491550## Исключения15511552#### `exception optparse.OptionError`15531554Возбуждается, если экземпляр [`Option`](https://python-all.ru/3.12/library/optparse.html#optparse.Option) создан с недопустимыми или противоречивыми аргументами.15551556#### `exception optparse.OptionConflictError`15571558Возбуждается, если в [`OptionParser`](https://python-all.ru/3.12/library/optparse.html#optparse.OptionParser) добавляются конфликтующие опции.15591560#### `exception optparse.OptionValueError`15611562Возбуждается, если в командной строке указано недопустимое значение параметра.15631564#### `exception optparse.BadOptionError`15651566Возбуждается, если в командной строке передан недопустимый параметр.15671568#### `exception optparse.AmbiguousOptionError`15691570Возбуждается, если в командной строке передан неоднозначный параметр.1571