Python中optparse模块使用浅析


Posted in Python onJanuary 01, 2015

最近遇到一个问题,是指定参数来运行某个特定的进程,这很类似Linux中一些命令的参数了,比如ls -a,为什么加上-a选项会响应。optparse模块实现的也是类似的功能,它是为脚本传递命令参数。

使用此模块前,首先需要导入模块中的类OptionParser,然后创建它的一个实例(对象):

from optparse import OptionParser

parser = OptionParser()  #这里也可以定义类的参数,后续有

接着就可以添加选项了,基本语法:

parser.add_option(opt_str, ...,   

                  attr=value, ...)

  每个opt_str可以有多个选项字符串,比如-f 和--file(就行Linux命令行中ls -a和ls --all效果一样),只要定义了这些选项,则在命令行输入的时候这些选项就会被识别,否则报错。opt_str的定义可以如下:

parser.add_option("-f", "--file", ...)  #-f 和 --file 是作为调用时的参数的标签,会被识别

当选项被定义好后,则可以调用parse_args()函数来获取我们定义的选项和参数
(options, args) = parser.parse_args() #parse_args可以有参数,不定义的话使用默认的sys.argv[1:]

parse_args()返回两个值,一个是选项options(如:-f),另一个是参数args,即除选项options以外的值(如:test.txt)

add_option中最重要的四个option的属性是:action,type,dest(destination),help。这四个中action又是最基础的。

action参数(附带介绍了type、dest):

action参数告诉optparse该做什么当它在命令行中遇到选项时。action有三种存储方式:store、store_false、store_true。如果不指定action的值,默认的是store,它告诉optparse将继续读取下一个参数(type),保证类型的正确性,并将它将值存储在一个变量(dest)中,即将命令行中输入的字符串将它存为options的属性,这样可以直接调用。??铝艘淮蠖眩?易约憾急桓阍瘟?~~~,先看个例子吧!

>>> parser.add_option("-f", "--file",action="store", type="string", dest="filename")

<Option at 0x2d72f48: -f/--file>

>>> args = ["-f", "foo.txt"] #这个是模拟命令行的输入

>>> (options, args) = parser.parse_args(args)

>>> options.filename

'foo.txt'

上述:当optparse看到选项-f时,它将继续读下一个参数是foo.txt,并将它存储在options.filename(这个filename就是add_option中的dest),之后dest的值将作为parser的属性被存储。所以,当调用parse_args函数时,options.filename的值就是foo.txt。这个是以“string”类型存储的,当然type也可以是int和float等,比如下面的:

parser.add_option("-n", type="int", dest="num")

注意,这个没有指定一个长字符串的选项(如:--number),这当然是可以的,不过命令行输入时选项就只能是-n了,也没有指定action,使用默认的“store”。再次使用模拟的命令行参数["-n22"](一个参数),也可以写成["-n  22"](作为两个参数来传递):
>>> parser.add_option("-n", type="int", dest="num")

<Option at 0x2d71308: -n>

>>> (options, args) = parser.parse_args(["-n22"])

>>> print options .num

22

如果不指定type参数,默认的是string类型,所以一个最简单的方式可以写成这样:

parser.add_option("-f", dest="filename")

action另两种值分别是:“store_true”和“store_false”,这一般作为一个标记使用,例如开始运行一个程序时将flag设为True,退出时将flag设为False。看了下面的例子就全明白了:当选项遇到v时,它将options.verbose设为True,当选项遇到q时,它将options.verbose设为False:

>>> from optparse import OptionParser

>>> parser=OptionParser()

>>> parser.add_option("-v", action="store_true", dest="verbose")

<Option at 0x2ceb888: -v>

>>> parser.add_option("-q", action="store_false", dest="verbose")

<Option at 0x2d68e48: -q>

>>> fakeArgs = ['-v','hello']

>>> options, args = parser.parse_args(fakeArgs)

>>> options.verbose

True

>>> fakeArgs = ['-q','bye bye']

>>> options, args = parser.parse_args(fakeArgs)

>>> options.verbose

False

#如果同时写两个选项v和q,它会以哪个为准呢,我试了一下,是以最后出现的为准,呵呵~~

>>> fakeArgs = ['-q','bye bye','-v','hello']

>>> options, args = parser.parse_args(fakeArgs)

>>> options .verbose

True

Default参数:

default参数很好理解了,即当没有指定dest的值时,给出个默认值,如下:

>>> parser.add_option("-x", action="store", dest="verbose", default="hahaha")

<Option at 0x2d77148: -x>

>>> options, args = parser.parse_args() #这里没有传参数

>>> options.verbose

'hahaha'

如果这样的话,那下面这两句的效果就一样了(前提是不给parse_args()函数传参:) 
parser.add_option("-v", action="store_true", dest="verbose")

parser.add_option("-q", action="store_false", dest="verbose", default=True)

help参数:

这个参数是为了让我们定义的“命令”更为逼真,还提供了帮助消息了呢!呵呵~~简单用法如下:

>>> from optparse import OptionParser

>>> usage = "myprog[ -f <filename>][-s <xyz>] arg1[,arg2..]"

>>> parser=OptionParser(usage) #这里为类添加了参数usage

>>> optParser.add_option("-f","--file",action = "store",type="string",dest = "fileName",help="no any help")

<Option at 0x2bdb888: -f/--file>

>>> fakeArgs = ['-f','file.txt']

>>> options, args = parser.parse_args(fakeArgs)

>>> options.fileName

'file.txt'

>>> parser.print_help()

Usage: myprog[ -f <filename>][-s <xyz>] arg1[,arg2..]
Options:

  -h, --help            show this help message and exit  #此两行根据option自动生成,比较智能额~~

  -f FILENAME, --file=FILENAME

                        no any help  #这是我定义的帮助信息(呵呵,不太友好~~)

>>> parser.print_usage()

Usage: myprog[ -f <filename>][-s <xyz>] arg1[,arg2..]  #这是类的usage信息~~很逼真,有木有?
>>>

上述是介绍基本的语法,下面举两个例子,一个是网上找的一个模拟命令行的参数的例子,另一个是“真实”的例子~~~

Example1:

from optparse import OptionParser

usage = "myprog[ -f <filename>][-s <xyz>] arg1[,arg2..]"

optParser = OptionParser(usage)

optParser.add_option("-f","--file",action = "store",type="string",dest = "fileName")

ooptParser.add_option("-v","--vison", action="store_false", dest="verbose",default='None',

                     help="make lots of noise [default]")

fakeArgs = ['-f','file.txt','-v','good luck to you', 'arg2', 'arge']  

options, args = optParser.parse_args(fakeArgs)

print options.fileName

print options.verbose

print options

print args

print optParser.print_help()

运行结果是:

file.txt

False

{'verbose': False, 'fileName': 'file.txt'}

['this is some what', 'arg2', 'arge']

Usage: myprog[ -f <filename>][-s <xyz>] arg1[,arg2..]

Options:

  -h, --help            show this help message and exit

  -f FILENAME, --file=FILENAME

  -v, --vison           make lots of noise [default]

Example2:

一个简单的例子,就是将给脚本传选项n时,则输出的是n的参数的值,否则给出默认值(脚本保存在E盘):

from optparse import OptionParser

optParser = OptionParser()

optParser.add_option("-n","--number",action = "store",type="int",dest = "intNumber")

optParser.add_option("-v","--version", action="store_false", dest="verbose",default='gggggggg',help="no help")

options, args = optParser.parse_args()

if options.intNumber is not None:  #当有选项n时,则使用给出的参数值

    #num = options.intNumber

    print options.intNumber,options.verbose
else:

    for i in range(1,5):  #不给选项n的情况下,默认输出的是1~4

        #num = i

        print i

打开cmd运行如下:

Python中optparse模块使用浅析

Python 相关文章推荐
python简单文本处理的方法
Jul 10 Python
Python 中开发pattern的string模板(template) 实例详解
Apr 01 Python
python数据封装json格式数据
Mar 04 Python
Flask框架实现的前端RSA加密与后端Python解密功能详解
Aug 13 Python
python2和python3应该学哪个(python3.6与python3.7的选择)
Oct 01 Python
pytorch 自定义卷积核进行卷积操作方式
Dec 30 Python
Python实现序列化及csv文件读取
Jan 19 Python
Python 中由 yield 实现异步操作
May 04 Python
keras 回调函数Callbacks 断点ModelCheckpoint教程
Jun 18 Python
Win10下用Anaconda安装TensorFlow(图文教程)
Jun 18 Python
python实现杨辉三角的几种方法代码实例
Mar 02 Python
Django框架模板用法详解
Jun 10 Python
Python中urllib2模块的8个使用细节分享
Jan 01 #Python
Python读取ini文件、操作mysql、发送邮件实例
Jan 01 #Python
Python实现检测服务器是否可以ping通的2种方法
Jan 01 #Python
Python Web框架Flask信号机制(signals)介绍
Jan 01 #Python
Python模拟登录12306的方法
Dec 30 #Python
python执行shell获取硬件参数写入mysql的方法
Dec 29 #Python
简单的抓取淘宝图片的Python爬虫
Dec 25 #Python
You might like
五个PHP程序员工具
2008/05/26 PHP
php 正则表达式小结
2009/08/31 PHP
php为字符串前后添加指定数量字符的方法
2015/05/04 PHP
php实现面包屑导航例子分享
2015/12/19 PHP
php获取当前url地址的方法小结
2017/01/10 PHP
JavaScript 页面编码与浏览器类型判断代码
2010/06/03 Javascript
用jQuery toggleClass 实现鼠标移上变色
2014/05/14 Javascript
Node.js安装教程和NPM包管理器使用详解
2014/08/16 Javascript
jquery实现点击向下展开菜单项(伸缩导航)效果
2015/08/22 Javascript
JS实现的网页背景闪电闪烁效果代码
2015/10/17 Javascript
AngularJS Module方法详解
2015/12/08 Javascript
js改变透明度实现轮播图的算法
2020/08/24 Javascript
简单实现node.js图片上传
2016/12/18 Javascript
基于jQuery实现火焰灯效果导航菜单
2017/01/04 Javascript
canvas绘制七巧板
2017/02/03 Javascript
详解angular2封装material2对话框组件
2017/03/03 Javascript
Bootstrap响应式表格详解
2017/05/23 Javascript
JavaScript动态加载重复绑定问题
2018/04/01 Javascript
JavaScript数组去重算法实例小结
2018/05/07 Javascript
vue+Vue Router多级侧导航切换路由(页面)的实现代码
2018/12/20 Javascript
谈谈node.js中的模块系统
2020/09/01 Javascript
python实现保存网页到本地示例
2014/03/16 Python
理解python多线程(python多线程简明教程)
2014/06/09 Python
PHP魔术方法__ISSET、__UNSET使用实例
2014/11/25 Python
Python中return语句用法实例分析
2015/08/04 Python
python flask 多对多表查询功能
2017/06/25 Python
Python中xml和json格式相互转换操作示例
2018/12/05 Python
Python文件读写常见用法总结
2019/02/22 Python
Python接口自动化测试的实现
2020/08/28 Python
Ever New加拿大官网:彰显女性美
2018/10/05 全球购物
新闻专业应届生求职信
2013/10/31 职场文书
实习会计求职自荐信范文
2014/03/10 职场文书
安全目标责任书
2014/07/22 职场文书
2015年成本会计工作总结
2015/10/14 职场文书
详解Java分布式事务的 6 种解决方案
2021/06/26 Java/Android
Springboot配置suffix指定mvc视图的后缀方法
2021/07/03 Java/Android