600字范文,内容丰富有趣,生活中的好帮手!
600字范文 > Python模块: 命令行解析optionparser

Python模块: 命令行解析optionparser

时间:2023-07-27 01:32:35

相关推荐

Python模块: 命令行解析optionparser

Python 有两个内建的模块用于处理命令行参数:

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

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

使用optionparser模块来解析

optionparser的执行过程:

导入optionparser :fromoptparseimportOptionParser

构造optionparser的对象:parser=OptionParser()

往optionparser对象中增加option :parser.add_option()

调用optionparser的解析函数:(options,args)=parser.parse_args()

在options中使用解析到的options,在args中使用其他的args。

1. 普通的格式(-a a -b b ...)

1 #parse command 2usage = "usage: python %prog [options]" 3parser = OptionParser(usage=usage) 4parser.add_option('-d', '--device', help="Device serial number.") 5parser.add_option('-o', '--osVersion', help="Os version.") 6options, args = parser.parse_args(sys.argv) 78if options.device is None: 9 ......10else:11 ......12 13if options.osVersion is None:14 osVersion = ......15elif options.osVersion is "1":16 osVersion = ......17else:18 print "Error"19 sys.exit(-1)

2. 只需要参数,不需要参数内容的格式(-a --bb ...)

parser.add_option('--nl', action="store_false", help="No Need.")

3. 直接调用方法的格式,不需要参数内容

parser.add_option("-l", "--list", action="callback", callback=test_list, help="check the list.")

4. 直接调用方法,并传参数的格式

parser.add_option("-u", "--upload", action="callback", callback=test_upload, callback_args=(ingredient,build), help="upload result.")

示例

下面是一个使用 optparse 的简单示例:

Python代码 fromoptparseimportOptionParser[...]parser=OptionParser()parser.add_option("-f","--file",dest="filename",help="writereporttoFILE",metavar="FILE")parser.add_option("-q","--quiet",action="store_false",dest="verbose",default=True,help="don'tprintstatusmessagestostdout")(options,args)=parser.parse_args()

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

Python代码 <yourscript>--file=outfile-q<yourscript>-foutfile--quiet<yourscript>--quiet--fileoutfile<yourscript>-q-foutfile<yourscript>-qfoutfile

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

Python代码 <yourscript>-h<yourscript>--help

输出:

Python代码 usage:<yourscript>[options]options:-h,--helpshowthishelpmessageandexit-fFILE,--file=FILEwritereporttoFILE-q,--quietdon'tprintstatusmessagestostdout

简单流程

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

Python代码 fromoptparseimportOptionParser[...]parser=OptionParser()

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

Python代码 parser.add_option(opt_str,...,attr=value,...)

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

Python代码 parser.add_option("-f","--file",...)

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

Python代码 (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 对象里。

示例

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

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

当 optparse 解析到’-f’,会继续解析后面的’foo.txt’,然后将’foo.txt’保存到 options.filename 里。当调用 parser.args() 后,options.filename 的值就为’foo.txt’。

你也可以指定 add_option() 方法中 type 参数为其它值,如 int 或者 float 等等:

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

默认地,type 为’string’。也正如上面所示,长参数名也是可选的。其实,dest 参数也是可选的。如果没有指定 dest 参数,将用命令行的参数名来对 options 对象的值进行存取。

store 也有其它的两种形式:store_truestore_false,用于处理带命令行参数后面不 带值的情况。如 -v,-q 等命令行参数:

Python代码 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_constappendcountcallback

默认值

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

Python代码 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():

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

生成程序帮助

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

Python代码 usage="usage:%prog[options]arg1arg2"parser=OptionParser(usage=usage)parser.add_option("-v","--verbose",action="store_true",dest="verbose",default=True,help="makelotsofnoise[default]")parser.add_option("-q","--quiet",action="store_false",dest="verbose",help="bevewwyquiet(I'mhuntingwabbits)")parser.add_option("-f","--filename",metavar="FILE",help="writeoutputtoFILE"),parser.add_option("-m","--mode",default="intermediate",help="interactionmode:novice,intermediate,""orexpert[default:�fault]")

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

Python代码 usage:<yourscript>[options]arg1arg2options:-h,--helpshowthishelpmessageandexit-v,--verbosemakelotsofnoise[default]-q,--quietbevewwyquiet(I'mhuntingwabbits)-fFILE,--filename=FILEwriteoutputtoFILE-mMODE,--mode=MODEinteractionmode:novice,intermediate,orexpert[default:intermediate]

注意:打印出帮助信息后,optparse 将会退出,不再解析其它的命令行参数。

以上面的例子来一步步解释如何生成帮助信息:

自定义的程序使用方法信息(usage message):

Python代码 usage="usage:%prog[options]arg1arg2"

这行信息会优先打印在程序的选项信息前。当中的 %prog,optparse 会以当前程序名的字符串来替代:如 os.path.basename.(sys.argv[0])。

如果用户没有提供自定义的使用方法信息,optparse 会默认使用: “usage: %prog [options]”。

用户在定义命令行参数的帮助信息时,不用担心换行带来的问题,optparse 会处理好这一切。

设置 add_option 方法中的 metavar 参数,有助于提醒用户,该命令行参数所期待的参数,如 metavar=“mode”:

Python代码 -mMODE,--mode=MODE

注意:metavar 参数中的字符串会自动变为大写。

在 help 参数的帮助信息里使用 �fault 可以插入该命令行参数的默认值。

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

Python代码 group=OptionGroup(parser,``DangerousOptions'',``Caution:usetheseoptionsatyourownrisk.````Itisbelievedthatsomeofthembite.'')group.add_option(``-g'',action=''store_true'',help=''Groupoption.'')parser.add_option_group(group)

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

Python代码 usage:[options]arg1arg2options:-h,--helpshowthishelpmessageandexit-v,--verbosemakelotsofnoise[default]-q,--quietbevewwyquiet(I'mhuntingwabbits)-fFILE,--file=FILEwriteoutputtoFILE-mMODE,--mode=MODEinteractionmode:oneof'novice','intermediate'[default],'expert'DangerousOptions:Caution:useoftheseoptionsisatyourownrisk.Itisbelievedthatsomeofthembite.-gGroupoption.

显示程序版本

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

Python代码 parser=OptionParser(usage="%prog[-f][-q]",version="%prog1.0")

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

Python代码 $/usr/bin/foo--versionfoo1.0

处理异常

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

Python代码 $/usr/bin/foo-n4xusage:foo[options]foo:error:option-n:invalidintegervalue:'4x'$/usr/bin/foo-nusage:foo[options]foo:error:-noptionrequiresanargument

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

Python代码 (options,args)=parser.parse_args()[...]ifoptions.aandoptions.b:parser.error("options-aand-baremutuallyexclusive")

上面的例子,当 -b 和 -b 命令行参数同时存在时,会打印出“options -a and -b are mutually exclusive“,以警告用户。

如果以上的异常处理方法还不能满足要求,你可能需要继承 OptionParser 类,并重载 exit() 和 erro() 方法。

完整的程序例子

Python代码 fromoptparseimportOptionParser[...]defmain():usage="usage:%prog[options]arg"parser=OptionParser(usage)parser.add_option("-f","--file",dest="filename",help="readdatafromFILENAME")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()iflen(args)!=1:parser.error("incorrectnumberofarguments")ifoptions.verbose:print"reading%s..."%options.filename[...]if__name__=="__main__":main()

本内容不代表本网观点和政治立场,如有侵犯你的权益请联系我们处理。
网友评论
网友评论仅供其表达个人看法,并不表明网站立场。