python模块之getopt脚本参数解析

jiezi

6 年前

getopt模块用于解析脚本参数。

解析命令行选项及参数列表。

args：要解析的参数列表，但不包括当前执行的 python 脚本名称，一般等同于sys.argv[1:]。

shortopts：要识别的短选项字符串，如果后接 : 表示需要给定参数。如 ab:c:，表示识别-a, -b 和-c的短选项，其中 -b 和-c需要后接参数。如果不需要短选项，可以设置为空字符串。

longopts：要识别的长选项列表 (不包括-- 前缀)，长选项如果后接 = 表示需要给定参数，不支持可选参数。如 ["help", "user=", "password="]，表示识别--help, --user=root, --password=123456 的长选项。

函数返回值由两个元素组成。第一个是 (option, value) 元组的列表，第二个是 args 剥离短选项及其参数和长选项及其参数之后剩余的参数列表。(option, value)元组中的 option 表示包含 - 或--前缀的选项，value 表示该 option 对应的参数，可以为空字符串表示无参数。

import getopt

# 模拟向 MySQL 的 test 库导入 tb_country.sql 的命令行
args = "-uroot -p --host=127.0.0.1 --port=3306 --verbose -Dtest < tb_country.sql".split()

options, arg = getopt.getopt(args, "u:pD:", ["host=", "port=", "verbose"])

print(arg)  
# ['<', 'tb_country.sql']

for option in options:
    print(option)
# ('-u', 'root')
# ('-p', '')
# ('--host', '127.0.0.1')
# ('--port', '3306')
# ('--verbose', '')
# ('-D', 'test')

一旦遇到非选项参数，将停止选项解析，从该非选项参数开始的所有参数全部视为返回值中的第二个元素

import getopt

args = "-a root 123456 -b --opt1 --opt2".split()

options, arg = getopt.getopt(args, "ab", ["opt1", "opt2"])
print(arg)      # ['root', '123456', '-b', '--opt1', '--opt2']
print(options)  # [('-a', '')]

和 getopt() 类似，但默认使用 GNU 风格的选项解析模式，这意味着选项参数和非选项参数可以混合，而 getopt() 会在遇到第一个非选项参数时停止解析。

如果 shortopts 的首字符为+，或者设置了环境变量POSIXLY_CORRECT，同样会在遇到第一个非选项参数时停止解析。

getopt.error异常的别名。以下几种情况将抛出此异常：a)参数列表中存在不能识别的选项 b) 某个需要传值的选项没有给定值 c) 传递了值给不需要参数的长选项。

属性 msg 和opt分别表示错误信息和相关选项，opt 可能为空字符串。

python模块之getopt脚本参数解析

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

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

exception getopt.GetoptError