getopt —用于命令行选项的 C 样式解析器

源代码： Lib/getopt.py

Note

getopt模块是命令行选项的解析器，其 API 设计为 C getopt()函数的用户熟悉。不熟悉 C getopt()函数或希望编写更少代码并获得更好帮助和错误消息的用户，应考虑改用argparse模块。

此模块可帮助脚本解析sys.argv中的命令行参数。它支持与 Unix getopt()函数相同的约定(包括格式为-和--的参数的特殊含义)。也可以pass可选的第三个参数使用与 GNU 软件支持的长选项相似的长选项。

该模块提供两个Function和一个 exception：

Note

与 GNU getopt()不同，在非选项参数之后，所有其他参数也被视为非选项。这类似于非 GNU Unix 系统的工作方式。

返回值包含两个元素：第一个是(option, value)对的列表；第二个是剥离选项列表后剩下的程序参数列表(这是* args *的结尾部分)。返回的每个选项和值对都将选项作为其第一个元素，对于短选项(例如'-x')或连字符(对于长选项(例如'--long-option')，两个连字符)作为前缀，并将选项参数作为其第二个元素，或如果选项没有参数，则为空字符串。这些选项在列表中的出现 Sequences 与找到它们的 Sequences 相同，因此允许多次出现。多头和空头期权可能混合在一起。

如果选项字符串的第一个字符为'+'，或者设置了环境变量 POSIXLY_CORRECT，则一旦遇到非选项参数，选项处理就会停止。

仅使用 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']

在脚本中，典型用法是这样的：

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()

请注意，使用argparse模块可以使用更少的代码和更多有用的帮助和错误消息来生成等效的命令行界面：

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 ..

See also

  • Module argparse

  • 备用命令行选项和参数解析库。

首页