以下是一个使用 optparse 的简单演示样例：

Python代码

Python optparse模块
演示样例
简单流程
Actions
默认值
生成程序帮助
显示程序版本号
处理异常
完整的程序样例

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()

如今，妳就能够在命令行下输入：

Python代码

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

上面这些命令是同样效果的。除此之外， optparse 还为我们自己主动生成命令行的帮助信息：

Python代码

<yourscript> -h
<yourscript> --help

输出：

Python代码

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 对象：

Python代码

from optparse import OptionParser
[...]
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)
print options.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_true 和 store_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_const 、append 、count 、callback 。

默认值

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] 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() 打印程序的帮助信息：

Python代码

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）：
Python代码
1. usage = "usage: %prog [options] arg1 arg2"
这行信息会优先打印在程序的选项信息前。其中的 %prog，optparse 会以当前程序名的字符串来替代：如 os.path.basename.(sys.argv[0])。

假设用户没有提供自己定义的用法信息，optparse 会默认使用： “usage: %prog [options]”。
用户在定义命令行參数的帮助信息时，不用操心换行带来的问题，optparse 会处理好这一切。
设置 add_option 方法中的 metavar 參数，有助于提醒用户。该命令行參数所期待的參数，如 metavar=“mode”：
Python代码
1. -m MODE, --mode=MODE
注意： metavar 參数中的字符串会自己主动变为大写。
在 help 參数的帮助信息里使用 %default 能够插入该命令行參数的默认值。

假设程序有非常多的命令行參数，你可能想为他们进行分组，这时能够使用 OptonGroup：

Python代码

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)

以下是将会打印出来的帮助信息：

Python代码

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 參数。用于显示当前程序的版本号信息：

Python代码

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

这样，optparse 就会自己主动解释 –version 命令行參数：

Python代码

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

处理异常

包含程序异常和用户异常。

这里主要讨论的是用户异常，是指因用户输入无效的、不完整的命令行參数而引发的异常。optparse 能够自己主动探測并处理一些用户异常：

Python代码

$ /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() 方法来自己定义部分异常的处理：

Python代码

(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() 方法。

完整的程序样例

Python代码

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()

再来一个样例

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

Python optparse模块 演示样例 简单流程 Actions 默认值 生成程序帮助 显示程序版本号 处理异常 完整的程序样例

简单流程

Actions

默认值

生成程序帮助

显示程序版本号

处理异常

完整的程序样例

相关推荐

Python optparse模块演示样例简单流程 Actions 默认值生成程序帮助显示程序版本号处理异常完整的程序样例