Python中最好用的命令行参数解析工具(argparse)
Python做为一个脚本语言，可以很方便地写各种工具。当你在服务端要运行一个工具或服务时，输入参数似乎是一种硬需（当然你也可以通过配置文件来实现）。
如果要以命令行执行，那你需要解析一个命令行参数解析的模块来帮你做这个苦力活。
Python本身就提供了三个命令行参数解析模块，我这里罗列一下它们的大致情况供你了解。
- getopt，只能简单的处理命令行参数
- optparse，功能强大，易于使用，可以方便地生成标准的、符合Unix/Posix规范的命令行说明。
- argparse，使其更加容易的编写用户友好的命令行接口。它所需的程序进程了参数定义，argparse将更好的解析sys.argv。同时argparse模块还能自动生成帮助及用户输入错误参数时的提示信息。
很多初学者可能会使用getopt，上手简单功能也简单。比如说optget无法解析一个参数多个值的情况，如--filefile1file2file3，而optparse实际上我没有用过，但是考虑到它在Python2.7后就已经弃用不再维护，我们通常也不会使用它。
接下来只剩下argparse这一神器，它几乎能满足我对命令解析器的所有需求。它支持解析一参数多值，可以自动生成help命令和帮助文档，支持子解析器，支持限制参数取值范围等等功能。
0.HelloWorld
不管学习什么东西，首先第一步都应该是掌握它的大体框架。
而使用argparse前，框架很简单，你只需要记住这三行。
#mytest.py importargparse parser=argparse.ArgumentParser(description="usedfortest") args=parser.parse_args()
现在可以尝试一下
[root@localhost~]#pythonmytest.py-h usage:mytest.py[-h] usedfortest optionalarguments: -h,--helpshowthishelpmessageandexit [root@localhost~]# [root@localhost~]# [root@localhost~]#pythonmytest.py [root@localhost~]#
已经可以使用了。
1.入门配置
这里先讲一下，比较常用的参数配置。
- 调试：debug
- 版本号：version
importargparse
parser=argparse.ArgumentParser()
parser.add_argument('--version','-v',action='version',
version='%(prog)sversion:v0.01',help='showtheversion')
parser.add_argument('--debug','-d',action='store_true',
help='showtheversion',
default=False)
args=parser.parse_args()
print("===end===")
上面debug处的配置，需要讲一下的是action='store_true'和default=False的作用和区别
- store_true：一旦指定了-d或者--debug，其值就为True，store_false则相反
- default=False：未指定-d或者--debug，其值就默认为False
当我们执行pythonmytest.py-v，就会打印version里的内容。
[root@localhost~]#pythonmytest.py-v mytest.pyversion:v0.01 [root@localhost~]#
一旦执行时，指定了参数-v，执行到parser.parse_args()就会退出程序，不会打印最后的===end===
2.参数种类
参数可分为必选参数（positionalarguments）和可选参数（optionalarguments）。
在argsparse里如何实现呢？
必选参数
用单词做参数，默认就为必选参数
#mytest.py
importargparse
parser=argparse.ArgumentParser()
parser.add_argument("name")
args=parser.parse_args()
print(args.name)
不指定name参数运行一下：pythonmytest.py
[root@localhost~]#pythonmytest.py usage:mytest.py[-h]name mytest.py:error:toofewarguments [root@localhost~]#
如预期一样，报错了，说缺少参数。那我们指定一下：pythonmytest.pynamewangbm
[root@localhost~]#pythonmytest.pywangbm wangbm [root@localhost~]#
可选参数
有两种方式：
- 单下划线-来指定的短参数，如-h；
- 双下划线--来指定的长参数，如--help
#mytest.py
importargparse
parser=argparse.ArgumentParser()
parser.add_argument("-v","--verbosity",help="increaseoutputverbosity")
args=parser.parse_args()
ifargs.verbosity:
print("verbosityturnedon")
else:
print("verbosityturnedoff")
试着运行一下pythonmytest.py，不会报错。
[root@localhost~]#pythonmytest.py verbosityturnedoff [root@localhost~]#
3.参数类型
有的参数，是字符串，有的参数，是数值。
为了对命令行中的参数进行有效的约束，我们可以事先对参数的类型进行声明。argparse会对参数进行校验，不通过时，会直接抛出错误。
#mytest.py
importargparse
parser=argparse.ArgumentParser()
parser.add_argument("name")
parser.add_argument("age",type=int)
args=parser.parse_args()
print(args.name)
print(args.age)
测试一下唄。
[root@localhost~]#pythonmytest.pywangbmeighteen usage:mytest.py[-h]nameage mytest.py:error:argumentage:invalidintvalue:'eighteen' [root@localhost~]# [root@localhost~]#pythonmytest.pywangbm18 wangbm 18 [root@localhost~]#
你看，写eighteen就不行，提示类型不合法，只有写18才行。
4.互斥参数
有些参数，是互斥的，有你无我。比如，性别。
在argparse中如何实现？
importargparse
parser=argparse.ArgumentParser()
group=parser.add_mutually_exclusive_group()
group.add_argument("-m","--male",action="store_true")
group.add_argument("-f","--female",action="store_true")
args=parser.parse_args()
如果同时指定了这两个参数，就会报错。
[root@localhost~]#pythonmytest.py-f [root@localhost~]#pythonmytest.py-m [root@localhost~]#pythonmytest.py-m-f usage:mytest.py[-h][-m|-f] mytest.py:error:argument-f/--female:notallowedwithargument-m/--male [root@localhost~]#
5.可选值
如果是性别，可以像上面那样放在两个参数里然后用互斥组来约束，也可以放在一个参数里，在argparse里限制再在外层做判断。
#mytest.py
importargparse
parser=argparse.ArgumentParser()
parser.add_argument("-g","--gender",default='male',
choices=['male','female'])
args=parser.parse_args()
print(args.gender)
试着执行一下，发现性别只能是男或女，不能为人妖。
[root@localhost~]#pythonmytest.py--gendermale
male
[root@localhost~]#pythonmytest.py--genderfemale
female
[root@localhost~]#
[root@localhost~]#
[root@localhost~]#pythonmytest.py--genderother
usage:mytest.py[-h][-g{male,female}]
mytest.py:error:argument-g/--gender:invalidchoice:'other'(choosefrom'male','female')
[root@localhost~]#
6.指定文件
经常会有那种要在脚本中指定配置文件或者其他文件的需求。可以使用下面的配置
importargparse
parser=argparse.ArgumentParser()
parser.add_argument('--file','-f',action='append',
dest='files',
help=('additionalyamlconfigurationfilestouse'),
type=argparse.FileType('rb'))
args=parser.parse_args()
dest=files，是说将命令行中，--file的参数值赋值给变量files，你可以用args.files访问。
action=append，由于我们会有指定多个文件的需求，那就指定多次--file，argparse会将其放在一个list里。
type=argparse.FileType('rb')，既然是指定文件，那么参数应该为路径，并指定打开模式为rb，如果如果要取得文件内容，可以用args.files[0].read()
7.子解析器
如果你对命令行，有过足够多的接触，就会知道有些情况下会有子解析器。
这里我以自己工作中，碰到的例子来举个例子。
cloud-init--debugsingle-namemymodule
其中single后面是一个子解析器。
#cloud-init.py
defmain_single(name,args):
print("name:",name)
print("args:",args)
print("Iammain_single")
#添加一个子解析器
subparsers=parser.add_subparsers()
parser_single=subparsers.add_parser('single',help='runasinglemodule')
#对single子解析器添加action函数。
parser_single.set_defaults(action=('single',main_single))
#require=True，是说如果命令行指定了single解析器，就必须带上--name的参数。
parser_single.add_argument("--name",'-n',action="store",
help="modulenametorun",
required=True)
args=parser.parse_args()
(name,functor)=args.action
ifnamein["single"]:
functor(name,args)
执行命令cloud-initsingle-namemymodule，输出如下
name: single
args: Namespace(action=('single',),debug=False,file=None,name='mymodule')
Iammain_single
以上就是关于argparse工具的使用方法，你学会了吗？希望对大家的学习有所帮助，也希望大家多多支持毛票票。