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 相关文章推荐
打开电脑上的QQ的python代码
Feb 10 Python
利用Python实现命令行版的火车票查看器
Aug 05 Python
分享Python开发中要注意的十个小贴士
Aug 30 Python
python使用opencv进行人脸识别
Apr 07 Python
基于Django统计博客文章阅读量
Oct 29 Python
Django继承自带user表并重写的例子
Nov 18 Python
pygame编写音乐播放器的实现代码示例
Nov 19 Python
python GUI库图形界面开发之PyQt5访问系统剪切板QClipboard类详细使用方法与实例
Feb 27 Python
使用python的turtle函数绘制一个滑稽表情
Feb 28 Python
Python通过Pillow实现图片对比
Apr 29 Python
基于python实现银行管理系统
Apr 20 Python
python使用torch随机初始化参数
Mar 22 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
探讨PHP调用时间格式的参数详解
2013/06/06 PHP
php启用sphinx全文搜索的实现方法
2014/12/24 PHP
PHP设计模式之观察者模式实例
2016/02/22 PHP
PHP实现二维数组(或多维数组)转换成一维数组的常见方法总结
2019/12/04 PHP
jquery创建一个ajax关键词数据搜索实现思路
2013/02/26 Javascript
jquery用get实现ajax在ie里面刷新不进入后台解决方法
2013/08/12 Javascript
jquery 无限级下拉菜单的简单实现代码
2014/02/21 Javascript
window.open 以post方式传递参数示例代码
2014/02/27 Javascript
Node.js 去掉种子(torrent)文件里的邪恶信息
2015/03/27 Javascript
Jquery结合HTML5实现文件上传
2015/06/25 Javascript
jQuery检查事件是否触发的方法
2015/06/26 Javascript
js实现正则匹配中文标点符号的方法
2015/12/23 Javascript
js原生实现FastClick事件的实例
2016/11/20 Javascript
完美实现js选项卡切换效果(二)
2017/03/08 Javascript
Nodejs之TCP服务端与客户端聊天程序详解
2017/07/07 NodeJs
node koa2实现上传图片并且同步上传到七牛云存储
2017/07/31 Javascript
AngularJS下$http服务Post方法传递json参数的实例
2018/03/29 Javascript
vue router 源码概览案例分析
2018/10/09 Javascript
ajax跨域访问遇到的问题及解决方案
2019/05/23 Javascript
js实现左右轮播图
2020/01/09 Javascript
vue2.0 解决抽取公用js的问题
2020/07/31 Javascript
Python中工作日类库Busines Holiday的介绍与使用
2017/07/06 Python
scrapy爬虫完整实例
2018/01/25 Python
在Python运行时动态查看进程内部信息的方法
2019/02/22 Python
python实现转圈打印矩阵
2019/03/02 Python
Django 外键的使用方法详解
2019/07/19 Python
python 实现批量替换文本中的某部分内容
2019/12/13 Python
python 字符串的驻留机制及优缺点
2020/06/19 Python
Python 创建TCP服务器的方法
2020/07/28 Python
英国电子产品购物网站:Tech in the basket
2019/11/08 全球购物
亿阳信通股份有限公司笔试题(C#)
2016/03/04 面试题
Unix如何在一行中运行多个命令
2015/05/29 面试题
影视制作岗位职责
2013/12/04 职场文书
创业计划书的主要内容有哪些
2014/01/29 职场文书
人力资源总监工作说明
2014/03/03 职场文书
人民币使用说明书
2019/04/17 职场文书