Python(1): 命令行选项解析

参考: https://docs.python.org/3/library/getopt.html?highlight=option

getopt模块是C风格的命令行参数选项解析模块,方便那些对C语言比较熟悉的用户。

该模块主要提供2个函数和一个异常处理:

getopt.getopt(args, shortopts, longopts=[]): 参数args是一个列表，一般是 sys.argv[1:]参数shortopts用一个字符串标记选项，如果选项有参数值，则增加 :参数longopts是可选的，是一个列表，包含了所有 -- 长选项的名字getopt.gnu_getopt(args, shortopts, longopts=[]): 基本和getopt一样，只是扫描风格是GNU风格exception getopt.GetoptError: 当解析错误就触发exception getopt.error: 等同于GetoptError

举例1：

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

举例2：

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

举例3：

import getopt, sysdef 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()

4 optparse模块

参考: https://docs.python.org/3/library/optparse.html?highlight=option

这个模块将不会继续开发，如果可以，尽量使用 argparse模块 :

Deprecated since version 3.2: The optparse module is deprecated and will not be developed further; development will continue with the argparse module.

5 argparse模块

参考:

https://docs.python.org/3/howto/argparse.html?highlight=optionhttps://docs.python.org/3/library/argparse.html?highlight=option

argparse模块可以用很少的代码而获取强大的命令行选项解析功能,简单易用.

举例1：

import argparseparser = argparse.ArgumentParser(description='Process some integers.')parser.add_argument('integers', metavar='N', type=int, nargs='+',                   help='an integer for the accumulator')parser.add_argument('--sum', dest='accumulate', action='store_const',                   const=sum, default=max,                   help='sum the integers (default: find the max)')args = parser.parse_args()print(args.accumulate(args.integers))

5.1 创建对象

argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=, []formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True)

prog: 默认是sys.argv[ 0 ]，即程序名usage: 默认是根据参数自动生成description: 对程序的描述信息，在help选项信息之前打印epilog: 对程序的补充信息，在help选项信息之后打印parents=list(): 继承一个父argparse对象的属性，作为一个列表元素提供conflict_handler: 解决选项冲突问题add_help: 增加-h/–help选项，默认开启

举例:

>>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]')>>> parent_parser = argparse.ArgumentParser(add_help=False)>>> parent_parser.add_argument('--parent', type=int)>>> foo_parser = argparse.ArgumentParser(parents=[parent_parser])>>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve')>>> parser.add_argument('-f', '--foo', help='old foo help')>>> parser.add_argument('--foo', help='new foo help')

5.2 选项

add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

name: 就是选项名称action:store: 保存选项值store_const: 保存的值由const决定store_true，store_false：包含选择，则返回True或者Falseappend：将值追加到一个列表，方便重复使用选项的情况append_constcount：记录选择的次数version：取决于version关键字

举例1；

>>> parser.add_argument('--foo', action='store_const', const=42)>>> parser.add_argument('--foo', action='store_true')>>> parser.add_argument('--foo', action='append')>>> parser.add_argument('--int', dest='types', action='append_const', const=int)>>> parser.add_argument('--verbose', '-v', action='count')>>> parser.add_argument('--version', action='version', version='%(prog)s 2.0')

举例2:

import argparseparser = argparse.ArgumentParser(description="calculate X to the power of Y")group = parser.add_mutually_exclusive_group()group.add_argument("-v", "--verbose", action="store_true")group.add_argument("-q", "--quiet", action="store_true")parser.add_argument("x", type=int, help="the base")parser.add_argument("y", type=int, help="the exponent")args = parser.parse_args()answer = args.x**args.yif args.quiet:    print(answer)elif args.verbose:    print("{} to the power {} equals {}".format(args.x, args.y, answer))else:    print("{}^{} == {}".format(args.x, args.y, answer))$ python3 prog.py --helpusage: prog.py [-h] [-v | -q] x ycalculate X to the power of Ypositional arguments:  x              the base  y              the exponentoptional arguments:  -h, --help     show this help message and exit  -v, --verbose  -q, --quiet

6 后记

写笔记，也就是让自己认真点看文档，使用的时候，还是官网的文档详细明了。

▲

---

作者简介：

朱春来(Leslie Zhu)，金融工程师，毕业于西安电子科技大学, 喜欢历史，喜欢编程. 日常在GNU/Linux环境下进行C/C++、Python开发，对Common Lisp、Node.js、金融等感兴趣。可以通过邮箱(pythonisland@gmail.com)联系他，或者直接在他的个人主页上留言.

访问朱春来(Leslie Zhu)的个人主页(http://lesliezhu.github.com)

原文地址：Python(1): 命令行选项解析, 感谢原作者分享。 成功是什么?就是走过了所有通向失败的路.只剩下一条路.那就是成功的路.