getopt — C-style parser for command line options

Вихідний код: Lib/getopt.py

Застаріло починаючи з версії 3.13: The getopt module is soft deprecated and will not be developed further; development will continue with the argparse module.

Примітка

The getopt module is a parser for command line options whose API is designed to be familiar to users of the C getopt() function. Users who are unfamiliar with the C getopt() function or who would like to write less code and get better help and error messages should consider using the argparse module instead.

---

This module helps scripts to parse the command line arguments in sys.argv. It supports the same conventions as the Unix getopt() function (including the special meanings of arguments of the form „-“ and „--„). Long options similar to those supported by GNU software may be used as well via an optional third argument.

Цей модуль забезпечує дві функції та виняток:

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

Parses command line options and parameter list. args is the argument list to be parsed, without the leading reference to the running program. Typically, this means sys.argv[1:]. shortopts is the string of option letters that the script wants to recognize, with options that require an argument followed by a colon (':'; i.e., the same format that Unix getopt() uses).

Примітка

Unlike GNU getopt(), after a non-option argument, all further arguments are considered also non-options. This is similar to the way non-GNU Unix systems work.

longopts, якщо вказано, має бути списком рядків із іменами довгих параметрів, які мають підтримуватися. Початкові символи ''--' не повинні включатися в назву опції. Довгі параметри, які потребують аргументу, повинні супроводжуватися знаком рівності ('='). Необов’язкові аргументи не підтримуються. Щоб приймати лише довгі варіанти, shortopts має бути порожнім рядком. Довгі параметри в командному рядку можна розпізнати, якщо вони містять префікс назви параметра, який точно відповідає одному з прийнятих параметрів. Наприклад, якщо longopts є ['foo', 'frob'], опція --fo відповідатиме --foo, але --f не збігатиметься однозначно, тому буде викликано GetoptError.

Повернене значення складається з двох елементів: перший – це список пар (параметр, значення); другий — список аргументів програми, що залишився після видалення списку параметрів (це кінцевий фрагмент args). Кожна повернута пара параметрів і значень має параметр як перший елемент із префіксом дефіса для коротких варіантів (наприклад, '-x'') або двох дефісів для довгих варіантів (наприклад, '--long-option'), і аргумент параметра як його другий елемент або порожній рядок, якщо параметр не має аргументу. Параметри з’являються в списку в тому самому порядку, в якому вони були знайдені, таким чином допускаючи багатократне повторення. Довгі та короткі варіанти можуть змішуватися.

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

Ця функція працює як getopt(), за винятком того, що за замовчуванням використовується режим сканування у стилі GNU. Це означає, що аргументи варіантів і неваріантів можуть змішуватися. Функція getopt() припиняє обробку опцій, щойно зустрічається аргумент, що не є опцією.

If the first character of the option string is '+', or if the environment variable POSIXLY_CORRECT is set, then option processing stops as soon as a non-option argument is encountered.

exception getopt.GetoptError

This is raised when an unrecognized option is found in the argument list or when an option requiring an argument is given none. The argument to the exception is a string indicating the cause of the error. For long options, an argument given to an option which does not require one will also cause this exception to be raised. The attributes msg and opt give the error message and related option; if there is no specific option to which the exception relates, opt is an empty string.

exception getopt.error

Псевдонім для GetoptError; для зворотної сумісності.

Приклад використання лише параметрів стилю Unix:

>>> 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']

Використовувати довгі назви параметрів так само легко:

>>> 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']

In a script, typical usage is something like this:

import getopt, sys

def main():
    try:
        opts, args = getopt.getopt(sys.argv[1:], "ho:v", ["help", "output="])
    except getopt.GetoptError as err:
        # print help information and exit:
        print(err)  # will print something like "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()

Note that an equivalent command line interface could be produced with less code and more informative help and error messages by using the argparse module:

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()
    # ... do something with args.output ...
    # ... do something with args.verbose ..

Дивись також

Модуль argparse

Альтернативний параметр командного рядка та бібліотека аналізу аргументів.