下面是一个使用 optparse 的简单示例&＃xff1a;

from optparse import OptionParser
[...]
parser &＃61; OptionParser()
parser.add_option("-f", "--file", dest&＃61;"filename",
help&＃61;"write report to FILE", metavar&＃61;"FILE")
parser.add_option("-q", "--quiet",
action&＃61;"store_false", dest&＃61;"verbose", default&＃61;True,
help&＃61;"don&＃39;t print status messages to stdout")

(options, args) &＃61; parser.parse_args()

现在&＃xff0c;妳就可以在命令行下输入&＃xff1a;

--file&＃61;outfile -q
-f outfile --quiet
--quiet --file outfile
-q -foutfile
-qfoutfile

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

-h
--help

输出&＃xff1a;

usage: [options]

options:
-h, --help show this help message and exit
-f FILE, --file&＃61;FILE write report to FILE
-q, --quiet don&＃39;t print status messages to stdout

首先&＃xff0c;必须 import OptionParser 类&＃xff0c;创建一个 OptionParser 对象&＃xff1a;

from optparse import OptionParser
[...]
parser &＃61; OptionParser()

然后&＃xff0c;使用 add_option 来定义命令行参数&＃xff1a;

parser.add_option(opt_str, ...,
attr&＃61;value, ...)

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

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

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

(options, args) &＃61; parser.parse_args()

注&＃xff1a; 你也可以传递一个命令行参数列表到 parse_args()&＃xff1b;否则&＃xff0c;默认使用 sys.argv[:1]。

parse_args() 返回的两个值&＃xff1a;

• options&＃xff0c;它是一个对象&＃xff08;optpars.Values&＃xff09;&＃xff0c;保存有命令行参数值。只要知道命令行参数名&＃xff0c;如 file&＃xff0c;就可以访问其对应的值&＃xff1a; options.file 。
• args&＃xff0c;它是一个由 positional arguments 组成的列表。

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

示例

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

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

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

你也可以指定 add_option() 方法中 type 参数为其它值&＃xff0c;如 int 或者 float 等等&＃xff1a;

parser.add_option("-n", type&＃61;"int", dest&＃61;"num")

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

store 也有其它的两种形式&＃xff1a; store_true 和 store_false&＃xff0c;用于处理带命令行参数后面不带值的情况。如 -v,-q 等命令行参数&＃xff1a;

parser.add_option("-v", action&＃61;"store_true", dest&＃61;"verbose")
parser.add_option("-q", action&＃61;"store_false", dest&＃61;"verbose")

这样的话&＃xff0c;当解析到 ‘-v’&＃xff0c;options.verbose 将被赋予 True 值&＃xff0c;反之&＃xff0c;解析到 ‘-q’&＃xff0c;会被赋予 False 值。

其它的 actions 值还有&＃xff1a;

store_const、append、count、callback。

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

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

又或者使用 set_defaults()&＃xff1a;

parser.set_defaults(filename&＃61;"foo.txt",verbose&＃61;True)
parser.add_option(...)
(options, args) &＃61; parser.parse_args()

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

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

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

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&＃39;m hunting wabbits)
-f FILE, --filename&＃61;FILE
write output to FILE
-m MODE, --mode&＃61;MODE interaction mode: novice, intermediate, or
expert [default: intermediate]

注意&＃xff1a; 打印出帮助信息后&＃xff0c;optparse 将会退出&＃xff0c;不再解析其它的命令行参数。

以上面的例子来一步步解释如何生成帮助信息&＃xff1a;

• 自定义的程序使用方法信息&＃xff08;usage message&＃xff09;&＃xff1a;

  usage &＃61; "usage: %prog [options] arg1 arg2"
  

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

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

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

• 设置 add_option 方法中的 metavar 参数&＃xff0c;有助于提醒用户&＃xff0c;该命令行参数所期待的参数&＃xff0c;如 metavar&＃61;“mode”&＃xff1a;

  -m MODE, --mode&＃61;MODE
  

  注意&＃xff1a; metavar 参数中的字符串会自动变为大写。

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

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

group &＃61; OptionGroup(parser, &＃96;&＃96;Dangerous Options&＃39;&＃39;,
&＃96;&＃96;Caution: use these options at your own risk. &＃96;&＃96;
&＃96;&＃96;It is believed that some of them bite.&＃39;&＃39;)
group.add_option(&＃96;&＃96;-g&＃39;&＃39;, action&＃61;&＃39;&＃39;store_true&＃39;&＃39;, help&＃61;&＃39;&＃39;Group option.&＃39;&＃39;)
parser.add_option_group(group)

下面是将会打印出来的帮助信息&＃xff1a;

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&＃39;m hunting wabbits)
-fFILE, --file&＃61;FILE write output to FILE
-mMODE, --mode&＃61;MODE interaction mode: one of &＃39;novice&＃39;, &＃39;intermediate&＃39;
[default], &＃39;expert&＃39;

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 一样&＃xff0c;你可以在创建 OptionParser 对象时&＃xff0c;指定其 version 参数&＃xff0c;用于显示当前程序的版本信息&＃xff1a;

parser &＃61; OptionParser(usage&＃61;"%prog [-f] [-q]", version&＃61;"%prog 1.0")

这样&＃xff0c;optparse 就会自动解释 –version 命令行参数&＃xff1a;

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

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

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

foo: error: option -n: invalid integer value: &＃39;4x&＃39;

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

foo: error: -n option requires an argument

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

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

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

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

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

if __name__ &＃61;&＃61; "__main__":
main()

• http://docs.python.org/lib/module-optparse.html