python基础之 optparse.OptionParser

optparse是专门用来在命令行添加选项的一个模块。

首先来看一段示例代码


from optparse import OptionParser

MSG_USAGE = "myprog[ -f ][-s ] arg1[,arg2..]"

optParser = OptionParser(MSG_USAGE)

optParser.add_option("-f","--file",action = "store",type="string",dest = "fileName")

ooptParser.add_option("-v","--vison", action="store_false", dest="verbose",default=‘gggggg‘,

help="make lots of noise [default]")

fakeArgs = [‘-f‘,‘file.txt‘,‘-v‘,‘good luck to you‘, ‘arg2‘, ‘arge‘]

options, args = optParser.parse_args(fakeArgs)

print options.fileName

print options.verbose

print options

print args

print optParser.print_help()

 

输入结果为


file.txt

False

{‘verbose‘: False, ‘fileName‘: ‘file.txt‘}

[‘this is some what‘, ‘arg2‘, ‘arge‘]

Usage: myprog[ -f ][-s ] arg1[,arg2..]

Options:

-h, --help            show this help message and exit

-f FILENAME, --file=FILENAME

-v, --vison           make lots of noise [default]

 

 

基本使用步骤

1、 产生一个OptionParser的物件optParse。传入的值MSG_USAGE可被调用打印命令时显示出来。


MSG_USAGE = "myprog[ -f ][-s ] arg1[,arg2..]"

optParser = OptionParser(MSG_USAGE)

2、 调用OptionParser.add_option()添加选项


optParser.add_option("-f","--file",action = "store",type = "string",dest = "fileName")

optParser.add_option("-v","--vison", action="store_false", dest="verbose",default=‘gggggg‘,

help="make lots of noise [default]")

add_option()参数说明:

action:存储方式,分为三种store、store_false、store_true

type:类型(我也不知道什么的类型)

dest:存储的变量

default:默认值

help:帮助信息

3、 调用OptionParser.parse_args()剖析并返回一个directory和一个list。


fakeArgs = [‘-f‘,‘file.txt‘,‘-v‘,‘good luck to you‘, ‘arg2‘, ‘arge‘]

options, args = optParser.parse_args(fakeArgs)

print options.fileName

print options.verbose

print options

print args

输出结果


file.txt

False

{‘verbose‘: False, ‘fileName‘: ‘file.txt‘}

[‘this is some what‘, ‘arg2‘, ‘arge‘]

parse_args()说明:

如果没有传入参加,parse_args会默认将sys.argv[1:]的值作为默认参数。这里我们将   fakeArgs模拟输入的值。

从返回结果中可以看到,

l     options为是一个directory,它的内容fakeArgs为“参数/值 ”的键值对。

l     args 是一个list,它的内容是fakeargs除去options后,剩余的输入内容。

l     options.version和options.fileName都取到与options中的directory的值。

4、 调用OptionParser.optParser.print_help()输出帮助信息


optParser.print_help()

显示返回结果


Usage: myprog[ -f ][-s ] arg1[,arg2..]

Options:

-h, --help            show this help message and exit

-f FILENAME, --file=FILENAME

-v, --vison           make lots of noise [default]

optParser.print_help()说明:

1、最开始的的MSG_USAGE的值:在这个地方显示出来了。

2、自动添加了-h这个参数。

注:在MSG_USAGE中如果使用%prog,会被自动解析为sys.args[0] 也就是文件名。如将,MSG_USAGE = "%prog [options] arg1 arg2",假如文件名为   filexx,那么出现在help中的

信息就是" filexx[options] arg1 arg2"。

 

 

深入分析

OptionParser.add_option()

例:optParser.add_option("-v","--vison", action="store_false", dest="verbose",default=‘gggggg‘,

help="make lots of noise [default]")

参数action:

存储方式,分为三种store、store_false、store_true。

下面分别对三种方式进行说明:

第一种:action = "store"

1、如果输入的参数fakeArgs中存在"-v",则verbose返回的值为fakeArgs中的紧跟‘-v‘的数,即"good luck to you"。这也正好options中的键值对应,剩下配对的参数都传给了args。请见以下代码


optParser.add_option("-f","--file",action = "store",type = "string",dest = "fileName")

optParser.add_option("-v","--vison", action="store", dest="verbose")

fakeArgs = [‘-f‘,‘file.txt‘,‘-v‘,‘good luck to you‘, ‘arg2‘, ‘arge‘]

options, args = optParser.parse_args(fakeArgs)

print optParse.verbose

print options

print args

输入结果


good luck to you

{‘verbose‘: ‘good luck to you‘, ‘fileName‘: ‘file.txt‘}

[‘arg2‘, ‘arge‘]

2、如果输入的参数fakeArgs中不存在"-v",则verbose的返回值为None。

示例代码:


optParser.add_option("-f","--file",action = "store",type = "string",dest = "fileName")

optParser.add_option("-v","--vison", action="store", dest="verbose")

fakeArgs = [‘-f‘,‘file.txt‘,‘good luck to you‘, ‘arg2‘, ‘arge‘]

options, args = optParser.parse_args(fakeArgs)

print optParse.verbose

print options

print args

输出结果


None

{‘verbose‘: None, ‘fileName‘: ‘file.txt‘}

[‘good luck to you‘, ‘arg2‘, ‘arge‘]

第二种:action = "store_true"

1、fakeArgs中存在‘-v‘,verbose将会返回True而不是"good luck to you"。意思就是说verbose的值与‘-v‘

的后一位无关,只与‘-v‘存不存在就关。

示例代码


optParser.add_option("-f","--file",action = "store",type = "string",dest = "fileName")

optParser.add_option("-v","--vison", action="store_true", dest="verbose")

fakeArgs = [‘-f‘,‘file.txt‘,‘-v‘,‘good luck to you‘, ‘arg2‘, ‘arge‘]

options, args = optParser.parse_args(fakeArgs)

print optParse.verbose

print options

print args

输出结果


True

{‘verbose‘: True, ‘fileName‘: ‘file.txt‘}

[‘good luck to you‘, ‘arg2‘, ‘arge‘]

2、fakeArgs中不存在‘-v‘,verbose同样返回空(我就不运行代码了)。

第三种:action="store_false"

这与action="store_true"类似,只有其中有参数‘-v‘存在,则verbose的值为False,如果‘-v‘不存在,那么verbose的值为None。

 

 

参数:default

optParser.add_option("-v","--vison", action="store_false", dest="verbose",default=‘gggggg‘)

设置些参数是用于返回verbose的返回值。

如果action="store",default=‘gggggg‘,代码如下。

optParser.add_option("-v","--vison", action="store_false", dest="verbose",default=‘gggggg‘)

fakeArgs = [‘-f‘,‘file.txt‘,‘-v‘,‘good luck to you‘, ‘arg2‘, ‘arge‘]

如果fakeArgs中存在‘-v‘,则返回值为,"good luck to you"

如果不存在‘-v‘则返回值为,"gggggg"

如果action ="store_true",default=‘gggggg‘,代码如下。

optParser.add_option("-v","--vison", action="store_true", dest="verbose",default=‘gggggg‘)

如果fakeArgs中存在‘-v‘,则返回值为True。

如果fakeArgs中不存在‘-v‘,则返回值为None

再一次说明了,如果action="store_true"时,verbose的值只与是否‘-v‘有关。是否也说明了action_true的优先级高于default。

注:action="store_false"的功能与此类似,返回为False或者None。再一次证明了

 

 

参数:help

optParser.add_option("-f","--file",action = "store",type = "string",dest = "fileName")

optParser.add_option("-v","--vison", action="store", dest="verbose",default=‘gggggg‘,

help="make lots of noise [default]")

主要用于显示帮助信息,使用optParser.print_help()将帮助栏显示出来。

在action="restore"时对比没使用help参数的‘-f‘与使用了help参数的‘-v‘,多了一行帮助信息。


Usage: myprog[ -f ][-s ] arg1[,arg2..]

Options:

-h, --help            show this help message and exit

-f FILENAME, --file=FILENAME

-v VERBOSE, --vison=VERBOSE

make lots of noise [default]

在action="restore_false"时。

optParser.add_option("-f","--file",action = "store",type = "string",dest = "fileName")

optParser.add_option("-v","--vison", action="store", dest="verbose",default=‘gggggg‘,

help="make lots of noise [default]")

两个对比的输出结果如下


Usage: myprog[ -f ][-s ] arg1[,arg2..]

Options:

-h, --help            show this help message and exit

-f FILENAME, --file=FILENAME

-v, --vison           make lots of noise [default]

 

 

参数:type

没有仔细测试,但知道一点时如果type="string"时,将无法使用action="store_false"和action="store_true"。不知是否可以将type理解成verbose的返回值类型。

关于输入的的参数fakeArgs的说明

还是用之前的代码分析


from optparse import OptionParser

MSG_USAGE = "myprog[ -f ][-s ] arg1[,arg2..]"

optParser = OptionParser(MSG_USAGE)

optParser.add_option("-f","--file",action = "store",type="string",dest = "fileName")

optParser.add_option("-v","--vison", action="store", dest="verbose",default=‘gggggg‘,

help="make lots of noise [default]")

fakeArgs = [‘-f‘,‘file.txt‘,‘-v‘,‘good luck to you‘, ‘arg2‘, ‘arge‘]

options, args = optParser.parse_args(fakeArgs)

print options

print args

fakeArgs中的值对于各选项‘-v‘,‘-f‘来说都是前后两个值配对的。

1、正常情况:

结果如下


则options的值为:     {‘verbose‘:‘good luck to you‘, ‘fileName‘: ‘file.txt‘}

args的值为:           [‘arg2‘, ‘arge‘]

2、不正常情况:

如果连续出现两个选项‘-f‘,‘-v‘。

fakeArgs = [‘-f‘,‘-v‘,‘good luck to you‘, ‘arg2‘, ‘arge‘]

‘-v‘作为值传给了fileName。

但verbose返回的是默认值‘gggggg‘,如果没设置将会返回None。换句说话,就是没检测到参数‘-v‘的存在,这也再一次说明了,fakeArgs中键值配对的观念。前一个数作为选项,后一个作为值。

结果如下:


则options的值为:     {‘verbose‘:‘gggggg‘, ‘fileName‘: ‘-v‘}

args的值为:           [‘good luck to you‘,‘arg2‘, ‘arge‘]

3、如果多出一个‘x‘未被定义则程序会报错。

fakeArgs = [‘-x‘,‘-f‘,‘file.txt‘,‘-v‘,‘good luck to you‘, ‘arg2‘, ‘arge‘]

好了,关于optParse这个模块就只学到了这些东西。

时间: 2024-10-12 19:17:38

python基础之 optparse.OptionParser的相关文章

Python基础教程【读书笔记】 - 2016/7/31

希望通过博客园持续的更新,分享和记录Python基础知识到高级应用的点点滴滴! 第十波:第10章  充电时刻 Python语言的核心非常强大,同时还提供了更多值得一试的工具.Python的标准安装包括一组模块,称为标准库standard library.展示这些模块的工作方式,讨论如何分析它们,学习它们所提供的功能. [10.1] 模块 已经知道如何创建和执行自己的程序,也学会了怎么用import从外部模块获取函数并且为自己的程序使用.接下来看看怎么编写自己的模块. [10.1.1] 模块是程序

Python基础教程(第十章 自带电池)

本文内容全部出自<Python基础教程>第二版,在此分享自己的学习之路. ______欢迎转载:http://www.cnblogs.com/Marlowes/p/5459376.html______ Created on Marlowes 现在已经介绍了Python语言的大部分基础知识.Python语言的核心非常强大,同时还提供了更多值得一试的工具.Python的标准安装中还包括一组模块,称为标准库(standard library).之前已经介绍了一些模块(例如math和cmath,其中包

Python模块之optparse

参考: http://www.cnblogs.com/captain_jack/archive/2011/01/11/1933366.html https://docs.python.org/2/library/optparse.html eg: # This is the blocking Get Poetry Now! client. import datetime, optparse, socket def parse_args(): usage = """usage:

python基础学习07(核心编程第二版)部分

# -*- coding: utf-8 -*- # ==================== #File: python #Author: python #Date: 2014 #==================== __author__ = 'Administrator' #file与input output #文件对象 #简单说来,就是写入和读取的方式 #file(),open()2个操作都是一样的,一般推荐open() #语法 # open(name[, mode[, bufferin

转载---Python模块学习optparse 处理命令行参数

参考资料 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 有两个内建的模块用于处理命令行参数: 一个是 getopt,<Deep in python>一书中也有提到,只能简单处理 命令行参数: 另一个是 optparse,它功能强

python基础31[常用模块介绍]

python基础31[常用模块介绍] python除了关键字(keywords)和内置的类型和函数(builtins),更多的功能是通过libraries(即modules)来提供的. 常用的libraries(modules)如下: 1)python运行时服务 * copy: copy模块提供了对复合(compound)对象(list,tuple,dict,custom class)进行浅拷贝和深拷贝的功能. * pickle: pickle模块被用来序列化python的对象到bytes流,从

linux+jmeter+python基础+抓包拦截

LINUX 一 配置jdk 环境 *需要获取root权限,或者切换为root用户 1.windows下载好,去 http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html 官方网站下载jdk(linux相应版本) 2.在usr目录下创建java路径文件夹 [root bin]cd /usr mkdir java 3.将jdk-8u60-linux-x64.tar.gz放到刚才创建的文件夹下

Python基础教程(第九章 魔法方法、属性和迭代器)

本文内容全部出自<Python基础教程>第二版,在此分享自己的学习之路. ______欢迎转载:http://www.cnblogs.com/Marlowes/p/5437223.html______ Created on Marlowes 在Python中,有的名称会在前面和后面都加上两个下划线,这种写法很特别.前面几章中已经出现过一些这样的名称(如__future__),这种拼写表示名字有特殊含义,所以绝不要在自己的程序中使用这样的名字.在Python中,由这些名字组成的集合所包含的方法称

Python基础入门 (一)

一.关于版本的选择 Should i use Python 2 or Python 3 for my development activity?转载自Python官网 Short version: Python 2.x is legacy, Python 3.x is the present and future of the language Python 3.0 was released in 2008. The final 2.x version 2.7 release came out