Python中optionParser模块的使用方法实例教程_python

本文以实例形式较为详尽的讲述了Python中optionParser模块的使用方法,对于深入学习Python有很好的借鉴价值。分享给大家供大家参考之用。具体分析如下:

一般来说,Python中有两个内建的模块用于处理命令行参数:

一个是 getopt,《Deep in python》一书中也有提到,只能简单处理 命令行参数;

另一个是 optparse,它功能强大,而且易于使用,可以方便地生成标准的、符合Unix/Posix 规范的命令行说明。

示例如下:

from optparse import OptionParser
parser = OptionParser()
parser.add_option("-p", "--pdbk", action="store_true",
   dest="pdcl",
   default=False,
   help="write pdbk data to oracle db")
parser.add_option("-z", "--zdbk", action="store_true",
   dest="zdcl",
   default=False,
   help="write zdbk data to oracle db")
(options, args) = parser.parse_args()
if options.pdcl==True:
 print 'pdcl is true'
if options.zdcl==True:
 print 'zdcl is true' 

add_option用来加入选项,action是有store,store_true,store_false等,dest是存储的变量,default是缺省值,help是帮助提示

最后通过parse_args()函数的解析,获得选项,如options.pdcl的值。
 
下面是一个使用 optparse 的简单示例:

from optparse import OptionParser
[...]
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
   help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
   action="store_false", dest="verbose", default=True,
   help="don't print status messages to stdout")
(options, args) = parser.parse_args()

现在,你就可以在命令行下输入:

<yourscript> --file=outfile -q
<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile

上面这些命令是相同效果的。除此之外, optparse 还为我们自动生成命令行的帮助信息:

<yourscript> -h
<yourscript> --help

输出:

usage: <yourscript> [options] 

options:
 -h, --help  show this help message and exit
 -f FILE, --file=FILE write report to FILE
 -q, --quiet  don't print status messages to stdout

简单流程

首先,必须 import OptionParser 类,创建一个 OptionParser 对象:

from optparse import OptionParser 

[...] 

parser = OptionParser()

然后,使用 add_option 来定义命令行参数:

parser.add_option(opt_str, ...,
   attr=value, ...)

每个命令行参数就是由参数名字符串和参数属性组成的。如 -f 或者 –file 分别是长短参数名:

parser.add_option("-f", "--file", ...)

最后,一旦你已经定义好了所有的命令行参数,调用 parse_args() 来解析程序的命令行:

(options, args) = parser.parse_args()

注: 你也可以传递一个命令行参数列表到 parse_args();否则,默认使用 sys.argv[:1]。
parse_args() 返回的两个值:
① options,它是一个对象(optpars.Values),保存有命令行参数值。只要知道命令行参数名,如 file,就可以访问其对应的值: options.file 。
② args,它是一个由 positional arguments 组成的列表。

Actions

action 是 parse_args() 方法的参数之一,它指示 optparse 当解析到一个命令行参数时该如何处理。actions 有一组固定的值可供选择,默认是'store ',表示将命令行参数值保存在 options 对象里。

示例代码如下:

parser.add_option("-f", "--file",
   action="store", type="string", dest="filename")
args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)
print options.filename

最后将会打印出 “foo.txt”。

当 optparse 解析到'-f',会继续解析后面的'foo.txt',然后将'foo.txt'保存到 options.filename 里。当调用 parser.args() 后,options.filename 的值就为'foo.txt'。
你也可以指定 add_option() 方法中 type 参数为其它值,如 int 或者 float 等等:

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

默认地,type 为'string'。也正如上面所示,长参数名也是可选的。其实,dest 参数也是可选的。如果没有指定 dest 参数,将用命令行的参数名来对 options 对象的值进行存取。
store 也有其它的两种形式: store_true 和 store_false ,用于处理带命令行参数后面不 带值的情况。如 -v,-q 等命令行参数:

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

这样的话,当解析到 '-v',options.verbose 将被赋予 True 值,反之,解析到 '-q',会被赋予 False 值。
其它的 actions 值还有:
store_const 、append 、count 、callback 。

默认值

parse_args() 方法提供了一个 default 参数用于设置默认值。如:

parser.add_option("-f","--file", action="store", dest="filename", default="foo.txt")
parser.add_option("-v", action="store_true", dest="verbose", default=True)

又或者使用 set_defaults():

parser.set_defaults(filename="foo.txt",verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args()

生成程序帮助

optparse 另一个方便的功能是自动生成程序的帮助信息。你只需要为 add_option() 方法的 help 参数指定帮助信息文本:

usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",
   action="store_true", dest="verbose", default=True,
   help="make lots of noise [default]")
parser.add_option("-q", "--quiet",
   action="store_false", dest="verbose",
   help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
   metavar="FILE", help="write output to FILE"),
parser.add_option("-m", "--mode",
   default="intermediate",
  help="interaction mode: novice, intermediate, "
   "or expert [default: %default]")

当 optparse 解析到 -h 或者 –help 命令行参数时,会调用 parser.print_help() 打印程序的帮助信息:

usage: <yourscript> [options] arg1 arg2 

options:
 -h, --help  show this help message and exit
 -v, --verbose  make lots of noise [default]
 -q, --quiet  be vewwy quiet (I'm hunting wabbits)
 -f FILE, --filename=FILE
   write output to FILE
 -m MODE, --mode=MODE interaction mode: novice, intermediate, or
   expert [default: intermediate]

注意: 打印出帮助信息后,optparse 将会退出,不再解析其它的命令行参数。
以上面的例子来一步步解释如何生成帮助信息:

① 自定义的程序使用方法信息(usage message):
 
usage = "usage: %prog [options] arg1 arg2" 
这行信息会优先打印在程序的选项信息前。当中的 %prog,optparse 会以当前程序名的字符串来替代:如 os.path.basename.(sys.argv[0])。
如果用户没有提供自定义的使用方法信息,optparse 会默认使用: “usage: %prog [options]”。
② 用户在定义命令行参数的帮助信息时,不用担心换行带来的问题,optparse 会处理好这一切。
③ 设置 add_option 方法中的 metavar 参数,有助于提醒用户,该命令行参数所期待的参数,如 metavar=“mode”:

-m MODE, --mode=MODE

注意: metavar 参数中的字符串会自动变为大写。
④ 在 help 参数的帮助信息里使用 %default 可以插入该命令行参数的默认值。

如果程序有很多的命令行参数,你可能想为他们进行分组,这时可以使用 OptonGroup:

group = OptionGroup(parser, ``Dangerous Options'',
   ``Caution: use these options at your own risk. ``
   ``It is believed that some of them bite.'')
group.add_option(``-g'', action=''store_true'', help=''Group option.'')
parser.add_option_group(group)

下面是将会打印出来的帮助信息:

usage: [options] arg1 arg2 

options:
 -h, --help  show this help message and exit
 -v, --verbose make lots of noise [default]
 -q, --quiet  be vewwy quiet (I'm hunting wabbits)
 -fFILE, --file=FILE write output to FILE
 -mMODE, --mode=MODE interaction mode: one of 'novice', 'intermediate'
   [default], 'expert' 

 Dangerous Options:
 Caution: use of these options is at your own risk. It is believed that
 some of them bite.
 -g   Group option.

显示程序版本

象 usage message 一样,你可以在创建 OptionParser 对象时,指定其 version 参数,用于显示当前程序的版本信息:

parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")

 
这样,optparse 就会自动解释 –version 命令行参数:

$ /usr/bin/foo --version
foo 1.0

处理异常

包括程序异常和用户异常。这里主要讨论的是用户异常,是指因用户输入无效的、不完整的命令行参数而引发的异常。optparse 可以自动探测并处理一些用户异常:

$ /usr/bin/foo -n 4x
usage: foo [options] 

foo: error: option -n: invalid integer value: '4x' 

$ /usr/bin/foo -n
usage: foo [options] 

foo: error: -n option requires an argument

用户也可以使用 parser.error() 方法来自定义部分异常的处理:

(options, args) = parser.parse_args()
[...]
if options.a and options.b:
 parser.error("options -a and -b are mutually exclusive")

上面的例子,当 -b 和 -b 命令行参数同时存在时,会打印出“options -a and -b are mutually exclusive“,以警告用户。
如果以上的异常处理方法还不能满足要求,你可能需要继承 OptionParser 类,并重载 exit() 和 erro() 方法。

完整的程序例子如下:

from optparse import OptionParser
[...]
def main():
 usage = "usage: %prog [options] arg"
 parser = OptionParser(usage)
 parser.add_option("-f", "--file", dest="filename",
   help="read data from FILENAME")
 parser.add_option("-v", "--verbose",
   action="store_true", dest="verbose")
 parser.add_option("-q", "--quiet",
   action="store_false", dest="verbose")
 [...]
 (options, args) = parser.parse_args()
 if len(args) != 1:
 parser.error("incorrect number of arguments")
 if options.verbose:
 print "reading %s..." % options.filename
 [...] 

if __name__ == "__main__":
 main()

相信本文所述对大家的Python程序设计有一定的借鉴价值。

以上是小编为您精心准备的的内容,在的博客、问答、公众号、人物、课程等栏目也有的相关内容,欢迎继续使用右上角搜索按钮进行搜索python
, 模块
, 使用方法
optionParser
optionparser python、python parser模块、parser.add option、optionparser、ruby optionparser,以便于您获取更多的相关知识。

时间: 2024-08-01 20:01:15

Python中optionParser模块的使用方法实例教程_python的相关文章

Python使用cookielib模块操作cookie的实例教程_python

cookielib是一个自动处理cookies的模块,如果我们在使用爬虫等技术的时候需要保存cookie,那么cookielib会让你事半功倍!他最常见的搭档模块就是python下的urllib和request. 核心类 1.Cookie该类实现了Netscape and RFC 2965 cookies定义的cookie标准,基本可以理解为某一条cookie数据. 部分代码如下,很多属性是不是很眼熟? self.domain_initial_dot = domain_initial_dot s

在Python中使用dict和set方法的教程_python

dict Python内置了字典:dict的支持,dict全称dictionary,在其他语言中也称为map,使用键-值(key-value)存储,具有极快的查找速度. 举个例子,假设要根据同学的名字查找对应的成绩,如果用list实现,需要两个list: names = ['Michael', 'Bob', 'Tracy'] scores = [95, 75, 85] 给定一个名字,要查找对应的成绩,就先要在names中找到对应的位置,再从scores取出对应的成绩,list越长,耗时越长. 如

python中requests模块的使用方法_python

本文实例讲述了python中requests模块的使用方法.分享给大家供大家参考.具体分析如下: 在HTTP相关处理中使用python是不必要的麻烦,这包括urllib2模块以巨大的复杂性代价获取综合性的功能.相比于urllib2,Kenneth Reitz的Requests模块更能简约的支持完整的简单用例. 简单的例子: 想象下我们试图使用get方法从http://example.test/获取资源并且查看返回代码,content-type头信息,还有response的主体内容.这件事无论使用

Python中threading模块join函数用法实例分析

  本文实例讲述了Python中threading模块join函数用法.分享给大家供大家参考.具体分析如下: join的作用是众所周知的,阻塞进程直到线程执行完毕.通用的做法是我们启动一批线程,最后join这些线程结束,例如: ? 1 2 3 4 5 6 7 8 9 for i in range(10): t = ThreadTest(i) thread_arr.append(t)   for i in range(10): thread_arr[i].start()   for i in ra

在Python中使用lambda高效操作列表的教程_python

介绍 lambda Python用于支持将函数赋值给变量的一个操作符 默认是返回的,所以不用再加return关键字,不然会报错 result = lambda x: x * x result(2) # return 4 map()/filter()/reduce() 需要两个参数,第一个是一个处理函数,第二个是一个序列(list,tuple,dict)map() 将序列中的元素通过处理函数处理后返回一个新的列表filter() 将序列中的元素通过函数过滤后返回一个新的列表reduce() 将序列

python中datetime模块的使用方法

下面记录下datetime模块一些使用的方法,先打印出当前时间,然后再打印出前后3天,后3小时,后3分钟,后3秒钟的表达方式,下面看下代码: import datetime now = datetime.datetime.now() print now #往后3小时,2天,3分钟,3秒钟 print datetime.datetime.now() + datetime.timedelta(hours=3) print datetime.datetime.now() + datetime.time

简单掌握Python中glob模块查找文件路径的用法_python

glob使用UNIX shell规则查找与一个模式匹配的文件名.只要程序需要查找文件系统中名字与某个模式匹配的一组文件,就可以使用这个模块. glob的模式规则与re模块使用的正则表达式不相同.glob模式遵循标准UNIX路径扩展规则.只是用几个特殊字符来实现两个不同的通配符和字符区间.模式规则要应用于文件名中的段.模式中的路径可以是相对路径或绝对路径. shell变量名和波浪线都不会扩展. 基本用法 1.glob.glob(pathname), 返回所有匹配的文件路径列表.它只有一个参数pat

Python遍历目录的4种方法实例介绍_python

1.os.popen运行shell列表命令 复制代码 代码如下: def traverseDirByShell(path):     for f in os.popen('ls ' + path):         print f.strip() 2.利用glob模块 glob.glob(path)返回带目录的文件名.通配符和shell相似.path不能包含shell变量. 复制代码 代码如下: def traverseDirByGlob(path):     path = os.path.ex

在JavaScript中重写jQuery对象的方法实例教程_jquery

jQuery是一个款非常优秀的类库,它给我们解决了很多的客户端编程,但是任何东西都不是万能的,当它不能满足我们的需求时我们就需要对它进行重写,同时也不要影响其原有的功能或者修改其原有的功能:比如我现在的web应用程序大多数时候的数据交互都是通过Ajax来完成的,这样就可以将一些隐藏字段的数据保存在HTML标签的属性中,使HTML标签的代码量减少,如:ID,Timestamp等等,这些不需要用户输入但又不得不提交的字段,通过表单提交的做法是 <input name="ID" val