Python解析命令行读取参数之argparse模块


Posted in Python onJuly 26, 2019

在多个文件或者不同语言协同的项目中,python脚本经常需要从命令行直接读取参数。万能的python就自带了argprase包 使得这一工作变得简单而规范。PS:optparse包是类似的功能,只不过写起来更麻烦一些。

如果脚本很简单或临时使用,没有多个复杂的参数选项,可以直接利用sys.argv将脚本后的参数依次读取(读进来的默认是字符串格式)。比如如下名为test.py的脚本:

import sys
print "Input argument is %s" %(sys.argv)

在shell脚本中运行python test.py help可以得到Input argument is help的结果。

1) 一般形式

但是大多数情况下,脚本很可能需要多个参数,而且每次参数的类型用处各不相同,那么这个时候在参数前添加标签表明参数的类型和用途便十分有用,而利用argparse模块可以很方便得实现这一目的。

同样用名为test.py的脚本举个栗子:

import argparse

parser = argparse.ArgumentParser(description="your script description")   # description参数可以用于插入描述脚本用途的信息,可以为空
parser.add_argument('--verbose', '-v', action='store_true', help='verbose mode') # 添加--verbose标签,标签别名可以为-v,这里action的意思是当读取的参数中出现--verbose/-v的时候
                     # 参数字典的verbose建对应的值为True,而help参数用于描述--verbose参数的用途或意义。
args = parser.parse_args()               # 将变量以标签-值的字典形式存入args字典
if args.verbose:
 print "Verbose mode on!"
else:
 print "Verbose mode off!"

运行python test.py后面跟了--verbose/-v的时候会输出前者,如果什么都没有会输出后者。如果输入了--verbose/-v以外的参数则会报错:unrecognized arguments

稍微提一下,action参数表示值赋予键的方式,这里用到的是bool类型;如果是'count'表示将--verbose标签出现的次数作为verbose的值;'append'表示将每次出现的该便签后的值都存入同一个数组再赋值。(嘛,一般后面两种用的比较少就不多说了)

PS:--help标签在使用argparse模块时会自动创建,因此一般情况不需要我们主动定义帮助信息。

$ python test.py --help
usage: test.py [-h] [--verbose]

your script description

optional arguments:
 -h, --help  show this help message and exit
 --verbose, -v  verbose mode

2) 必需参数

这种模式用于确保某些必需的参数有输入。

parser.add_argument('--verbose', required=True, type=int)

required标签就是说--verbose参数是必需的,并且类型为int,输入别的类型会报错。

3)位置参数(positional arguments)

位置参数与sys.argv调用比较像,参数没有显式的--xxx或者-xxx标签,因此调用属性也与sys.argv相同。

parser.add_argument('filename') # 输入的第一个参数赋予名为filename的键
args = parser.parse_args()
print "Read in %s" %(args.filename)

输入python test.py test.txt则会输出Read in test.txt

此外,可以用nargs参数来限定输入的位置参数的个数,默认为1。当然nargs参数也可用于普通带标签的参数。
parser.add_argument('num', nargs=2, type=int)表示脚本可以读入两个整数赋予num键(此时的值为2个整数的数组)。nargs还可以'*'用来表示如果有该位置参数输入的话,之后所有的输入都将作为该位置参数的值;‘+'表示读取至少1个该位置参数。'?'表示该位置参数要么没有,要么就只要一个。(PS:跟正则表达式的符号用途一致。)比如用:

parser.add_argument('filename')
parser.add_argument('num', nargs='*)

就可以运行python test.py text.txt 1 2

由于没有标签,所以用位置参数的时候需要比较小心。

4)输入类型

之前已经提到了用type参数就可以指定输入的参数类型。而这个type类型还可以表示文件操作的类型从而直接进行文件的读写操作。

parser.add_argument('file', type=argparser.FileType('r')) # 读取文件
args = parser.parse_args()
for line in args.file:
 print line.strip()

5)参数默认值

一般情况下会设置一些默认参数从而不需要每次输入某些不需要变动的参数,利用default参数即可实现。

parser.add_argument('filename', default='text.txt')

这个时候至直接运行python text.py就能得到Read in text.txt而不需要输入文件名了。

6)候选参数选择

表示该参数能接受的值只能来自某几个值候选值中,除此以外会报错,用choices参数即可。比如:

parser.add_argument('filename', choices=['test1.txt', 'text2.txt'])

参考:https://mkaz.tech/python-argparse-cookbook.html
https://docs.python.org/2/howto/argparse.html

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
python基础入门详解(文件输入/输出 内建类型 字典操作使用方法)
Dec 08 Python
查看Python安装路径以及安装包路径小技巧
Apr 28 Python
Android模拟器无法启动,报错:Cannot set up guest memory ‘android_arm’ Invalid argument的解决方法
Jul 01 Python
selenium处理元素定位点击无效问题
Jun 12 Python
python中设置超时跳过,超时退出的方式
Dec 13 Python
Python测试Kafka集群(pykafka)实例
Dec 23 Python
Pytorch中.new()的作用详解
Feb 18 Python
spyder 在控制台(console)执行python文件,debug python程序方式
Apr 20 Python
导致python中import错误的原因是什么
Jul 01 Python
python 如何快速复制序列
Sep 07 Python
python如何控制进程或者线程的个数
Oct 16 Python
利用Selenium添加cookie实现自动登录的示例代码(fofa)
May 08 Python
Django Rest framework三种分页方式详解
Jul 26 #Python
浅析Windows 嵌入python解释器的过程
Jul 26 #Python
python flask几分钟实现web服务的例子
Jul 26 #Python
解决python flask中config配置管理的问题
Jul 26 #Python
Django REST framework内置路由用法
Jul 26 #Python
python flask web服务实现更换默认端口和IP的方法
Jul 26 #Python
Django 开发环境与生产环境的区分详解
Jul 26 #Python
You might like
解析php根据ip查询所在地区(非常有用,赶集网就用到)
2013/07/01 PHP
php 二维数组快速排序算法的实现代码
2017/10/17 PHP
CCPry JS类库 代码
2009/10/30 Javascript
javascript 表格内容排序 简单操作示例代码
2014/01/03 Javascript
JavaScript中Function详解
2015/02/27 Javascript
jquery实现兼容IE8的异步上传文件
2015/06/15 Javascript
javascript的BOM汇总
2015/07/16 Javascript
javascript点击按钮实现隐藏显示切换效果
2016/02/03 Javascript
JavaScript编写点击查看大图的页面半透明遮罩层效果实例
2016/05/09 Javascript
JavaScript判断用户名和密码不能为空的实现代码
2016/05/16 Javascript
jQuery基本选择器之标签名选择器
2016/09/03 Javascript
用JavaScript和jQuery实现瀑布流
2017/03/19 Javascript
如何通过非数字与字符的方式实现PHP WebShell详解
2017/07/02 Javascript
浅谈jQuery框架Ajax常用选项
2017/07/08 jQuery
基于JavaScript实现每日签到打卡轨迹功能
2018/11/29 Javascript
微信小程序调用wx.getImageInfo遇到的坑解决
2020/05/31 Javascript
基于jquery实现彩色投票进度条代码解析
2020/08/26 jQuery
在win和Linux系统中python命令行运行的不同
2016/07/03 Python
Python常用时间操作总结【取得当前时间、时间函数、应用等】
2017/05/11 Python
解决Linux系统中python matplotlib画图的中文显示问题
2017/06/15 Python
python中利用h5py模块读取h5文件中的主键方法
2018/06/05 Python
python实现数字炸弹游戏程序
2020/07/17 Python
python+requests实现接口测试的完整步骤
2020/10/27 Python
Python抓包并解析json爬虫的完整实例代码
2020/11/03 Python
基于django和dropzone.js实现上传文件
2020/11/24 Python
美国男装连锁零售商:Men’s Wearhouse
2016/10/14 全球购物
美国最大的网上冲印店:Shutterfly
2017/01/01 全球购物
电气工程及其自动化自我评价四篇
2013/09/24 职场文书
房地产融资计划书
2014/01/10 职场文书
高三地理教学反思
2014/01/11 职场文书
2014年师德承诺书
2014/05/23 职场文书
2015年秋季小班开学寄语
2015/05/27 职场文书
2019新员工试用期转正工作总结范文
2019/08/21 职场文书
浅谈pytorch中的dropout的概率p
2021/05/27 Python
Python3.10的一些新特性原理分析
2021/09/15 Python
关于ObjectUtils.isEmpty() 和 null 的区别
2022/02/28 Java/Android