python中的optionParser模块

2022-03-14 12:20:50

Python 有两个内建的模块用于处理命令行参数：
一个是 getopt，《Deep in python》一书中也有提到，只能简单处理命令行参数；
另一个是 optparse，它功能强大，而且易于使用，可以方便地生成标准的、符合Unix/Posix 规范的命令行说明。

使用optionparser模块来解析

optionparser的执行过程：
1、导入optionparser ： from optparse import OptionParser
2、构造optionparser的对象：parser = OptionParser()
3、往optionparser对象中增加option ：parser.add_option(...),添加的内容是命令行参数，及相关的帮助信息

每个命令行参数由参数名字符串和参数属性组成，如-f或者file分别表示长短参数名：

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

4、调用optionparser的解析函数：

(options, args) = parser.parse_args()

5、在options中使用解析到的options，在args中使用其他的args。
options是一个字典，其key值是app_options()函数中的dest属性的参数值；value值对应的是app_options()函数中的defalut属性的参数值，或者是由命令行传入的参数

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:帮助信息

action的取值有那么多，我么着重说三个store、store_false、store_true 三个取值。 action默认取值store。

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

--store_false fakeArgs 中存在'-v'verbose将会返回False，而不是‘how are you’，也就是说verbose的值与'-v'的后一位无关，只与‘-v’存在不存在有关。

--store_ture 这与action="store_false"类似，只有其中有参数'-v'存在，则verbose的值为True,如果'-v'不存在，那么verbose的值为None

码农公寓

相关文章