Python中強大的選項處理模塊。
示例
#!/usr/bin/pythonfrom optparse import OptionParser
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
action="store_false", dest="verbose", default=True,
help="don't print status messages to stdout")
(options, args) = parser.parse_args()
print options.filename,options.verbose
將上面代碼保存到文件option1.py(名字隨便),添加執行權限並運行:
./option1.py
./option1.py -f
./option1.py -f foo.txt
./option1.py -f foo.txt -q
./option1.py -qffoo.txt # 注意這個和下面對比
./option1.py -fqfoo.txt
./option1.py --file foo.txt
./option1.py --quiet
./option1.py -h # -h和--help默認情況optpars自動處理。
./option1.py --help
查看輸出結果,稍稍思考就有所的了。
加載模塊
要使用 OptionParser 模塊,需要在Python程序中導入:
from optparse import OptionParser
生成 OptionParser 實例
首先需要生成一個實例,以后的操作都是操作這個實例,相當於分配了一段內存空 間。不然無處可以操作,類似C中的結構說明。不過Python是面向”對象“的語言。對 象的屬性比結構多很多,可操作性更強,后面我們會介紹在生成 OptionParser 對象 的時候可以傳遞的一些參數。
usage = "usage: %prog [options] arg" # 定義字符串
parser = OptionParser(usage) # 傳遞一個字符串參數
OptionParser 不要求一定要傳遞參數,不過傳遞一些參數,可以方便程序使用。
OptionParser(usage="%prog [-f] [-g]",version="%prog 1.0")
# %prog 在這里會自動替換為程序名字
# usage 可以打印用法
# version 在使用 %prog --version 的時候輸出版本信息
使用add_option添加命令行參數
parser.add_option("-f", "--file", dest="filename",
help="read data from FILENAME")
parser.add_option("-v", "--verbose",
action="store_true", dest="verbose")
parser.add_option("-q", "--quiet",
action="store_false", dest="verbose")
最后調用parse_args()解析命令行參數
(options, args) = parser.parse_args()
可以傳遞一個參數列表給parse_args(),否則,默認使用命令行參數 (sys.argv[1:])。parse_args()返回兩個值:
-
options , 這是一個對象(optpars.Values),保存有命令行參數值。只要知道 命令行參數名,如file,就可以訪問其對應的值:options.file。
-
args , 一個由 positional arguments 組成的列表
parse_args()方法的參數
action
action是parse_args()方法的參數之一,指示optparser解析參數時候該如何處理。 action有一組固定的值可以選擇,默認是'store',表是將命令行參數值保存到 options對象里。
parser.add_option("-f","--file",
action="store",type="string",dest="filename")
args=["-f","foo.txt"]
(options,args)=parser.parse_args(args)
print options.filename
上面程序會輸出"foo.txt"
action的值有:store,store_true,store_false,store_const,append,count,callback.
type
type的默認值是"string",也可以是"int""float"等。
dest
如果沒有指定dest參數,將用命令行的參數名來對options對象的值進行存取。
store的形式
store可以為 store_true 和 store_false 兩種形式。用於處理命令行參數后面不 帶值的情況。如 -v, -q 等命令行參數:
parser.add_option("-v",action="store_true",dest="verbose")
parser.add_option("-q",action="store_false",dest="verbose")
當解析到 -v ,options.verbose值為True,解析到 -q , 值為 False。注意,這里 順序解析,所以如果有 -vq,最終的值還是False。
default — 設置默認值
parser.add_option("-f","--file",
action="store",
dest="filename",
default="foo.txt")
parser.add_option("-v",
action="store_true",
dest="verbose",
default=True)
help — 指定幫助文檔
parser.add_option("-f", "--filename",
metavar="FILE",
help="write output to FILE"),
optparse解析到 -h 或者 —help 命令行參數時,調用 parser.print_help()輸出 程序幫助信息。help字段很有用。
metavar — 提示用戶期望參數
Group — 給參數分組
group = OptionGroup(parser, ``Dangerous Options",
``Caution: use these options at your own risk."
``It is believed that some of them bite.")
group.add_option(``-g", action="store_true", help="Group option.")
parser.add_option_group(group)