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'

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'

parser = OptionParser()


parser.add_option("-t","--time",action="store",dest="filedate",help="appoint the logfile time,use like this '-t 130825'")

(options,args) = parser.parse_args()

####option####

if options.filedate:

filedate = options.filedate

else:

filedate = (datetime.datetime.now() - datetime.timedelta(days=1)).strftime('%y%m%d')

可以替代getopt的一个模块

from optparse import OptionParser

#  生成一个实例
parser = OptionParser(usage="%prog -f server.list -u root ...  versrion 1",version="%prog 1")
parser.add_option("-f", "--file",dest="File",action="store",help="Host list")

# 保存了,可以通过 print options.filename

parser.add_option("-u", "--user",action="store", dest="User",help="Username")

# 没有指定dest参数,将用命令行的参数名来对options对象的值进行存取,这里就是User.

parser.add_option("-s", "--screen",action="store_true", dest="Screen",help="Output to the screen")

store_true这个action的意思是只有在使用该参数的时候存,也就是你加了-s参数,才会保存

(options, args) = parser.parse_args()
   parse_args(): #解析命令行的参数, 并将结果传给options

返回两个值:

1. options , 这是一个对象(optpars.Values),保存命令行参数值。只要知道命令行参数名,如file,就可以访问其对应的值:options.file。
2. args , 一个由 positional arguments 组成的列表

ARGDIR = vars(options)
 return ARGDIR
============================================
parser.add_option('-v', '–version', action='store_true', dest='version', default=False, help='show the version of this command')

#store_true这个action的意思是只有在使用该参数的时候存储, default则可以给一个默认值。也就是你加了-v 显示版本信息,否则不显示。

add_option用来加入选项,action是有store,store_true,store_false等,dest是存储的变量,default是缺省值,help是帮助提示 

最后通过parse_args()函数的解析,获得选项,如options.pdcl的值。

下面是一个使用 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代码

    这行信息会优先打印在程序的选项信息前。当中的 %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”:Python代码 注意: metavar 参数中的字符串会自动变为大写。

  1. -m MODE, --mode=MODE

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

本文转自 chengxuyonghu 51CTO博客,原文链接:http://blog.51cto.com/6226001001/1637898,如需转载请自行联系原作者

Python optionParser模块的使用方法相关推荐

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

    Python中optionParser模块的使用方法实例教程 转载  2014-08-29   投稿:shichen2014    我要评论 这篇文章主要介绍了Python中optionParser模 ...

  2. mac如何导入python第三方库_Mac系统中python idle导入第三方模块成功,ecplise导入python第三方模块失败解决方法...

    遇到一个比较纠结了4个月的问题,一直没有在意,今天实在忍受不了,尝试各种解决办法,终于把这个烦人的问题完美解决,不敢独享,写出来和各位大神共享. 问题:在mac OSx操作系统下,安装了python第 ...

  3. python replace函数 成功 失败_请教下调用python string模块的replace方法出错的原因

    直接调用没有问题 def test1(): test_str="028-123456" print test_str.replace(old="-",new=& ...

  4. python OptionParser模块使用

    OptionParser是python中用来处理命令行的模块,在我们使用python进行流程化开发中必要的工具 Optparse,它功能强大,而且易于使用,可以方便地生成标准的.符合Unix/Posi ...

  5. python依赖模块离线安装方法

    一.方式一 1.依赖模块下载 下载需要的模块 :我这里下载openpyxl 模块(模块下载可以到python 官网上下载:PyPI · The Python Package Index)搜索openp ...

  6. Python导入模块3种方法

    Python共有3种导入模块的方法 举例:现有文件夹class01,其下有Python file demo1,demo1.py有函数test01(),如何在另一个文件demo2.py中调用test01 ...

  7. python安装模块3种方法详解

    方法1.pip # 安装最新版本 pip install pymysql# 安装指定版本 pip install pymysql==xxx 如果使用pip命令安装失败,使用下面两个方法 方法2.下载w ...

  8. python日志模块方法_python日志模块logbook使用方法

    python自带了日志模块logging,可以用来记录程序运行过程中的日志信息.同时python还有logbook模块用来取代logging模块,在很多的项目中logbook模块使用也是比较的多,因此 ...

  9. python 日志模块--python logbook使用方法

    python自带了日志模块logging,可以用来记录程序运行过程中的日志信息.同时python还有logbook模块用来取代logging模块,在很多的项目中logbook模块使用也是比较的多,因此 ...

最新文章

  1. DEBUG日记:同样的代码在不同的环境却得出不同的结果。
  2. 递归 反转字符串_使用递归反转字符串
  3. android 微积分计算器,高数计算器1.0(高数计算工具app)
  4. 2018北京大学计算机考研分数线,2018年北京大学考研复试分数线已公布
  5. 吴恩达深度学习编程作业汇总
  6. 用户角色权限设计思路
  7. 【UDS诊断服务入门】
  8. MCS-51的存储器结构
  9. matlab kdj,kdj指标详什么时候买入,kdj指标详解四大绝技
  10. Eclipse常用便捷设置
  11. Poco Timer
  12. “互联网+政务”是什么?
  13. linux认证加k8s认证,如何快速验证您的Kubernetes配置文件?
  14. QAndroidJniObject::callStaticObjectMethod参数含义
  15. 如何用PR制作GIF图(Premiere)
  16. 投影向量计算公式的推导
  17. python中exec是什么意思_Python中的exec()
  18. C++实现内存“垃圾”回收机制
  19. 软考--快速掌握操作系统的PV操作
  20. vue公共组件封装及传值

热门文章

  1. Vue.js学习系列(四十二)-- Vue.js组件
  2. 虚拟机无法使用网卡桥接模式
  3. iOS点击空白收回键盘
  4. Redis进阶实践之三如何在Windows系统上安装安装Redis
  5. 推荐一个简单、轻量、功能非常强大的C#/ASP.NET定时任务执行管理器组件–FluentScheduler...
  6. 12C expdp issue
  7. JS传中文到后台需要的处理
  8. 办公电脑选购方案指南
  9. 2015化妆品行业如何进行微信公众号营销
  10. CGIC简明教程(转摘)