python3 的optparse库_python的optparse模块

optparse主要用来为脚本传递命令参数，采用预先定义好的选项来解析命令行参数

实例化一个OptionParser()对象(可以传参也可以不传参)，带参的话会把参数变量的内容作为帮助信息输出。

即可以用来自己定制程序的参数选项控制。

1、举例：

py15.py脚本：

#coding=utf-8

"""

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

一个是 getopt，只能简单处理 命令行参数；

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

"""

import optparse

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

parser=optparse.OptionParser(usage,version="%prog 1.0")

options,args=parser.parse_args()

"""

解释：

optparse.OptionParser()对象中的参数中的：%prog 代表当前脚本名字即os.path.basename(sys.argv[0])

options,args=parser.parse_args()，optparse.OptionParser()对象实例调用parse_args()方法后即可解析脚本输入的参数值；

返回值：options是一个包含了option值的对象，args是一个位置参数的列表。

parse_args()方法可以接受命令中输入的参数，也可以接受一个列表List[]，parse_args(list)

"""

E:\HDCZU_Test\Test>python py15.py -h

结果：

Usage: py15.py [options] arg1 arg2 ...

Options:

--version show program's version number and exit

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

E:\HDCZU_Test\Test>python py15.py --help

结果：

Usage: py15.py [options] arg1 arg2 ...

Options:

--version show program's version number and exit

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

E:\HDCZU_Test\Test>python py15.py --version

结果：

py15.py 1.0

2、举例：

import optparse

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

parser=optparse.OptionParser(usage,version="%prog 1.0")

#自定义可以解析的参数名

parser.add_option("-f","--file",action="store",[default="123.txt"] dest="filename",type="string",metavar="FILE",help="wirte ouput to file")

"""

参数解释：

-f 表示短参数名(后面空格/或不用空格接参数属性值)

--file 表示长参数名(后面空格/或=号接参数属性值)

aciton

aciton="store"表示用户必须给出一个明确的参数值(即-f或--file后面接的参数值)，并将参数值保存到dest定义的变量名中(即filename变量接收)

action="store_true"表示用户不需要给出参数值，将bool值True保存在dest定义的变量名中(即filename变量接收)

action="store_false"表示用户不需要给出参数值，将bool值False保存在dest定义的变量名中(即filename变量接收)

dest="filename" 定义一个变量名用来接收前面的长短参数名的参数值，即可调用options.filename来获取长短参数名的参数值

type="string" 定义前面长短参数名的参数值的类型，必须是字符串(这里可以是：string,int,num，float等类型)

metavar="FILE" 当用户查看帮助信息时，如果没有定义metvar的值，那么显示的帮助信息中长短参数名后面默认带上dest所定义的变量名；

如果定义了metavar的值，那么现实的帮助信息中长短参数名后面就带上metavar定义的值

default="123.txt" 如果长短参数名未设置参数属性值，则使用默认值代替，前提是action未定义或aciton只能定义为store_true/store_false(即action参数未传入)

help="**" 仅现实帮助信息中的语句提示信息

"""

options,args=parser.parse_args()

E:\HDCZU_Test\Test>python py15.py --help

Usage: py15.py [options] arg1 arg2 ...

Options:

--version show program's version number and exit

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

-f FILE, --file=FILE #这是设置了metavar的值"FILE"

wirte ouput to file #help的定义的帮助信息，表示对该长短参数名的提示信息

E:\HDCZU_Test\Test>python py15.py --help

Usage: py15.py [options] arg1 arg2 ...

Options:

--version show program's version number and exit

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

-f FILENAME, --file=FILENAME #这是未设置metavar的值

wirte ouput to file #help的定义的帮助信息，表示对该长短参数名的提示信息

2、举例：

import optparse

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

parser=optparse.OptionParser(usage,version="%prog 1.0")

#自定义可以解析的参数名

parser.add_option("-f","--file",action="store",dest="filename",type="string",metavar="FILE",help="wirte ouput to file")

options,args=parser.parse_args()

print("options :",options)

print(options.filename)

print("args :",args)

E:\HDCZU_Test\Test>python py15.py -f dchuoth

结果：

options : {'filename': 'dchuoth'}

dchuoth

args : []

3、举例：

可以自定义多个解析的参数名

import optparse

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

parser=optparse.OptionParser(usage,version="%prog 1.0")

#自定义可以解析的参数名

parser.add_option("-f","--file",action="store",dest="filename",type="string",metavar="FILE",help="wirte ouput to file")

parser.add_option("-u","--user",action="store",dest="username",type="string",metavar="USER",help="write user to username")

parser.add_option("-v",default="1.2",help="print version")

#设置默认值也可以这样：parser.set_defaults(v="1.2")

options,args=parser.parse_args()

print("options :",options)

print(options.filename)

print(options.username)

print(options.v)

print("args :",args)

E:\HDCZU_Test\Test>python py15.py -fdchuoth -uhzhu

结果：

options : {'filename': 'dchuoth', 'v': '1.2', 'username': 'hzhu'}

dchuoth

hzhu

1.2

args : []

E:\HDCZU_Test\Test>python py15.py -h

结果：

Usage: py15.py [options] arg1 arg2 ...

Options:

--version show program's version number and exit

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

-f FILE, --file=FILE wirte ouput to file

-u USER, --user=USER write user to username

-v V print version

4、举例：

处理异常：parser.error("error message")

import optparse

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

parser=optparse.OptionParser(usage,version="%prog 1.0")

#自定义可以解析的参数名

parser.add_option("-f","--file",action="store",dest="filename",type="string",metavar="FILE",help="wirte ouput to file")

parser.add_option("-u","--user",action="store",dest="username",type="string",metavar="USER",help="write user to username")

parser.add_option("-v",default="1.2",help="print version")

#parser.add_option("-v",default="1.2",dest="version",help="print version")

#options.version方式取v的默认值

#设置默认值也可以这样：parser.set_defaults(v="1.2")

parser.add_option("-b",action="store_true",dest="verborse")

parser.add_option("-d",action="store_false",dest="verborse")

options,args=parser.parse_args()

print("options :",options)

print(options.filename)

print(options.username)

print(options.v)

print("args :",args)

if not options.verborse:

parser.error("verborse must be true")

E:\HDCZU_Test\Test>python py15.py -f123 -uhzhu -d

结果：

options : {'filename': '123', 'v': '1.2', 'verborse': False, 'username': 'hzhu'}

123

hzhu

1.2

args : []

0

Usage: py15.py [options] arg1 arg2 ...

py15.py: error: verborse must be trueg

E:\HDCZU_Test\Test>python py15.py --file=123 --user=hzhu -b 456

结果：

options : {'verborse': True, 'v': 1.2, 'filename': '123', 'username': 'hzhu'}

123

hzhu

1.2

args : ['456'] #args是位置参数的列表，即把未能解析的参数都存入该列表中

1