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


Posted in Python onDecember 28, 2020

study.py内容如下

#!/usr/bin/env python
# -*- coding:utf-8 -*-
 
__author__ = 'shouke'
 
import argparse
 
def argparseFunc():
 '''
 基于argparse模块实现命令参数解析功能
 执行示例:
  python study.py -i 172.19.7.236 -p 8080 -a -r
  python study.py --ip 172.19.7.236 --port 7077 --auth -w -v True
 '''
 
 parser = argparse.ArgumentParser(description="study.py usage help document")
 # 添加不带默认值的可解析参数
 parser.add_argument("-i", "--ip", help="ip addr") #注意: -h、--help为内置参数,不可用
 parser.add_argument("-p", "--port",help="host port")
 
 # 添加带默认值的可解析参数(# action = store_true 表示是如果使用了这个参数,则值参数值设置为True # 更多action配置可参考源码
 # 需要注意的是,不能为带默认值参数指定参数值,会报错,该参数值会被当作不识别的参数
 parser.add_argument("-a", "--auth", help="if auth need", action="store_true")
 
 
 # 添加互斥参数(比如 例中的-r和-w 同时只能用一个)
 exclusive_group = parser.add_mutually_exclusive_group()
 exclusive_group.add_argument("-r","--read", help="read enabled" , action="store_true")
 exclusive_group.add_argument("-w","--write", help="write enabled", action="store_true")
 
 # 添加参数时不设置设置参数说明
 parser.add_argument('-v') # show verbose
 
 # 添加参数时不设置参数全名
 parser.add_argument('-V', help="version")
 
 ARGS = parser.parse_args() # 获取命令行参数
 print('ARGS:', ARGS)
 
 # 获取某个参数值
 if ARGS.ip: # 注意,这里的参数名,必须使用参数全称
 print("host addr is: %s" % ARGS.ip)
 
 if ARGS.port:
 print("host port is: : %s" % ARGS.port)
 
 if ARGS.auth:
 print("auth need: : %s" % ARGS.auth)
 
 if ARGS.read:
 print("read enabled: %s" % ARGS.read)
 
 if ARGS.write:
 print("write enabled: %s" % ARGS.write)
 
argparseFunc()

运行测试

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

结果如下

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

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

结果如下

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

python study.py -notExists 1

结果如下

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

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

#代码实践2

argument_parser.py
 
#!/usr/bin/env python
# -*- coding:utf-8 -*-
 
 
'''
@Author : shouke
'''
 
 
import argparse
 
class ArgParser(object):
 '''
  参数解析器
 '''
 
 
 def __init__(self, none_exclusive_arguments, exclusive_arguments, description=''):
  self.parser = argparse.ArgumentParser(description=description)
 
  self.add_none_exclusive_arguments(none_exclusive_arguments)
  self.add_exclusive_arguments(exclusive_arguments)
 
 def add_none_exclusive_arguments(self, options:list):
  '''
  添加常规选项(非互斥选项)
  :param options 格式为list类型,形如
  [
   '"-a", "--all", help="do not ignore entries starting with ."',
   '"-b", "--block", help="scale sizes by SIZE before printing them"',
   '"-C", "--color", help="colorize the output; WHEN can be 'never', 'auto'"',
   '"-flag", help="make flag", action="store_true"', # action="store_true" 表示如果不设置该选项的值,则默认值为true,类似的action="store_false" 表示默认值为false
  ]
  其中,每个list元素为argparse.ArgumentParserlei add_argument类函数实参的字符串表示,add_argument函数定义add_argument(self, *args,**kwargs)
  '''
 
  for option in options:
   eval('self.parser.add_argument(%s)' % option)
 
 
 def add_exclusive_arguments(self, options:list):
  '''
  添加互斥选项
  :param options 格式为list,形如以下
  [
   ('"-r","--read",help="Read Action",action="store_true"',
   '"-w","--write",help="Write Action",action="store_true"')
  ]
 
  '''
  for option_tuple in options:
   exptypegroup = self.parser.add_mutually_exclusive_group()
   for item in option_tuple:
    eval('exptypegroup.add_argument(%s)' % item)
 
 
 @property
 def args(self):
  return self.parser.parse_args()

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

study.py内容如下

#!/usr/bin/env python
# -*- coding:utf-8 -*-
 
__author__ = 'shouke'
 
from argument_parser import ArgParser
 
none_exclusive_arguments = [
 '"-ip", help="自动化测试服务平台地址"',
 '"-projectId", help="自动化测试项目id"',
 '"-runEnv", help="自动化测试项目运行环境"',
 '"-logLevel", help="日志级别"',
 '"-masterHost", help="master服务地址"',
 '"-masterPort", help="master服务端口"'
]
 
exclusive_arguments = [
 
 ('"-r", "--read", help="Read Action",action="store_true"',
 '"-w", "--write", help="Write Action",action="store_true"')
]
 
 
args = ArgParser(none_exclusive_arguments, exclusive_arguments).args
 
print(args)
print(args.ip)
print(args.read)

运行测试

python study.py -i 127.0.0.1 -r

运行结果如下

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

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

Python 相关文章推荐
在Mac OS系统上安装Python的Pillow库的教程
Nov 20 Python
python实现本地图片转存并重命名的示例代码
Oct 27 Python
PyCharm代码提示忽略大小写设置方法
Oct 28 Python
Python检查和同步本地时间(北京时间)的实现方法
Dec 03 Python
Python控制Firefox方法总结
Jun 03 Python
在linux下实现 python 监控usb设备信号
Jul 03 Python
Python中的正则表达式与JSON数据交换格式
Jul 03 Python
Python 中的 global 标识对变量作用域的影响
Aug 12 Python
python3.8 微信发送服务器监控报警消息代码实现
Nov 05 Python
pytorch实现focal loss的两种方式小结
Jan 02 Python
最小二乘法及其python实现详解
Feb 24 Python
python集合能干吗
Jul 19 Python
python中str内置函数用法总结
Dec 27 #Python
python中温度单位转换的实例方法
Dec 27 #Python
Python新建项目自动添加介绍和utf-8编码的方法
Dec 26 #Python
Python 可视化神器Plotly详解
Dec 26 #Python
分享PyCharm最新激活码(真永久激活方法)不用每月找安装参数或最新激活码了
Dec 27 #Python
通过python-pptx模块操作ppt文件的方法
Dec 26 #Python
Python如何实现感知器的逻辑电路
Dec 25 #Python
You might like
PHP伪静态写法附代码
2008/06/20 PHP
php解析url并得到url中的参数及获取url参数的四种方式
2015/10/26 PHP
php正则表达式验证(邮件地址、Url地址、电话号码、邮政编码)
2016/03/14 PHP
PHP简单获取多个checkbox值的方法
2016/06/13 PHP
用javascript将数据库中的TEXT类型数据动态赋值到TEXTAREA中
2007/04/20 Javascript
jquery tablesorter.js 支持中文表格排序改进
2009/12/09 Javascript
vs2003 js文件编码问题的解决方法
2010/03/20 Javascript
通过jQuery源码学习javascript(一)
2012/12/27 Javascript
js处理自己不能定义二维数组的方法详解
2014/03/03 Javascript
浅谈JavaScript中setInterval和setTimeout的使用问题
2015/08/01 Javascript
javascript实现无缝上下滚动特效
2015/12/16 Javascript
JS代码实现百度地图 画圆 删除标注
2016/10/12 Javascript
微信小程序 触控事件详细介绍
2016/10/17 Javascript
Json对象和字符串互相转换json数据拼接和JSON使用方式详细介绍(小结)
2016/10/25 Javascript
bootstrap如何让dropdown menu按钮式下拉框长度一致
2017/04/10 Javascript
VUE使用vuex解决模块间传值问题的方法
2017/06/01 Javascript
JS实现移动端判断上拉和下滑功能
2017/08/07 Javascript
微信小程序实现图片预览功能
2018/01/31 Javascript
使用JS来动态操作css的几种方法
2019/12/18 Javascript
Vue-router 报错NavigationDuplicated的解决方法
2020/03/31 Javascript
Python中文字符串截取问题
2015/06/15 Python
Python 矩阵转置的几种方法小结
2019/12/02 Python
python实现单目标、多目标、多尺度、自定义特征的KCF跟踪算法(实例代码)
2020/01/08 Python
Python requests HTTP验证登录实现流程
2020/11/05 Python
ghd澳大利亚官方网站:英国最受欢迎的美发工具品牌
2018/05/21 全球购物
The Beach People美国:澳洲海滨奢华品牌
2018/07/05 全球购物
美国Max仓库:Max Warehouse
2020/05/31 全球购物
Net Remoting把服务器端激活两种模式
2014/01/22 面试题
.NET里面如何取得当前的屏幕分辨率
2012/12/06 面试题
为什么要做架构设计
2015/07/08 面试题
日语翻译个人求职的自我评价
2013/10/14 职场文书
学子宴答谢词
2014/01/25 职场文书
爱护公物演讲稿
2014/09/09 职场文书
开业庆典活动策划方案
2014/09/21 职场文书
新郎新娘答谢词
2015/01/04 职场文书
Mysql实现主从配置和多主多从配置
2021/06/02 MySQL