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

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

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

示例

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

  1. from optparse import OptionParser
  2. [...]
  3. parser = OptionParser()
  4. parser.add_option("-f", "--file", dest="filename",
  5. help="write report to FILE", metavar="FILE")
  6. parser.add_option("-q", "--quiet",
  7. action="store_false", dest="verbose", default=True,
  8. help="don't print status messages to stdout")
  9. (options, args) = parser.parse_args()

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

  1. <yourscript> --file=outfile -q
  2. <yourscript> -f outfile --quiet
  3. <yourscript> --quiet --file outfile
  4. <yourscript> -q -foutfile
  5. <yourscript> -qfoutfile

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

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

输出:

  1. usage: <yourscript> [options]
  2. options:
  3. -h, --help            show this help message and exit
  4. -f FILE, --file=FILE  write report to FILE
  5. -q, --quiet           don't print status messages to stdout

简单流程

首先,必须 import OptionParser 类,创建一个 OptionParser 对象:

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

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

  1. parser.add_option(opt_str, ...,
  2. 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",
  2. action="store", type="string", dest="filename")
  3. args = ["-f", "foo.txt"]
  4. (options, args) = parser.parse_args(args)
  5. 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")
  2. 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")
  2. parser.add_option("-v", action="store_true", dest="verbose", default=True)

又或者使用 set_defaults():

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

生成程序帮助

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

  1. usage = "usage: %prog [options] arg1 arg2"
  2. parser = OptionParser(usage=usage)
  3. parser.add_option("-v", "--verbose",
  4. action="store_true", dest="verbose", default=True,
  5. help="make lots of noise [default]")
  6. parser.add_option("-q", "--quiet",
  7. action="store_false", dest="verbose",
  8. help="be vewwy quiet (I'm hunting wabbits)")
  9. parser.add_option("-f", "--filename",
  10. metavar="FILE", help="write output to FILE"),
  11. parser.add_option("-m", "--mode",
  12. default="intermediate",
  13. help="interaction mode: novice, intermediate, "
  14. "or expert [default: %default]")

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

  1. usage: <yourscript> [options] arg1 arg2
  2. options:
  3. -h, --help            show this help message and exit
  4. -v, --verbose         make lots of noise [default]
  5. -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  6. -f FILE, --filename=FILE
  7. write output to FILE
  8. -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
  9. expert [default: intermediate]

注意: 打印出帮助信息后,optparse 将会退出,不再解析其它的命令行参数。

以上面的例子来一步步解释如何生成帮助信息:

  • 自定义的程序使用方法信息(usage message):

    1. usage = "usage: %prog [options] arg1 arg2"

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

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

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

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

    1. -m MODE, --mode=MODE

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

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

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

  1. group = OptionGroup(parser, ``Dangerous Options'',
  2. ``Caution: use these options at your own risk.  ``
  3. ``It is believed that some of them bite.'')
  4. group.add_option(``-g'', action=''store_true'', help=''Group option.'')
  5. parser.add_option_group(group)

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

  1. usage:  [options] arg1 arg2
  2. options:
  3. -h, --help           show this help message and exit
  4. -v, --verbose        make lots of noise [default]
  5. -q, --quiet          be vewwy quiet (I'm hunting wabbits)
  6. -fFILE, --file=FILE  write output to FILE
  7. -mMODE, --mode=MODE  interaction mode: one of 'novice', 'intermediate'
  8. [default], 'expert'
  9. Dangerous Options:
  10. Caution: use of these options is at your own risk.  It is believed that
  11. some of them bite.
  12. -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
  2. foo 1.0

处理异常

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

  1. $ /usr/bin/foo -n 4x
  2. usage: foo [options]
  3. foo: error: option -n: invalid integer value: '4x'
  4. $ /usr/bin/foo -n
  5. usage: foo [options]
  6. foo: error: -n option requires an argument

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

  1. (options, args) = parser.parse_args()
  2. [...]
  3. if options.a and options.b:
  4. 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
    2. [...]
    3. def main():
    4. usage = "usage: %prog [options] arg"
    5. parser = OptionParser(usage)
    6. parser.add_option("-f", "--file", dest="filename",
    7. help="read data from FILENAME")
    8. parser.add_option("-v", "--verbose",
    9. action="store_true", dest="verbose")
    10. parser.add_option("-q", "--quiet",
    11. action="store_false", dest="verbose")
    12. [...]
    13. (options, args) = parser.parse_args()
    14. if len(args) != 1:
    15. parser.error("incorrect number of arguments")
    16. if options.verbose:
    17. print "reading %s..." % options.filename
    18. [...]
    19. if __name__ == "__main__":
    20. main()

python学习之optparse的更多相关文章

  1. python学习之argparse模块

    python学习之argparse模块 一.简介: argparse是python用于解析命令行参数和选项的标准模块,用于代替已经过时的optparse模块.argparse模块的作用是用于解析命令行 ...

  2. Python学习--04条件控制与循环结构

    Python学习--04条件控制与循环结构 条件控制 在Python程序中,用if语句实现条件控制. 语法格式: if <条件判断1>: <执行1> elif <条件判断 ...

  3. Python学习--01入门

    Python学习--01入门 Python是一种解释型.面向对象.动态数据类型的高级程序设计语言.和PHP一样,它是后端开发语言. 如果有C语言.PHP语言.JAVA语言等其中一种语言的基础,学习Py ...

  4. Python 学习小结

    python 学习小结 python 简明教程 1.python 文件 #!/etc/bin/python #coding=utf-8 2.main()函数 if __name__ == '__mai ...

  5. Python学习路径及练手项目合集

    Python学习路径及练手项目合集 https://zhuanlan.zhihu.com/p/23561159

  6. python学习笔记-python程序运行

    小白初学python,写下自己的一些想法.大神请忽略. 安装python编辑器,并配置环境(见http://www.cnblogs.com/lynn-li/p/5885001.html中 python ...

  7. Python学习记录day6

    title: Python学习记录day6 tags: python author: Chinge Yang date: 2016-12-03 --- Python学习记录day6 @(学习)[pyt ...

  8. Python学习记录day5

    title: Python学习记录day5 tags: python author: Chinge Yang date: 2016-11-26 --- 1.多层装饰器 多层装饰器的原理是,装饰器装饰函 ...

  9. [Python] 学习资料汇总

    Python是一种面向对象的解释性的计算机程序设计语言,也是一种功能强大且完善的通用型语言,已经有十多年的发展历史,成熟且稳定.Python 具有脚本语言中最丰富和强大的类库,足以支持绝大多数日常应用 ...

随机推荐

  1. 线索二叉树Threaded binary tree

    摘要   按照某种遍历方式对二叉树进行遍历,可以把二叉树中所有结点排序为一个线性序列.在该序列中,除第一个结点外每个结点有且仅有一个直接前驱结点:除最后一个结点外每一个结点有且仅有一个直接后继结点.这 ...

  2. struts2总结五: Strut2 访问Servlet API

    一.间接访问 public String execute() throws Exception { this.message="hello,this is put into applicat ...

  3. 安装Hadoop系列 — 导入Hadoop源码项目

    将Hadoop源码导入Eclipse有个最大好处就是通过 "ctrl + shift + r" 可以快速打开Hadoop源码文件. 第一步:在Eclipse新建一个Java项目,h ...

  4. 关于结构体的PPT

    http://wenku.baidu.com/link?url=bd75dv-I7pCuw9M7W8iFqu6jti6XPdUqVYDC1sXegmMpaacY7TPo-P9Vx38b8zBLj6Nd ...

  5. 24点C++程序实现 编程之美1.16

    解法1,对于任意输入的四个数字,给出一个24点的解法,若无解,则没有输出. 原理参照下图(编程之美原书) 代码如下,仅供参考 // 1.16.cpp : Defines the entry point ...

  6. node.js 异步式I/O 与事件驱动

    Node.js 最大的特点就是异步式 I/O(或者非阻塞 I/O)与事件紧密结合的编程模式.这种模式与传统的同步式 I/O 线性的编程思路有很大的不同,因为控制流很大程度上要靠事件和回调函数来组织,一 ...

  7. (转)Redis与Memcached的区别

    如果简单地比较Redis与Memcached的区别,大多数都会得到以下观点: 1 Redis不仅仅支持简单的k/v类型的数据,同时还提供list,set,hash等数据结构的存储. 2 Redis支持 ...

  8. 【转】Android Service被关闭后自动重启,解决被异常kill 服务

    http://www.kaifajie.cn/android/10182-2.html 每次调用startService(Intent)的时候,都会调用该Service对象的onStartComman ...

  9. 【HDOJ】4605 Magic Ball Game

    思路1:树状数组+离线处理,对所有的w离散化处理,边dfs边使用树状数组更新左右w的情况.思路2:主席树,边bfs边建树.结点信息存储cnt,然后在线查询.树状数组. /* 4605 */ #incl ...

  10. [ffmpeg 扩展第三方库编译系列] 关于libopenjpeg mingw32编译问题

    在mingw32如果想编译libopenjpeg 会比较麻烦 会出现undefined reference to `_imp__opj_destroy_cstr_info@4' 等错误 因此编译时候需 ...