`getopt.md`

147 строк · 12.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.13/library/getopt.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `getopt` – анализатор параметров командной строки в стиле C89**Исходный код:** [Lib/getopt.py](https://python-all.ru/src/3.13/Lib/getopt.py)1011> **Примечание**12>13> Этот модуль считается функционально завершённым. Более декларативная и расширяемая альтернатива этому API предоставляется в модуле [`optparse`](https://python-all.ru/3.13/library/optparse.html#module-optparse). Дополнительные функциональные улучшения для обработки параметров командной строки предоставляются либо сторонними модулями на PyPI, либо как возможности модуля [`argparse`](https://python-all.ru/3.13/library/argparse.html#module-argparse).1415---1617Этот модуль помогает скриптам разбирать аргументы командной строки в `sys.argv`. Он поддерживает те же соглашения, что и функция Unix `getopt()` (включая особые значения аргументов вида '`-`' и '`--`'). Длинные опции, подобные поддерживаемым программным обеспечением GNU, также могут использоваться через необязательный третий аргумент.1819Пользователям, не знакомым с функцией Unix `getopt()`, следует рассмотреть использование модуля [`argparse`](https://python-all.ru/3.13/library/argparse.html#module-argparse). Пользователи, знакомые с функцией Unix `getopt()`, но желающие получить эквивалентное поведение, написав меньше кода и получая более качественные справку и сообщения об ошибках, должны рассмотреть использование модуля [`optparse`](https://python-all.ru/3.13/library/optparse.html#module-optparse). Подробнее см. [Выбор библиотеки разбора аргументов](https://python-all.ru/3.13/library/optparse.html#choosing-an-argument-parser).2021Этот модуль предоставляет две функции и одно исключение:2223#### `getopt.getopt(args, shortopts, longopts=[])`2425Разбирает опции командной строки и список параметров. *args* – это список аргументов для разбора, без ссылки на исполняемую программу. Обычно это означает `sys.argv[1:]`. *shortopts* – строка букв опций, которые скрипт хочет распознавать; опции, требующие аргумент, сопровождаются двоеточием (`':'`; то есть тот же формат, который использует Unix `getopt()`).2627> **Примечание**28>29> В отличие от GNU `getopt()`, после неопционного аргумента все последующие аргументы также считаются неопционными. Это аналогично тому, как работают не-GNU Unix-системы.3031*longopts*, если указан, должен быть списком строк с именами длинных опций, которые следует поддерживать. Символы `'--'` в начале не должны включаться в имя опции. Длинные опции, требующие аргумент, должны сопровождаться знаком равенства (`'='`). Необязательные аргументы не поддерживаются. Чтобы принимать только длинные опции, *shortopts* должна быть пустой строкой. Длинные опции в командной строке распознаются, если они предоставляют префикс имени опции, который точно соответствует одной из принятых опций. Например, если *longopts* равно `['foo', 'frob']`, то опция `--fo` будет соответствовать `--foo`, но `--f` не будет соответствовать однозначно, поэтому будет возбуждено [`GetoptError`](https://python-all.ru/3.13/library/getopt.html#getopt.GetoptError).3233Возвращаемое значение состоит из двух элементов: первый – список пар `(option, value)`; второй – список аргументов программы, оставшихся после удаления списка опций (это конечный срез *args*). Каждая возвращаемая пара «опция-значение» содержит опцию в качестве первого элемента, с префиксом дефис для коротких опций (например, `'-x'`) или двух дефисов для длинных опций (например, `'--long-option'`), и аргумент опции в качестве второго элемента, или пустую строку, если у опции нет аргумента. Опции располагаются в списке в том же порядке, в котором они были найдены, что допускает повторения. Длинные и короткие опции могут смешиваться.3435#### `getopt.gnu_getopt(args, shortopts, longopts=[])`3637Эта функция работает как [`getopt()`](https://python-all.ru/3.13/library/getopt.html#module-getopt), за исключением того, что по умолчанию используется режим сканирования в стиле GNU. Это означает, что опционные и неопционные аргументы могут перемешиваться. Функция `getopt()` прекращает обработку опций, как только встречается неопционный аргумент.3839Если первый символ строки опций – `'+'`, или установлена переменная окружения `POSIXLY_CORRECT`, то обработка опций прекращается, как только встречается неопционный аргумент.4041#### `exception getopt.GetoptError`4243Это исключение возбуждается, когда в списке аргументов обнаружена нераспознанная опция или когда опции, требующей аргумента, не передано ни одного. Аргумент исключения – строка, указывающая причину ошибки. Для длинных опций передача аргумента опции, которая его не требует, также вызовет это исключение. Атрибуты `msg` и `opt` содержат сообщение об ошибке и соответствующую опцию; если нет конкретной опции, к которой относится исключение, `opt` является пустой строкой.4445#### `exception getopt.error`4647Псевдоним для [`GetoptError`](https://python-all.ru/3.13/library/getopt.html#getopt.GetoptError); для обратной совместимости.4849Пример использования только опций в стиле Unix:5051```pycon52>>> import getopt53>>> args = '-a -b -cfoo -d bar a1 a2'.split()54>>> args55['-a', '-b', '-cfoo', '-d', 'bar', 'a1', 'a2']56>>> optlist, args = getopt.getopt(args, 'abc:d:')57>>> optlist58[('-a', ''), ('-b', ''), ('-c', 'foo'), ('-d', 'bar')]59>>> args60['a1', 'a2']61```6263Использование длинных имён опций так же просто:6465```pycon66>>> s = '--condition=foo --testing --output-file abc.def -x a1 a2'67>>> args = s.split()68>>> args69['--condition=foo', '--testing', '--output-file', 'abc.def', '-x', 'a1', 'a2']70>>> optlist, args = getopt.getopt(args, 'x', [71...     'condition=', 'output-file=', 'testing'])72>>> optlist73[('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x', '')]74>>> args75['a1', 'a2']76```7778В скрипте типичное использование выглядит примерно так:7980```python81import getopt, sys8283def main():84    try:85        opts, args = getopt.getopt(sys.argv[1:], "ho:v", ["help", "output="])86    except getopt.GetoptError as err:87        # вывести справочную информацию и завершить работу:88        print(err)  # выведет что-то вроде "option -a not recognized"89        usage()90        sys.exit(2)91    output = None92    verbose = False93    for o, a in opts:94        if o == "-v":95            verbose = True96        elif o in ("-h", "--help"):97            usage()98            sys.exit()99        elif o in ("-o", "--output"):100            output = a101        else:102            assert False, "unhandled option"103    process(args, output=output, verbose=verbose)104105if __name__ == "__main__":106    main()107```108109Обратите внимание, что эквивалентный интерфейс командной строки можно создать с меньшим объёмом кода и более информативными справкой и сообщениями об ошибках, используя модуль [`optparse`](https://python-all.ru/3.13/library/optparse.html#module-optparse):110111```python112import optparse113114if __name__ == '__main__':115    parser = optparse.OptionParser()116    parser.add_option('-o', '--output')117    parser.add_option('-v', dest='verbose', action='store_true')118    opts, args = parser.parse_args()119    process(args, output=opts.output, verbose=opts.verbose)120```121122Примерно эквивалентный интерфейс командной строки для этого случая также можно создать с помощью модуля [`argparse`](https://python-all.ru/3.13/library/argparse.html#module-argparse):123124```python125import argparse126127if __name__ == '__main__':128    parser = argparse.ArgumentParser()129    parser.add_argument('-o', '--output')130    parser.add_argument('-v', dest='verbose', action='store_true')131    parser.add_argument('rest', nargs='*')132    args = parser.parse_args()133    process(args.rest, output=args.output, verbose=args.verbose)134```135136Подробнее о том, чем поведение версии `argparse` этого кода отличается от версии `optparse` (и `getopt`), см. [Выбор библиотеки разбора аргументов](https://python-all.ru/3.13/library/optparse.html#choosing-an-argument-parser).137138> **См. также**139>140> **Модуль [`optparse`](https://python-all.ru/3.13/library/optparse.html#module-optparse)**141>142> Декларативный разбор опций командной строки.143>144> **Модуль [`argparse`](https://python-all.ru/3.13/library/argparse.html#module-argparse)**145>146> Более строгая библиотека для разбора опций и аргументов командной строки.147