文档章节

python optparse模块

突然帅了
 突然帅了
发布于 2015/03/22 09:30
字数 1720
阅读 8
收藏 0

Python 有两个内建的模块用于处理命令行参数:

一个是 getopt,《Deep in python》一书中也有提到,只能简单处理 命令行参数;

另一个是 optparse,它功能强大,而且易于使用,可以方便地生成标准的、符合Unix/Posix 规范的命令行说明。

示例

下面是一个使用 optparse 的简单示例:

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

现在,妳就可以在命令行下输入:

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

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

  1. <yourscript> -h  
    <yourscript> --help

输出:

  1. 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 对象:

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

然后,使用 add_option 来定义命令行参数:

  1. parser.add_option(opt_str, ...,  
                      attr=value, ...)

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

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

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

  1. (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 对象里。

示例

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

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

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

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

  1. 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 参数用于设置默认值。如:

  1. 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():

  1. parser.set_defaults(filename="foo.txt",verbose=True)  
    parser.add_option(...)  
    (options, args) = parser.parse_args()

生成程序帮助

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

  1. 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() 打印程序的帮助信息:

  1. 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):

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

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

    1. usage = "usage: %prog [options] arg1 arg2"
  • 用户在定义命令行参数的帮助信息时,不用担心换行带来的问题,optparse 会处理好这一切。

  • 设置 add_option 方法中的 metavar 参数,有助于提醒用户,该命令行参数所期待的参数,如 metavar=“mode”:

  • 注意: metavar 参数中的字符串会自动变为大写。

    1. -m MODE, --mode=MODE
  • 在 help 参数的帮助信息里使用 %default 可以插入该命令行参数的默认值。

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

  1. 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)

下面是将会打印出来的帮助信息:

  1. 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 参数,用于显示当前程序的版本信息:

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

这样,optparse 就会自动解释 –version 命令行参数:

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

处理异常

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

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

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

完整的程序例子

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

本文转载自:http://www.cnblogs.com/captain_jack/archive/2011/01/11/1933366.html

突然帅了
粉丝 8
博文 90
码字总数 28698
作品 0
西安
私信 提问
[转]optionParser模块的使用方法

Python 有两个内建的模块用于处理命令行参数: 一个是 getopt,《Deep in python》一书中也有提到,只能简单处理 命令行参数; 另一个是 optparse,它功能强大,而且易于使用,可以方便地生成...

阿木阿木
2014/03/08
63
0
Commando 3.0.0 发布,Python 命令行工具包

版本更新: 包含 用户指南 的Wiki 页标记的示例代码中的错误都已修复。 Commando 灵感来自于 Python 的 optparse 模块 以及 JewelCli Java 库,是一个用来定义以及解析 命令行参数的Python工...

彭博
2013/01/24
1K
0
Python模块-optparse模块 指定脚本后跟参数

简介 optparse里面包含了几个主要类别: OptionParser解析类、 Option定义类、 Values解析结果类 OptionParse是入口,实例化OptionParse类时通过option_list指定option定义列表,version作为...

ZHAO_JH
2018/06/08
22
0
学Python需要天赋吗?看完弟弟编写的爬虫与爆破脚本,只有汗水!

Python学习记录脚本,希望弟弟通过练习编写脚本一点点提升自己很菜的编程水平~~明天会更好,希望自己越来越强吧。 实现原理 Python3 实现批量查询网站的百度权重以及收录情况,利用的是站长之...

Python新世界
2018/07/24
0
0
(总结)python 3程序开发指南(五)模块

1.有些情况下,使用单独的一条语句导入包中的所有模块会带来方便,为此在init.py文件中加入all=["",""]包含模块的名字。同理要想对导入模块中所有函数叶可以添加__all__选项,精确控制导入的...

索隆
2012/04/24
185
0

没有更多内容

加载失败,请刷新页面

加载更多

CRM、DMP、CDP都是什么?有什么区别?

Markter对CRM系统(Customer Relationship Management System,客户关系管理系统),营销自动化等概念都已经比较熟悉,也许DMP(Data Management Platform,数据管理平台)也多多少少有些了解。...

怡海软件-CRM
11分钟前
3
0
中台是什么,到底要解决什么问题?

故事的开始 这个最早由阿里在2015年提出的“大中台,小前台”战略中延伸出来的概念,最近在国内大热。阿里、腾讯、百度、京东、美团、滴滴等一众互联网巨头,从去年到今年,接连开始组织架构...

喵二狸
22分钟前
2
0
Linux Centos 7 - MySQL 5.7离线安装

内部网络通过离线包的方式进行安装。 一、下载 下载地址:https://dev.mysql.com/downloads/mysql/ 进入页面后,点击右侧链接。 下载对应版本。 通过xftp6等工具上传到服务器上。 二、安装和...

华山猛男
23分钟前
2
0
EventBus 3 全解

EventBus 3 全解 [TOC] 使用 一个基于观察者模式的事件发布/订阅框架. 用于模块间通信和解耦, 使用方便,性能高. 基本使用 1. gradle导入依赖库 implementation 'org.greenrobot:eventbus:3....

马湖村第九后羿
25分钟前
3
0
HTTP 协议

什么是HTTP协议? HTTP是hypertext transport protocol的缩写,即超文本传输协议。 是用于万维网服务器与本地浏览器之间传输超文本的传送协议。可以使浏览器更加高效,使网络传输减少。能够保...

彩色泡泡糖
35分钟前
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部