Python中optionParser模块的使⽤⽅法实例教程
本⽂以实例形式较为详尽的讲述了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,
python教程字符串函数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", ""]
(options, args) = parser.parse_args(args)
print options.filename
最后将会打印出 “”。
当 optparse 解析到'-f'，会继续解析后⾯的''，然后将''保存到 options.filename ⾥。当调⽤ parser.args()
后，options.filename 的值就为''。
你也可以指定 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="")
parser.add_option("-v", action="store_true", dest="verbose", default=True)
⼜或者使⽤ set_defaults()：
parser.set_defaults(filename="",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
⽤户也可以使⽤ () ⽅法来⾃定义部分异常的处理：
(options, args) = parser.parse_args()
[...]
if options.a and options.b:
<("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:
<("incorrect number of arguments")
if options.verbose:
print "reading %s..." % options.filename
[...]
if __name__ == "__main__":
main()
相信本⽂所述对⼤家的Python程序设计有⼀定的借鉴价值。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。