`
唐美好
  • 浏览: 44808 次
  • 性别: Icon_minigender_1
  • 来自: 湖南永州
社区版块
存档分类
最新评论

Python optionParser模块的使用方法

 
阅读更多
 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, 
                  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 的简单示例:
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()  

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

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

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

    <yourscript> -h 
    <yourscript> --help

输出:
Python代码

    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 对象:
Python代码

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

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

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

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

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

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

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

示例
Python代码

    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 等等:
Python代码

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

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

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

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

    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():
Python代码

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

生成程序帮助

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

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

    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):
    Python代码
        usage = "usage: %prog [options] arg1 arg2" 

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

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

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

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

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

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

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

    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) 

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

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

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



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

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

处理异常

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

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

    (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() 方法。
完整的程序例子
Python代码

    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://docs.python.org/library/optparse.html
原文地址 http://mrwlwan.wordpress.com/2008/09/25/python%ef%bc%9a-%e4%bd%bf%e7%94%a8-optparse-%e5%a4%84%e7%90%
分享到:
评论

相关推荐

    Python中optionParser模块的使用方法实例教程

    本文以实例形式较为详尽的讲述了Python中optionParser模块的使用方法,对于深入学习Python有很好的借鉴价值。分享给大家供大家参考之用。具体分析如下: 一般来说,Python中有两个内建的模块用于处理命令行参数: 一...

    python optparse模块使用实例

    在Python 3.x中,`optparse`已被更强大的`argparse`模块所替代,但对仍在使用Python 2.x的开发者来说,`optparse`仍然是一个重要的工具。 ### `optparse`模块的基本使用 1. **创建`OptionParser`对象**: 要使用`...

    利用python-nmap模块探测所有主机445端口的开放状态.pptx

    Python-Nmap 模块是 Python 的一个模块库,使用这个模块可以让 Python 很方便的操作 Nmap 扫描器来工作。Nmap 是一个网络连接扫描软件,用来扫描网络上的电脑开放的网络连接端口。确定哪些服务运行在哪些端口,并且...

    Python命令行参数解析模块optparse使用实例

    主要介绍了Python命令行参数解析模块optparse使用实例,本文讲解了增加选项(add_option())、行为(action)、设置默认值(default)、生成帮助提示(help)、设置boolean值、错误处理、选项组(Grouping Options)等内容,需要...

    python命令行传参详解,optparse模块OptionParse类的学习.pdf

    Python中的`optparse`模块是用于处理命令行选项和参数的工具,它是Python标准库的一部分。这个模块使得在命令行接口(CLI)的程序中添加和解析参数变得简单且易于理解。下面我们将深入探讨`optparse`的工作原理以及...

    Python语言总结 v1.0

    总之,《Python语言总结 v1.0》是一份宝贵的资源,不仅介绍了Python的基础知识和内置模块的使用方法,还分享了许多第三方模块的实际应用案例,以及作者自己开发的实用库crifanLib.py的相关内容。对于想要深入了解...

    python使用psutil模块获取系统状态

    Python中的`psutil`模块是一个强大的工具,用于获取运行在操作系统上的进程信息和系统资源的利用率,如CPU、内存、磁盘、网络等。这个模块是跨平台的,支持多种操作系统,包括Linux、Windows、MacOS等。在本文中,...

    python optparse命令解析模块.docx

    Python的`optparse`模块是处理命令行参数的利器,尤其适合那些需要生成符合Unix/Posix标准选项规范的程序。在Python中,还有个较简单的`getopt`模块,但`optparse`因其强大的功能和易用性而更受欢迎。 `optparse`...

    python 命令行参数

    Python提供了多种内置模块来处理这一需求,其中`getopt`和`optparse`是最为广泛使用的两种。然而,在《Deepin python》这本书中提到,`getopt`模块虽然能够满足基本的需求,但在复杂参数处理上显得力不从心。相比之...

    Python中optparse模块使用浅析

    使用此模块前,首先需要导入模块中的类OptionParser,然后创建它的一个实例(对象): 复制代码 代码如下: from optparse import OptionParser parser = OptionParser() #这里也可以定义类的参数,后续有 接着就...

    python相似模块用例

    以下展示了如何使用这两个模块实现多线程: 1. 使用`Thread`实现多线程: 在这个示例中,我们创建了一个`threadMain`函数,然后将它作为参数传递给`Thread`对象。当调用`start()`方法时,线程开始执行`threadMain`...

    python远程开启关闭的计算机

    - 在脚本中更新Python 2.x到Python 3.x的语法差异,例如`print`函数的使用。 - 如果不在同一局域网内,还需提供IP地址等其他参数。 通过以上步骤和技术方案,可以有效地实现远程开关机的功能,提高工作效率并节约...

    Python处理命令行参数模块optpars用法实例分析

    要使用optparse模块,首先需要导入该模块,通过from optparse import OptionParser语句实现。然后创建一个OptionParser类的实例,并通过实例的add_option()方法添加所需的选项。最后,在程序的main函数中调用parse_...

    Python库 | scopt-0.0.3-py3-none-any.whl

    5. 配合argparse:虽然`scopt`是一个独立的库,但它可以与Python自带的`argparse`模块结合使用,提供更多的功能和灵活性。 在安装`scopt-0.0.3-py3-none-any.whl`这个包时,你可以使用Python的`pip`工具,命令通常...

    GNU Radio_benchmarkTX codeWalkthrough

    6. **OptionParser 类的使用**:OptionParser 是 Python 的一个标准库模块,用于解析命令行选项和参数。在 GNU Radio 的脚本中使用它可以让用户在执行时输入参数,例如设置传输参数等。 7. **发送数据包函数**:这...

    python命令行参数用法实例分析

    在Python中,处理命令行参数的一种常见方法是使用`optparse`模块,这个模块提供了方便的方式来定义和解析命令行选项。下面将详细讨论`optparse`模块的使用及其相关技巧。 首先,`optparse`模块是Python标准库的一...

    Python实现Linux中的du命令

    通过`OptionParser`类定义这些选项,并使用`add_option()`方法添加它们。 在主程序逻辑中,通过`for`循环遍历命令行参数(即要检查的文件或目录),首先使用`os.path.exists()`检查文件或目录是否存在。对于文件,...

    python整合ffmpeg实现视频文件的批量转换

    接下来,可以使用Python的`subprocess`模块来执行FFmpeg命令。这样做的好处是可以直接在Python代码中控制FFmpeg的执行流程,实现更高级的功能。 #### 批量转换视频文件的实现方法 文章提供的部分代码示例展示了...

Global site tag (gtag.js) - Google Analytics