[Python]命令行解析器Argparse的试用手册
Unix系统的一个核心思想是:建立一组小工具,然后通过管道的方式将其组合成大工具。这一思想指导Unix/Linux等成为最为实用的服务器操作系统。而在编写Unix/Linux的C/C++程序时,命令行解析器是必不可少的。只有通过命令行参数进行消息传递,才能充分利用管道、Bash脚本来进行自动化。C++中我最常用的一个命令行解析器是TCLAP。而在Python中,有一个更强大的命令行解析器 ArgParse。
Argparse的使用很简单,主要有三个步骤:
- 创建解析器对象: parser = argparse.ArgumentParser( prog='PROG' )
- 添加参数: parser.add_argument(....)
- 进行解析: values = parser.parse_args()
Argparse默认是从 sys.argv 中进行解析,但也可以直接解析字符串,如
values = parser.parse_args('--foo 1 -x 2 -y 3'.split()),这在调试中很有用。
Argparse的优点主要有:
- 位置参数:可以不用前置引导符来进行参数设置;
- 可选参数:可指定哪些参数一定要提供,哪些是可选的;
- 合成帮助:只需要在添加参数时给每个参数提供帮助说明,程序会自动给出Unix统一命令行帮助,其输出命令为 parser.print_help();
- 可指定参数格式:通过Argparse给定的标识符 nargs,可指定某个引导符后参数的格式,其中N代表N个,?代表0或1个,*代表0或多个,+代表1或多个;
- 子命令行;支持多个子命令行解析器(我认为这个功能不是很实用,毕竟Unix工具的目标是小巧实用);
- 参数类型可定义:这样可以进行参数类型转换与检查,并且可以定义参数调用方式;
- 自定义调用函数:这是一个高级技巧,其可以按照特定的格式编写一个回调对象类,这样在进行解析某个参数时,可自动回调这个对象的某个操作。
- 限定范围:通过choices命令可以限定某个参数的取值范围;
- 可继承多个解析器:这个功能很有用,其可以通过多个解析器来生成一个整合的解析器,其可以解析所有的参数;
- 参数隐藏:利用 argparse.SUPPRESS 常量符,可设定某个参数是帮助隐藏还是整体隐藏,这样可以屏蔽一些高级参数设定;
Google Code 上的ArgParse 有很好的帮助文档,并附加一些参考样例,很值得研究学习。