`getopt` - 用于命令行选项的 C 风格解析器¶

注意

getopt 模块是一个命令行选项解析器，其 API 设计旨在让熟悉 C 语言 getopt() 函数的用户感到熟悉。不熟悉 C 语言 getopt() 函数或希望编写更少代码并获得更好的帮助和错误消息的用户，应该考虑使用 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。

返回值包含两个元素：第一个是 (option, value) 对的列表；第二个是在删除选项列表后剩余的程序参数列表（这是 args 的尾部切片）。返回的每个选项和值对的第一个元素是选项，短选项前缀为连字符（例如，'-x'），长选项前缀为两个连字符（例如，'--long-option'），第二个元素是选项参数，如果选项没有参数，则为空字符串。选项在列表中出现的顺序与其找到的顺序相同，因此允许多次出现。长选项和短选项可以混合使用。

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

此函数的工作方式类似于 getopt()，只是默认情况下使用 GNU 风格的扫描模式。这意味着选项和非选项参数可以混合使用。getopt() 函数在遇到非选项参数时停止处理选项。

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

异常 getopt.GetoptError¶: 当在参数列表中找到无法识别的选项，或者需要参数的选项未给出参数时，将引发此异常。异常的参数是一个字符串，指示错误原因。对于长选项，如果为不需要参数的选项提供了参数，也会引发此异常。属性 msg 和 opt 给出错误消息和相关选项；如果没有与异常相关的特定选项，则 opt 为空字符串。

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

在脚本中，典型的用法如下

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

另请参阅

模块 argparse: 可选的命令行选项和参数解析库。

`getopt` - 用于命令行选项的 C 风格解析器¶

上一主题

下一主题

本页

getopt - 用于命令行选项的 C 风格解析器¶

`getopt` - 用于命令行选项的 C 风格解析器¶