> **Источник:** https://python-all.ru/3.3/library/getopt.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# 16.6. [`getopt`](https://python-all.ru/3.3/library/getopt.html#module-getopt) – C-подобный парсер для параметров командной строки

**Исходный код:** [Lib/getopt.py](https://python-all.ru/src/3.3/Lib/getopt.py)

---

> **Примечание**
>
> Модуль [`getopt`](https://python-all.ru/3.3/library/getopt.html#module-getopt) – это парсер параметров командной строки, API которого спроектирован так, чтобы быть знакомым пользователям функции C `getopt()`. Пользователи, не знакомые с функцией C `getopt()` или желающие писать меньше кода и получать более качественную справку и сообщения об ошибках, должны рассмотреть использование модуля [`argparse`](https://python-all.ru/3.3/library/argparse.html#module-argparse).

Этот модуль помогает скриптам разбирать аргументы командной строки в `sys.argv`. Он поддерживает те же соглашения, что и функция Unix `getopt()` (включая особое значение аргументов вида ‘`-`‘ и ‘`--`‘). Длинные опции, аналогичные тем, что поддерживаются программным обеспечением GNU, также могут использоваться через необязательный третий аргумент.

Этот модуль предоставляет две функции и одно исключение:

#### `getopt.getopt(args, shortopts, longopts=[])`

Разбирает параметры командной строки и список параметров. *args* – это список аргументов для разбора, без ведущей ссылки на запущенную программу. Обычно это означает `sys.argv[1:]`. *shortopts* – это строка букв опций, которые скрипт хочет распознать, причем опции, требующие аргумент, сопровождаются двоеточием (`':'`; то есть тот же формат, что использует Unix `getopt()`).

> **Примечание**
>
> В отличие от GNU `getopt()`, после аргумента, не являющегося опцией, все последующие аргументы также считаются не опциями. Это похоже на то, как работают не-GNU Unix системы.

*longopts*, если указан, должен быть списком строк с именами длинных опций, которые должны поддерживаться. Символы `'--'` в начале не должны включаться в имя опции. Длинные опции, требующие аргумент, должны сопровождаться знаком равенства (`'='`). Необязательные аргументы не поддерживаются. Чтобы принимать только длинные опции, *shortopts* должна быть пустой строкой. Длинные опции в командной строке могут быть распознаны, если они предоставляют префикс имени опции, который совпадает ровно с одной из принятых опций. Например, если *longopts* равно `['foo', 'frob']`, то опция `--fo` будет соответствовать `--foo`, а `--f` не будет соответствовать однозначно, поэтому будет вызвано исключение [`GetoptError`](https://python-all.ru/3.3/library/getopt.html#getopt.GetoptError).

Возвращаемое значение состоит из двух элементов: первый – это список пар `(option, value)`; второй – это список аргументов программы, оставшихся после удаления списка опций (это конечный срез *args*). Каждая возвращенная пара «опция-значение» содержит опцию в качестве первого элемента, с префиксом в виде дефиса для коротких опций (например, `'-x'`) или двух дефисов для длинных опций (например, `'--long-option'`), и аргумент опции в качестве второго элемента, либо пустую строку, если опция не имеет аргумента. Опции располагаются в списке в том же порядке, в котором они были найдены, что допускает множественное появление. Длинные и короткие опции могут быть перемешаны.

#### `getopt.gnu_getopt(args, shortopts, longopts=[])`

Эта функция работает как [`getopt()`](https://python-all.ru/3.3/library/getopt.html#module-getopt), за исключением того, что по умолчанию используется режим сканирования в стиле GNU. Это означает, что опции и аргументы, не являющиеся опциями, могут перемежаться. Функция [`getopt()`](https://python-all.ru/3.3/library/getopt.html#module-getopt) прекращает обработку опций, как только встречается аргумент, не являющийся опцией.

Если первый символ строки опций равен `'+'`, или если установлена переменная окружения `POSIXLY_CORRECT`, то обработка опций прекращается, как только встречается аргумент, не являющийся опцией.

#### `exception getopt.GetoptError`

Это исключение вызывается, когда в списке аргументов найдена нераспознанная опция или когда опции, требующей аргумента, не предоставлено ни одного. Аргумент исключения – строка, указывающая причину ошибки. Для длинных опций передача аргумента опции, которая его не требует, также вызовет это исключение. Атрибуты `msg` и `opt` содержат сообщение об ошибке и связанную опцию; если нет конкретной опции, к которой относится исключение, `opt` является пустой строкой.

#### `exception getopt.error`

Псевдоним для [`GetoptError`](https://python-all.ru/3.3/library/getopt.html#getopt.GetoptError); для обратной совместимости.

Пример использования только опций в стиле Unix:

```python
>>> import getopt
>>> args = '-a -b -cfoo -d bar a1 a2'.split()
>>> args
['-a', '-b', '-cfoo', '-d', 'bar', 'a1', 'a2']
>>> optlist, args = getopt.getopt(args, 'abc:d:')
>>> optlist
[('-a', ''), ('-b', ''), ('-c', 'foo'), ('-d', 'bar')]
>>> args
['a1', 'a2']
```

Использование длинных имён опций так же просто:

```python
>>> s = '--condition=foo --testing --output-file abc.def -x a1 a2'
>>> args = s.split()
>>> args
['--condition=foo', '--testing', '--output-file', 'abc.def', '-x', 'a1', 'a2']
>>> optlist, args = getopt.getopt(args, 'x', [
...     'condition=', 'output-file=', 'testing'])
>>> optlist
[('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x', '')]
>>> args
['a1', 'a2']
```

В скрипте типичное использование выглядит примерно так:

```python
import getopt, sys

def main():
    try:
        opts, args = getopt.getopt(sys.argv[1:], "ho:v", ["help", "output="])
    except getopt.GetoptError as err:
        # вывести справочную информацию и завершить работу:
        print(err) # выведет что-то вроде "option -a not recognized"
        usage()
        sys.exit(2)
    output = None
    verbose = False
    for o, a in opts:
        if o == "-v":
            verbose = True
        elif o in ("-h", "--help"):
            usage()
            sys.exit()
        elif o in ("-o", "--output"):
            output = a
        else:
            assert False, "unhandled option"
    # ...

if __name__ == "__main__":
    main()
```

Обратите внимание, что эквивалентный интерфейс командной строки можно создать с меньшим объемом кода и более информативными справкой и сообщениями об ошибках, используя модуль [`argparse`](https://python-all.ru/3.3/library/argparse.html#module-argparse):

```python
import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-o', '--output')
    parser.add_argument('-v', dest='verbose', action='store_true')
    args = parser.parse_args()
    # ... выполнить какие-то действия с args.output ...
    # ... выполнить какие-то действия с args.verbose ..
```

> **См. также**
>
> **Модуль [`argparse`](https://python-all.ru/3.3/library/argparse.html#module-argparse)**
>
> Альтернативная библиотека для разбора опций и аргументов командной строки.