Python学习笔记之optparse模块OptionParser

在工作中我们经常要制定运行脚本的一些参数，因为有些东西是随着我么需求要改变的，所以在为们写程序的时候就一定不能把写死，这样我们就要设置参数

在python中我们可以通过sys 模板的argv 但是这模板功能远没有今天我们介绍的optparse模块强大。

介绍下最基本的用法：

• 使用optionparser模块来解析
• optionparser的执行过程：
• 导入optionparser ： from optparse import OptionParser构造optionparser的对象：parser = OptionParser()
• 往optionparser对象中增加option ：parser.add_option()
• 调用optionparser的解析函数：(options, args) = parser.parse_args()在options中使用解析到的options，在args中使用其他的args。

下面我们写个用例脚本进行简单的说明：

1. 首先我们要导入模块    from  optparse import  OptionParser

2.   创建一个  用户help说明的文档参数 （这个是可选的）

   usage="myprog [-f<filename>][-s<xyz>]arg1[,arg2..]"

3.   创建一个实例对象 optParser=OptionParser(usage)

      4.   在对象中增加参数选项   optParser.add_option("-f","--file",action="store",type="string",dest="filename",help='-f参数说明信息 ')
                                          optParser.add_option("-v","--version",action="store_false",dest="verbose",default="None",help="-v参数说明信息",)

     5.调用optionparser的解析函数 让用户输入的命令保存在optParser.parse_args(y) y中  options,args=optParser.parse_args()

 

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

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

当你将所有的命令行参数都定义好了的时候，我们需要调用parse_args()方法赖际熙add_option()函数依次传入的参数：

    options,args  =  parser.parser_args()             

 options 是一个字典，其key字典中的关键字可能会是是我们所有的add_option()函数中的dest参数值，其对应的value值，是命令行输入的对应的add_option()函数的参数值。

        args,它是一个由 positional arguments 组成的列表。

        为了更好的理解，我们看下面一段代码。
 

from optparse import OptionParser
optParser = OptionParser()
optParser.add_option('-f','--file',action = 'store',type = "string" ,dest = 'filename')
optParser.add_option("-v","--vison", action="store_false", dest="verbose",
                     default='hello',help="make lots of noise [default]")
#optParser.parse_args() 剖析并返回一个字典和列表，
#字典中的关键字是我们所有的add_option()函数中的dest参数值，
#而对应的value值，是add_option()函数中的default的参数或者是
#由用户传入optParser.parse_args()的参数
fakeArgs = ['-f','file.txt','-v','how are you', 'arg1', 'arg2']
option , args = optParser.parse_args()
op , ar = optParser.parse_args(fakeArgs)
print("option : ",option)
print("args : ",args)
print("op : ",op)
print("ar : ",ar)

输出：

option :  {'filename': None, 'verbose': 'hello'}
args :  []
op :  {'filename': 'file.txt', 'verbose': False}
ar :  ['how are you', 'arg1', 'arg2']

 注意：我们对optParser.parser_args()函数传入参数列表和，没有传入参数列表的区别。在这里我么的fakeArgs参数列表代替了我们在命令行输入的参数。如果我们在shell中运行这个代码，会如此传参：

二、add_option()函数参数深入分析：

    add_option()参数说明：
        action:存储方式，分为三种store、store_false、store_true
        type:类型
        dest:存储的变量
        default:默认值
        help:帮助信息

1、action

        我们先来看看源代码中的action取值

    # The set of actions that involve storing a value somewhere;
    # also listed just for constructor argument validation.  (If
    # the action is one of these, there must be a destination.)
    STORE_ACTIONS = ("store",
                     "store_const",
                     "store_true",
                     "store_false",
                     "append",
                     "append_const",
                     "count")

 action的取值有那么多，我么着重说三个store、store_false、store_true 三个取值。 action默认取值store。
       --store 上表示命令行参数的值保存在options对象中。例如上面一段代码，如果我们对optParser.parse_args()函数传入的参数列表中带有‘-f’，那么就会将列表中‘-f’的下一个元素作为其dest的实参filename的值，他们两个参数形成一个字典中的一个元素{filename：file_txt}。相反当我们的参数列表中没有‘-f’这个元素时，那么filename的值就会为空('filename': None)。

 

--store: 参数列表中带有'-f', 那么就会将 下一个元素作为 其dest 实参 filename的值; 没有'-f' ,那么对应的filename就为None

--store_true: 参数列表中有'-v', 那么其dest实参verbose的值就为True; 否者就为默认值hello

--store_false: 参数列表中有'-v', 那么其dest实参verbose的值就为False; 否者就为默认值hello

练习code:

#!/usr/local/bin/python3
# coding=UTF-8
from optparse import OptionParser

'''optParser.parse_args() 剖析并返回一个字典和列表，
字典中的关键字是我们所有的add_option()函数中的dest参数值，
而对应的value值，是add_option()函数中的default的参数或者是
由用户传入optParser.parse_args()的参数
'''


optParser = OptionParser()#构造optionparser的对象
optParser.add_option('-f','--file',action = 'store',type = "string" ,dest = 'filename')
optParser.add_option("-v","--vison", action="store_false", dest="verbose",
                     default='hello',help="make lots of noise [default]")


args1=['-v','Hi!']
option , args = optParser.parse_args(args1)
print("option : ",option)
print("args : ",args)


fakeArgs = ['-f','file.txt','-v','how are you', 'arg1', 'arg2']
op , ar = optParser.parse_args(fakeArgs)
print("op : ",op)
print("ar : ",ar)

fakeArgs1 = ['-f','file.txt','how are you', 'arg1', 'arg2']
op1 , ar1 = optParser.parse_args(fakeArgs1)
print("op : ",op1)
print("ar : ",ar1)