Python 利用argparse模块实现脚本命令行参数解析

study.py内容如下

1. #!/usr/bin/env python
2. # -*- coding:utf-8 -*-
3.  
4. __author__ = 'shouke'
5.  
6. import argparse
7.  
8. def argparseFunc():
9. '''
10. 基于argparse模块实现命令参数解析功能
11. 执行示例：
12. python study.py -i 172.19.7.236 -p 8080 -a -r
13. python study.py --ip 172.19.7.236 --port 7077 --auth -w -v True
14. '''
15.  
16. parser = argparse.ArgumentParser(description="study.py usage help document")
17. # 添加不带默认值的可解析参数
18. parser.add_argument("-i", "--ip", help="ip addr") #注意： -h、--help为内置参数，不可用
19. parser.add_argument("-p", "--port",help="host port")
20.  
21. # 添加带默认值的可解析参数(# action = store_true 表示是如果使用了这个参数，则值参数值设置为True # 更多action配置可参考源码
22. # 需要注意的是，不能为带默认值参数指定参数值，会报错，该参数值会被当作不识别的参数
23. parser.add_argument("-a", "--auth", help="if auth need", action="store_true")
24.  
25. # 添加互斥参数（比如 例中的-r和-w 同时只能用一个）
26. exclusive_group = parser.add_mutually_exclusive_group()
27. exclusive_group.add_argument("-r","--read", help="read enabled" , action="store_true")
28. exclusive_group.add_argument("-w","--write", help="write enabled", action="store_true")
29.  
30. # 添加参数时不设置设置参数说明
31. parser.add_argument('-v') # show verbose
32.  
33. # 添加参数时不设置参数全名
34. parser.add_argument('-V', help="version")
35.  
36. ARGS = parser.parse_args() # 获取命令行参数
37. print('ARGS:', ARGS)
38.  
39. # 获取某个参数值
40. if ARGS.ip: # 注意，这里的参数名，必须使用参数全称
41. print("host addr is: %s" % ARGS.ip)
42.  
43. if ARGS.port:
44. print("host port is: : %s" % ARGS.port)
45.  
46. if ARGS.auth:
47. print("auth need: : %s" % ARGS.auth)
48.  
49. if ARGS.read:
50. print("read enabled: %s" % ARGS.read)
51.  
52. if ARGS.write:
53. print("write enabled: %s" % ARGS.write)
54.  
55. argparseFunc()

运行测试

1. python study.py -i 172.19.7.236 -p 8080 -a -r
2. python study.py --ip 172.19.7.236 --port 7077 --auth -w -v True

结果如下

1. python study.py -i127.0.0.1 # 注意，参数和参数值之间可以没有空格

结果如下

1. python study.py -notExists 1

结果如下

如上，以上代码实现是针对单个模块脚本，如果要在多个模块中使用咋办？解决方法为封装为类，具体参见“代码实践2”

#代码实践2

1. argument_parser.py
2.  
3. #!/usr/bin/env python
4. # -*- coding:utf-8 -*-
5.  
6. '''
7. @Author : shouke
8. '''
9.  
10. import argparse
11.  
12. class ArgParser(object):
13. '''
14. 参数解析器
15. '''
16.  
17. def __init__(self, none_exclusive_arguments, exclusive_arguments, description=''):
18. self.parser = argparse.ArgumentParser(description=description)
19.  
20. self.add_none_exclusive_arguments(none_exclusive_arguments)
21. self.add_exclusive_arguments(exclusive_arguments)
22.  
23. def add_none_exclusive_arguments(self, options:list):
24. '''
25. 添加常规选项（非互斥选项）
26. :param options 格式为list类型，形如
27. [
28. '"-a", "--all", help="do not ignore entries starting with ."',
29. '"-b", "--block", help="scale sizes by SIZE before printing them"',
30. '"-C", "--color", help="colorize the output; WHEN can be 'never', 'auto'"',
31. '"-flag", help="make flag", action="store_true"', # action="store_true" 表示如果不设置该选项的值，则默认值为true，类似的action="store_false" 表示默认值为false
32. ]
33. 其中，每个list元素为argparse.ArgumentParserlei add_argument类函数实参的字符串表示，add_argument函数定义add_argument(self, *args,**kwargs)
34. '''
35.  
36. for option in options:
37. eval('self.parser.add_argument(%s)' % option)
38.  
39. def add_exclusive_arguments(self, options:list):
40. '''
41. 添加互斥选项
42. :param options 格式为list，形如以下
43. [
44. ('"-r","--read",help="Read Action",action="store_true"',
45. '"-w","--write",help="Write Action",action="store_true"')
46. ]
47.  
48. '''
49. for option_tuple in options:
50. exptypegroup = self.parser.add_mutually_exclusive_group()
51. for item in option_tuple:
52. eval('exptypegroup.add_argument(%s)' % item)
53.  
54. @property
55. def args(self):
56. return self.parser.parse_args()

在xxx.py中引用(注意：为了让参数解析器起到应起的作用，建议在脚本最上方构造参数解析器对象)

study.py内容如下

1. #!/usr/bin/env python
2. # -*- coding:utf-8 -*-
3.  
4. __author__ = 'shouke'
5.  
6. from argument_parser import ArgParser
7.  
8. none_exclusive_arguments = [
9. '"-ip", help="自动化测试服务平台地址"',
10. '"-projectId", help="自动化测试项目id"',
11. '"-runEnv", help="自动化测试项目运行环境"',
12. '"-logLevel", help="日志级别"',
13. '"-masterHost", help="master服务地址"',
14. '"-masterPort", help="master服务端口"'
15. ]
16.  
17. exclusive_arguments = [
18.  
19. ('"-r", "--read", help="Read Action",action="store_true"',
20. '"-w", "--write", help="Write Action",action="store_true"')
21. ]
22.  
23. args = ArgParser(none_exclusive_arguments, exclusive_arguments).args
24.  
25. print(args)
26. print(args.ip)
27. print(args.read)

运行测试

1. python study.py -i 127.0.0.1 -r

运行结果如下

到此这篇关于Python 利用argparse模块实现脚本命令行参数解析的文章就介绍到这了,更多相关Python 实现脚本命令行参数解析内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！

原文链接：https://www.cnblogs.com/shouke/archive/2020/12/27/14198784.html