python的内置模块中对于命令行的解析模块共两个getopt 和 optparse 。不过getopt过于简单,往往不能满足需求。此时可以使用optparse模块。这个模块相对于getopt更新,功能更强大。
那么如何使用optparse模块呢? optparse 模块的官方文档给出了很详细的说明。
第一步、导入模块,并在主函数中创建实例
from optparse import OptionParser
[...]
parser = OptionParser()
第二步、使用add_option定义需要的option
parser.add_option(opt_str, ...,
attr=value, ...)
add_option 方法中有很多可选的参数,及一些影响optparse函数行为的属性。这些东西都很值得去细细推敲。
最后一步、当定义完所有option 后,通过parse_args 去解析所有的option。并返回解析结果
(options, args) = parser.parse_args()
parse_args 默认解析的是sys.argv[1:] 的所有参数。不过若你喜欢,也可以自己传递参数到parse_args。例如如下的形式:
args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)
parse_args 有两个返回值,options 和 args 。其中options是一个对象,通过这个对象可以获取到所有定义的option相应信息。而args是一个list,里面存储了所有没有被定义的参数信息。
以上三个步骤,就是使用optparse模块的完整体现。不过在第二步中add_option中存在很多影响pars_args行为的属性,将在下面逐步记录解释。
action 属性:
它将告诉optparse 遇到相应的命令行时应该怎么去做。默认若不指定action属性,它将被赋予默认值store。那么store是什么意义呢?以官方的实例说明
当添加如下的option:
parser.add_option("-f", "--file",
action="store", type="string", dest="filename")
且传递如下的参数:
args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)
当optparse 发现参数-f 时,它会将-f后面的一个参数也消费掉(将-f 和 foo.txt绑定到一起了)。并将foo.txt存储到options.filename中。当经过parse_args解析后,调用options.filename时将得到foo.txt这个值。
以上是action的默认值store。另外还有布尔类型的action。这样类型的东西主要是在命令行参数不需要值的时候使用。例如 -v 查看版本号, -v 后面就需要再写参数了。
Example:
parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="quit")
以上两个例子,当经过parse_args后调用options.verbose将为true。而调用options.quit将为false
当然,action还有其他一些值。如:store_const、append、count 和 callback 。研究后再呈上文章吧。
default属性:
给相应的参数设置默认值,也是一个很有必要知道的属性
Example:
parser.add_option("-v", action="store_true", dest="verbose", default=False)
parser.add_option("-q", action="store_false", dest="verbose", default=True)
另外一种比较清晰的方法设置默认值:
parser.set_defaults(verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args()
等等吧。具体了解,还需参考相应的官方手册:https://docs.python.org/2/library/optparse.html