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 相关文章推荐
python两种遍历字典(dict)的方法比较
May 29 Python
Python中的异常处理学习笔记
Jan 28 Python
编写Python脚本使得web页面上的代码高亮显示
Apr 24 Python
详解Python中break语句的用法
May 14 Python
python魔法方法-自定义序列详解
Jul 21 Python
python3.6+opencv3.4实现鼠标交互查看图片像素
Feb 26 Python
Python中文件的读取和写入操作
Apr 27 Python
Python数据可视化教程之Matplotlib实现各种图表实例
Jan 13 Python
python3实现的zip格式压缩文件夹操作示例
Aug 17 Python
python操作openpyxl导出Excel 设置单元格格式及合并处理代码实例
Aug 27 Python
在tensorflow中实现屏蔽输出的log信息
Feb 04 Python
pycharm 复制代码出现空格的解决方式
Jan 15 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
同台服务器使用缓存APC效率高于Memcached的演示代码
2010/02/16 PHP
php中magic_quotes_gpc对unserialize的影响分析
2014/12/16 PHP
php5.4以上版本GBK编码下htmlspecialchars输出为空问题解决方法汇总
2015/04/03 PHP
js split 的用法和定义 js split分割字符串成数组的实例代码
2012/05/13 Javascript
基于javascript实现判断移动终端浏览器版本信息
2014/12/09 Javascript
JS实现超简洁网页title标题跑动闪烁提示效果代码
2015/10/23 Javascript
实例讲解jquery中mouseleave和mouseout的区别
2016/02/17 Javascript
JavaScript中的Number数字类型学习笔记
2016/05/26 Javascript
jQuery实现鼠标经过像翻页和描点链接效果
2016/08/08 Javascript
简单几步实现返回顶部效果
2016/12/05 Javascript
在js中做数字字符串补0(js补零)
2017/03/25 Javascript
uploader秒传图片到服务器完整代码
2017/04/22 Javascript
Node.js v8.0.0正式发布!看看带来了哪些主要新特性
2017/06/02 Javascript
JS原型继承四步曲及原型继承图一览
2017/11/28 Javascript
使用jQuery给Table动态增加行、清空table的方法
2018/09/05 jQuery
NodeJS http模块用法示例【创建web服务器/客户端】
2019/11/05 NodeJs
Vue.js watch监视属性知识点总结
2019/11/11 Javascript
[01:36:57]【09DOTA2第一视角】小骷髅
2014/04/16 DOTA
[01:01:52]DOTA2-DPC中国联赛正赛 iG vs LBZS BO3 第一场 3月4日
2021/03/11 DOTA
在Python的Flask框架中实现全文搜索功能
2015/04/20 Python
Python语言实现百度语音识别API的使用实例
2017/12/13 Python
python将字典内容存入mysql实例代码
2018/01/18 Python
python通过伪装头部数据抵抗反爬虫的实例
2018/05/07 Python
Python之列表实现栈的工作功能
2019/01/28 Python
Python MySQLdb 执行sql语句时的参数传递方式
2020/03/04 Python
在python里使用await关键字来等另外一个协程的实例
2020/05/04 Python
思想汇报范文
2013/11/04 职场文书
同居协议书范本
2014/04/23 职场文书
计算机专业毕业生自荐书
2014/06/02 职场文书
庆七一宣传标语
2014/10/08 职场文书
2014年公司工作总结
2014/11/22 职场文书
小学教师党员承诺书
2015/04/27 职场文书
2015上半年个人工作总结
2015/07/27 职场文书
大学新生入学感想
2015/08/07 职场文书
MySQL CHAR和VARCHAR该如何选择
2021/05/31 MySQL
java中如何截取字符串最后一位
2022/07/07 Java/Android