13.3 解析命令行选项
模块可被用来解析命令行选项。下面一个简单例子演示了最基本的用法:
该程序定义了一个如下使用的命令行解析器:
- bash % python3 search.py -h
- usage: search.py [-h] [-p pattern] [-v] [-o OUTFILE] [--speed {slow,fast}]
- [filename [filename ...]]
- positional arguments:
- filename
- optional arguments:
- -h, --help show this help message and exit
- -p pattern, --pat pattern
- -v verbose mode
- -o OUTFILE output file
- --speed {slow,fast} search speed
下面的部分演示了程序中的数据部分。仔细观察print()语句的打印输出。
对于选项值的进一步处理由程序来决定,用你自己的逻辑来替代 print()
函数。
为了解析命令行选项,你首先要创建一个 ArgumentParser
实例,并使用 add_argument()
方法声明你想要支持的选项。在每个 add_argument()
调用中,dest
参数指定解析结果被指派给属性的名字。metavar
参数被用来生成帮助信息。 参数指定跟属性对应的处理逻辑,通常的值为 store
,被用来存储某个值或将多个参数值收集到一个列表中。下面的参数收集所有剩余的命令行参数到一个列表中。在本例中它被用来构造一个文件名列表:
- parser.add_argument(dest='filenames',metavar='filename', nargs='*')
下面的参数根据参数是否存在来设置一个 Boolean
标志:
下面的参数接受一个单独值并将其存储为一个字符串:
- parser.add_argument('-o', dest='outfile', action='store',
- help='output file')
下面的参数说明允许某个参数重复出现多次,并将它们追加到一个列表中去。required
标志表示该参数至少要有一个。-p
和 —pat
表示两个参数名形式都可使用。
- parser.add_argument('--speed', dest='speed', action='store',
- help='search speed')
一旦参数选项被指定,你就可以执行 parser.parse()
方法了。它会处理 sys.argv
的值并返回一个结果实例。每个参数值会被设置成该实例中 方法的 dest
参数指定的属性值。
还很多种其他方法解析命令行选项。例如,你可能会手动的处理 sys.argv
或者使用 getopt
模块。但是,如果你采用本节的方式,将会减少很多冗余代码,底层细节 argparse
模块已经帮你处理了。你可能还会碰到使用 optparse
库解析选项的代码。尽管 optparse
和 argparse
很像,但是后者更先进,因此在新的程序中你应该使用它。
原文: