linux nginx centos google php shell 程序员 mysql 编程 java Ubuntu Android 微软 wordpress apache Firefox Python 云计算 Windows 开源

python optparse模块学习

Python 有两个内建的模块用于处理命令行参数:一个是 getopt,getopt只能简单处理 命令行参数。

另一个是 optparse,是一个能够让程式设计人员轻松设计出简单明了、易于使用、符合标准的Unix命令列程式的Python模块。生成使用和帮助信息。

下面是一个简单的示例脚本optparse_exampl_1.py:

[root@localhost python]# vim optparse_exampl_1.py
#!/usr/bin/env python
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

optparse将打印脚本的选项和帮助信息:

[root@localhost python]# ./optparse_exampl_1.py -h
Usage: optparse_exampl_1.py [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

下面简单介绍optparse的用法:

aptparse 在大多数情况下是相当灵活和强大的,本文介绍常见的optparse用法。 首先要导入OptionParser类,在主程序中要创建一个类:

from optparse import OptionParser
[...]
parser = OptionParser()

现在可以定义命令行选项,基本语法是:

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 组成的列表。

了解选项操作:

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

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 等等:

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

注意:这个选项没有长选项,长选项也是可选的,如果没有指定dest选项,将用命令行的参数名对options对象的值进行存取。store也有其他的两种形式: stort_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

延伸阅读

评论