标签:
Python 有两个内建的模块用于处理命令行参数:
一个是 getopt,《Deep in python》一书中也有提到,只能简单处理 命令行参数;
另一个是 optparse,它功能强大,而且易于使用,可以方便地生成标准的、符合Unix/Posix 规范的命令行说明。
下面是一个使用 optparse 的简单示例:
现在,妳就可以在命令行下输入:
上面这些命令是相同效果的。除此之外, optparse 还为我们自动生成命令行的帮助信息:
输出:
首先,必须 import OptionParser 类,创建一个 OptionParser 对象:
然后,使用 add_option 来定义命令行参数:
每个命令行参数就是由参数名字符串和参数属性组成的。如 -f 或者 –file 分别是长短参数名:
最后,一旦你已经定义好了所有的命令行参数,调用 parse_args() 来解析程序的命令行:
注: 你也可以传递一个命令行参数列表到 parse_args();否则,默认使用 sys.argv[:1]。
parse_args() 返回的两个值:
action 是 parse_args() 方法的参数之一,它指示 optparse 当解析到一个命令行参数时该如何处理。actions 有一组固定的值可供选择,默认是’store ‘,表示将命令行参数值保存在 options 对象里。
示例
最后将会打印出 “foo.txt”。
当 optparse 解析到’-f’,会继续解析后面的’foo.txt’,然后将’foo.txt’保存到 options.filename 里。当调用 parser.args() 后,options.filename 的值就为’foo.txt’。
你也可以指定 add_option() 方法中 type 参数为其它值,如 int 或者 float 等等:
默认地,type 为’string’。也正如上面所示,长参数名也是可选的。其实,dest 参数也是可选的。如果没有指定 dest 参数,将用命令行的参数名来对 options 对象的值进行存取。
store 也有其它的两种形式: store_true 和 store_false ,用于处理带命令行参数后面不 带值的情况。如 -v,-q 等命令行参数:
这样的话,当解析到 ‘-v’,options.verbose 将被赋予 True 值,反之,解析到 ‘-q’,会被赋予 False 值。
其它的 actions 值还有:
store_const 、append 、count 、callback 。
parse_args() 方法提供了一个 default 参数用于设置默认值。如:
又或者使用 set_defaults():
optparse 另一个方便的功能是自动生成程序的帮助信息。你只需要为 add_option() 方法的 help 参数指定帮助信息文本:
当 optparse 解析到 -h 或者 –help 命令行参数时,会调用 parser.print_help() 打印程序的帮助信息:
注意: 打印出帮助信息后,optparse 将会退出,不再解析其它的命令行参数。
以上面的例子来一步步解释如何生成帮助信息:
自定义的程序使用方法信息(usage message):
这行信息会优先打印在程序的选项信息前。当中的 %prog,optparse 会以当前程序名的字符串来替代:如 os.path.basename.(sys.argv[0])。
如果用户没有提供自定义的使用方法信息,optparse 会默认使用: “usage: %prog [options]”。
用户在定义命令行参数的帮助信息时,不用担心换行带来的问题,optparse 会处理好这一切。
设置 add_option 方法中的 metavar 参数,有助于提醒用户,该命令行参数所期待的参数,如 metavar=“mode”:
注意: metavar 参数中的字符串会自动变为大写。
在 help 参数的帮助信息里使用 %default 可以插入该命令行参数的默认值。
如果程序有很多的命令行参数,你可能想为他们进行分组,这时可以使用 OptonGroup:
下面是将会打印出来的帮助信息:
象 usage message 一样,你可以在创建 OptionParser 对象时,指定其 version 参数,用于显示当前程序的版本信息:
这样,optparse 就会自动解释 –version 命令行参数:
包括程序异常和用户异常。这里主要讨论的是用户异常,是指因用户输入无效的、不完整的命令行参数而引发的异常。optparse 可以自动探测并处理一些用户异常:
用户也可以使用 parser.error() 方法来自定义部分异常的处理:
上面的例子,当 -b 和 -b 命令行参数同时存在时,会打印出“options -a and -b are mutually exclusive“,以警告用户。
如果以上的异常处理方法还不能满足要求,你可能需要继承 OptionParser 类,并重载 exit() 和 erro() 方法。
再来一个例子
import optparse #usage 定义的是使用方法,%prog 表示脚本本身,version定义的是脚本名字和版本号 parse=optparse.OptionParser(usage=‘"usage:%prog [options] arg1,arg2"‘,version="%prog 1.2") parse.add_option(‘-u‘,‘--user‘,dest=‘user‘,action=‘store‘,type=str,metavar=‘user‘,help=‘Enter User Name!!‘) parse.add_option(‘-p‘,‘--port‘,dest=‘port‘,type=int,metavar=‘xxxxx‘,default=3306,help=‘Enter Mysql Port!!‘) parse.add_option(‘-v‘,help=‘Mysql Version!!‘) #-u,--user 表示一个是短选项 一个是长选项 #dest=‘user‘ 将该用户输入的参数保存到变量user中,可以通过options.user方式来获取该值 #type=str,表示这个参数值的类型必须是str字符型,如果是其他类型那么将强制转换为str(可能会报错) #metavar=‘user‘,当用户查看帮助信息,如果metavar没有设值,那么显示的帮助信息的参数后面默认带上dest所定义的变量名 #help=‘Enter..‘,显示的帮助提示信息 #default=3306,表示如果参数后面没有跟值,那么将默认为变量default的值 parse.set_defaults(v=1.2) #也可以这样设置默认值 options,args=parse.parse_args() print ‘OPTIONS:‘,options print ‘ARGS:‘,args print ‘~‘*20 print ‘user:‘,options.user print ‘port:‘,options.port print ‘version:‘,options.v
parse_args() 返回的两个值:
options,它是一个对象(optpars.Values),保存有命令行参数值。只要知道命令行参数名,如 user,就可以访问其对应的值: options.user
args:返回一个位置参数的列表
action有三种类型:
action=‘store‘ 默认类型,可以忽略不写。用户必须给出一个明确的参数值,该类型定义了将实际参数值保存到dest指定变量中
action=‘store_true‘ 用户不需给出参数值,该类型定义了将布尔值true保存到dest指定的变量中
action=‘store_false‘ 用户不需给出参数值,该类型定义了将布尔值false保存到dest指定的变量中
[root@localhost ~]# python mysql.py -uroot -p3306 OPTIONS: {‘v‘: 1.2, ‘port‘: 3306, ‘user‘: ‘root‘} ARGS: [] ~~~~~~~~~~~~~~~~~~~~ user: root port: 3306 version: 1.2
[root@localhost ~]# python mysql.py --version mysql.py 1.2
标签:
原文地址:http://blog.csdn.net/u010305706/article/details/51201038