python中argparse模块用法实例详解


Posted in Python onJune 03, 2015

本文实例讲述了python中argparse模块用法。分享给大家供大家参考。具体分析如下:

平常在写命令行工具的时候,经常会带参数,所以用python中的argparse来实现。

# -*- coding: utf-8 -*- 
import argparse 
args = "-f hello.txt -n 1 2 3 -x 100 -y b -z a -q hello @args.txt i_am_bar -h".split()  
# 使用@args.txt要求fromfile_prefix_chars="@" 
# args.txt文件中应该一行一个参数,想改变行为参考convert_arg_line_to_args()
# ArgumentParser参数的简单说明 
## description - 命令行帮助的开始文字,大部分情况下,我们只会用到这个参数 
# epilog - 命令行帮助的结尾文字 
# prog - (default: sys.argv[0])程序的名字,一般不需要修改,另外,如果你需要在help中使用到程序的名字,可以使用%(prog)s 
# prefix_chars - 命令的前缀,默认是-,例如-f/--file。有些程序可能希望支持/f这样的选项,可以使用prefix_chars="/" 
# fromfile_prefix_chars - (default: None)如果你希望命令行参数可以从文件中读取,就可能用到。例如,如果fromfile_prefix_chars='@',命令行参数中有一个为"@args.txt",args.txt的内容会作为命令行参数 
# add_help - 是否增加-h/-help选项 (default: True),一般help信息都是必须的,所以不用设置啦。 
## parents - 类型是list,如果这个parser的一些选项跟其他某些parser的选项一样,可以用parents来实现继承,例如parents=[parent_parser] 
## formatter_class - 自定义帮助信息的格式(description和epilog)。默认情况下会将长的帮助信息进行<自动换行和消除多个连续空白>。 
#三个允许的值: 
# class argparse.RawDescriptionHelpFormatter 直接输出description和epilog的原始形式(不进行自动换行和消除空白的操作) 
# class argparse.RawTextHelpFormatter 直接输出description和epilog以及add_argument中的help字符串的原始形式(不进行自动换行和消除空白的操作) 
## class argparse.ArgumentDefaultsHelpFormatter 在每个选项的帮助信息后面输出他们对应的缺省值,如果有设置的话。这个最常用吧! 
# argument_default - (default: None)设置一个全局的选项的缺省值,一般每个选项单独设置,所以这个参数用得少,不细说 
# usage - (default: generated)如果你需要修改usage的信息(usage: PROG [-h] [--foo [FOO]] bar [bar ...]),那么可以修改这个,一般不要修改。 
# conflict_handler - 不建议使用。这个在极端情况下才会用到,主要是定义两个add_argument中添加的选项的名字发生冲突时怎么处理,默认处理是抛出异常。 
#注释一行有##表示这几个参数比较常用 
parser = argparse.ArgumentParser(description="This is a description of %(prog)s", epilog="This is a epilog of %(prog)s", prefix_chars="-+", fromfile_prefix_chars="@", formatter_class=argparse.ArgumentDefaultsHelpFormatter) 
# ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest]) 
# add_argument的参数是比较复杂的。。。 
# name or flags - 指定参数的形式,想写几个写几个,不过我们一般就写两个,一个短参数,一个长参数,看下面的例子"-f", "--file" 
# 可选的选项,位置不固定,想怎么写就怎么写,默认是可选的 
parser.add_argument("-f", "--file", help="test test test") 
# 位置固定的选项,例如"prog i_am_bar",这样子的话,i_am_bar就是bar选项的值啦,默认是必须有的 
parser.add_argument("bar", help="test test test") 
# nargs - 指定这个参数后面的value有多少个,例如,我们希望使用-n 1 2 3 4,来设置n的值为[1, 2, 3, 4] 
parser.add_argument("-n", "--num", nargs="+", type=int) 
# 这里nargs="+"表示,如果你指定了-n选项,那么-n后面至少要跟一个参数,+表示至少一个,?表示一个或0个,*0个或多个, 
# default - 如果命令行没有出现这个选项,那么使用default指定的默认值 
parser.add_argument("+g", "++gold", help="test test test", default="test_gold")#需要prefix_chars包含"+" 
# type - 如果希望传进来的参数是指定的类型(例如 float, int or file等可以从字符串转化过来的类型),可以使用 
parser.add_argument("-x", type=int) 
# choices - 设置参数值的范围,如果choices中的类型不是字符串,记得指定type哦 
parser.add_argument("-y", choices=['a', 'b', 'd']) 
# required - 通常-f这样的选项是可选的,但是如果required=True那么就是必须的了 
parser.add_argument("-z", choices=['a', 'b', 'd'], required=True) 
# metavar - 参数的名字,在显示 帮助信息时才用到. 
parser.add_argument("-o", metavar="OOOOOO") 
# help - 设置这个选项的帮助信息 
# dest - 设置这个选项的值就是解析出来后放到哪个属性中 
parser.add_argument("-q", dest="world")  
args = parser.parse_args(args) # 如果你没有args参数,那么就使用sys.argv,也就是命令行参数啦。有这个参数,就方便我们调试啊 
# args.world就是-q的值啦 
# action - The basic type of action to be taken when this argument is encountered at the command line. 
# const - A constant value required by some action and nargs selections.
# 这两个自己看帮助文档啦,比较复杂 
# http://docs.python.org/library/argparse.html 
print args

希望本文所述对大家的Python程序设计有所帮助。

Python 相关文章推荐
python基础教程之数字处理(math)模块详解
Mar 25 Python
python 数据清洗之数据合并、转换、过滤、排序
Feb 12 Python
Python深度优先算法生成迷宫
Jan 22 Python
Python 读取指定文件夹下的所有图像方法
Apr 27 Python
python中reader的next用法
Jul 24 Python
python将一个英文语句以单词为单位逆序排放的方法
Dec 20 Python
Django实现跨域请求过程详解
Jul 25 Python
Python-接口开发入门解析
Aug 01 Python
Python TKinter如何自动关闭主窗口
Feb 26 Python
Python统计学一数据的概括性度量详解
Mar 03 Python
PyQt5连接MySQL及QMYSQL driver not loaded错误解决
Apr 29 Python
pandas求平均数和中位数的方法实例
Aug 04 Python
Python中的推导式使用详解
Jun 03 #Python
对于Python装饰器使用的一些建议
Jun 03 #Python
Python模块搜索概念介绍及模块安装方法介绍
Jun 03 #Python
Python使用ftplib实现简易FTP客户端的方法
Jun 03 #Python
Python中的深拷贝和浅拷贝详解
Jun 03 #Python
python下paramiko模块实现ssh连接登录Linux服务器
Jun 03 #Python
python处理二进制数据的方法
Jun 03 #Python
You might like
短波的认识
2021/03/01 无线电
用PHP实现多服务器共享SESSION数据的方法
2007/03/16 PHP
php将字符串全部转换成大写或者小写的方法
2015/03/17 PHP
Laravel接收前端ajax传来的数据的实例代码
2017/07/20 PHP
PHP用函数嵌入网站访问量计数器
2017/10/27 PHP
PHP设计模式之适配器模式定义与用法详解
2018/04/03 PHP
PHP+MariaDB数据库操作基本技巧备忘总结
2018/05/21 PHP
Laravel 解决composer相关操作提示php相关异常的问题
2019/10/23 PHP
js数字输入框(包括最大值最小值限制和四舍五入)
2009/11/24 Javascript
jQuery的一些特性和用法整理小结
2010/01/13 Javascript
基于jQuery实现点击同时更改两个iframe的网址
2010/07/01 Javascript
jquery 查找iframe父级页面元素的实现代码
2011/08/28 Javascript
在新窗口打开超链接的方法小结
2013/04/14 Javascript
jQuery/CSS3图片特效插件整理推荐
2014/12/07 Javascript
Javascript点击按钮随机改变数字与其颜色
2016/09/01 Javascript
用jquery获取自定义的标签属性的值简单实例
2016/09/17 Javascript
vuejs响应用户事件(如点击事件)
2017/03/14 Javascript
socket.io学习教程之深入学习篇(三)
2017/04/29 Javascript
JS回调函数基本定义与用法实例分析
2017/05/24 Javascript
关于使用js算总价的问题
2017/06/23 Javascript
AngularJS实现单一页面内设置跳转路由的方法
2017/06/28 Javascript
JS中type=&quot;button&quot;和type=&quot;submit&quot;的区别
2017/07/04 Javascript
简单的三步vuex入门
2018/05/20 Javascript
微信公众平台 客服接口发消息的实现代码(Java接口开发)
2019/04/17 Javascript
Python使用Scrapy保存控制台信息到文本解析
2017/12/27 Python
numpy.transpose对三维数组的转置方法
2018/04/17 Python
python文字转语音的实例代码分析
2019/11/12 Python
django表单中的按钮获取数据的实例分析
2020/07/31 Python
Python + opencv对拍照得到的图片进行背景去除的实现方法
2020/11/18 Python
Bobbi Brown芭比波朗美国官网:化妆师专业彩妆保养品品牌
2016/08/18 全球购物
TheFork葡萄牙:欧洲领先的在线餐厅预订平台
2019/05/27 全球购物
文明村镇申报材料
2014/05/06 职场文书
计算机专业自荐信
2014/05/24 职场文书
请病假条范文
2015/08/17 职场文书
学习弘扬焦裕禄精神心得体会
2016/01/23 职场文书
《普罗米修斯》教学反思
2016/02/22 职场文书