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

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

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

示例

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

Python代码 

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

现在，妳就可以在命令行下输入：

Python代码 

  1. <yourscript> --file=outfile -q

  2. <yourscript> -f outfile --quiet

  3. <yourscript> --quiet --file outfile

  4. <yourscript> -q -foutfile

  5. <yourscript> -qfoutfile

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

Python代码 

  1. <yourscript> -h

  2. <yourscript> --help

输出：

Python代码 

  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 对象：

Python代码 

  1. from optparse import OptionParser

  2. [...]

  3. parser = OptionParser()

然后，使用 add_option 来定义命令行参数：

Python代码 

  1. parser.add_option(opt_str, ...,

  2. attr=value, ...)

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

Python代码 

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

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

Python代码 

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

示例

Python代码 

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

Python代码 

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

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

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

Python代码 

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

Python代码 

  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()：

Python代码 

  1. parser.set_defaults(filename="foo.txt",verbose=True)

  2. parser.add_option(...)

  3. (options, args) = parser.parse_args()

生成程序帮助

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

Python代码 

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

Python代码 

  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）：

    Python代码 

    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”：

    Python代码 

    1. -m MODE, --mode=MODE

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

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

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

Python代码 

  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)

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

Python代码 

  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 参数，用于显示当前程序的版本信息：

Python代码 

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

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

Python代码 

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

  2. foo 1.0

处理异常

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

Python代码 

  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() 方法来自定义部分异常的处理：

Python代码 

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

完整的程序例子

Python代码 

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

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

转载于:https://blog.51cto.com/davidbj/1223799

Python模块学习——optparse相关推荐

  1. Python模块学习-----optparse

    作用:一种类似于dos命令行的一种设计模块,例如:dos命令中添加-f会触发一种事件           可以自定义一些指令,用来完成某些操作 optparse.OptionParser() opti ...

  2. python textwrap_python2.7.3编译python模块学习- textwrap 文本包装和填充

    python模块学习- textwrap 文本包装和填充 代码实例: sample_text = ''' The textwrap module can beused to format text f ...

  3. Python模块学习 - 用tinify模块压缩和优化图片

    Python模块学习 - 用tinify模块压缩和优化图片 tinify模块 功能描述:TinyPNG和TinyJPG网站提供了压缩和优化.png和.jpg格式图片的功能.虽然可以很轻松地使用网页版进 ...

  4. Python模块学习 ---- zlib 数据压缩

    Python模块学习 ---- zlib 数据压缩 目录(?)[+] Python标准模块中,有多个模块用于数据的压缩与解压缩,如zipfile,gzip, bz2等等.上次介绍了zipfile模块, ...

  5. python模块学习笔记

    python模块学习笔记 1.Python自动发送邮件smtplib 2.制作二维码图片MyQR 3.绝对值模块math 4.CSV模块 5.openpyxl 模块,操作Excel文件 ExcelMa ...

  6. Python模块学习：glob 文件路径查找

    文章转载自<伯乐在线>原文出处: Darkbull Python模块学习:glob 文件路径查找 glob模块是最简单的模块之一,内容非常少.用它可以查找符合特定规则的文件路径名.跟使用w ...

  7. 解惑Python模块学习，该如何着手操作...

    Python模块 晚上和朋友聊天,说到公司要求精兵计划,全员都要有编程能力.然后C.Java.Python-对于零基础入门的,当然是选择Python的人较多了.可朋友说他只是看了简单的语法,可pyth ...

  8. 【Python模块学习】pandas模块简介

    pandas模块学习 一.背景概述 Pandas (Python Data Analysis Library) 是基于NumPy 的一种工具,该工具是为了解决数据分析任务而创建的. numpy更加适用 ...

  9. python模块学习（1）

    模块让你能够有逻辑地组织你的Python代码段.把相关的代码分配到一个 模块里能让你的代码更好用,更易懂. 模块也是Python对象,具有随机的名字属性用来绑定或引用. 简单地说,模块就是一个保存了P ...

最新文章

  1. idea（3）-jetty配置
  2. 【大型网站技术实践】初级篇：借助LVS+Keepalived实现负载均衡
  3. php调用txt接口,PHP 如何更优雅地调用 API 接口
  4. Robots.txt - 禁止爬虫（转）
  5. 包含c语言的序列化字符,Android Serializable与Parcelable原理与区别
  6. mvc后台字符串转换html,c# – 从MVC Controller返回一个字符串到jQuery
  7. 以Delphi Package架构多人开发应用程序环境
  8. python 速度 memmap_浅析Python 读取图像文件的性能对比
  9. linux中atoi函数的实现 值得借鉴,【转】atoi()函数的实现
  10. Python基础day05 作业解析【10道 函数作业题】
  11. Mybatis、使用注解的方式编写用户和角色一对多关系，并使用延迟加载
  12. 40vf什么意思_变频器的VF模式是什么意思？VF什么意思
  13. 随想录（做自己代码的测试工程师）
  14. Java开源项目Hibernate包作用详解
  15. Java线程池 与Lambda
  16. 使用MagicRecon在挖洞时最大化数据收集量
  17. 猎豹网校C++ Primer学习笔记
  18. android recycleView嵌套recycleView下拉二级列表显示（带动画）
  19. Failed to introspect Class from LaunchedURLClassLoader
  20. SpringBoot整合redis使用setnx完成分布式锁

热门文章

  1. 如何写出漂亮的代码：七个法则
  2. vue脚手架项目技术集合
  3. DL_WITH_PY系统学习（第2章）
  4. 五个超酷Linux命令
  5. Mybatis之批量更新操作
  6. 心血来潮学python
  7. 检索COM 类工厂中CLSID 为{00024500-0000-0000-C000-000000000046}组件时失败
  8. SQL Server 批量完整备份
  9. SVN centos6.3
  10. 我的公交一卡通用不了了-_-