OptionParser

使用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)簡單實例
def TestOpionparser():
from 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)
print (options.verbose)
print (args)

運行:%prog -f files.txt -q arg1 arg2
運行結果:
files.txt
False
['arg1', 'arg2']

2)更多更靈活的參數傳入方式:
<yourscript> --file=outfile -q
<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile

3)幫助被自動的生成,只需要-h來顯示
顯示幫助:%prog -h
例如1)程序的幫助結果:
Usage: parsecommandline.py [options]
Options:
-h, --help show this help message and exit
-f FILE, --file=FILE write report to FILE
-q, --quiet don't print status messages to stdout

如果你需要顯示自定義的,可以在定義optionparser時候傳入,例如:
usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)

同時還可以增加程序的版本信息,簡單地:
parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")
調用:%prog --version

4)add_option()中參數的意義:
short option string: 爲第一個參數,表示option的縮寫,例如-f;
long option string: 爲第二個參數,表示option的全拼,例如--file;
後面的參數皆爲命名參數,命名參數爲可選參數;
action=: 表示對此option的處理方式,默認值爲store,表示存儲option的值到解析後的options對象的成員中。action還可以有其他的值:對於bool值,使用store_true來默認存儲true,使用store_false來默認存儲false,store_const用來存儲const設置的值到此option,append表示增加option的參數到list中,此時此option是一個list,可能包含多個值,count表示對counter增加一,callback表示調用指定的函數。所有的action值如下:
store + store_true + store_false + store_const + append + count + callback
type=:表示此option的值的類型,默認爲string,可以指定爲string, int, choice, float and complex;
dest=:表示此option在經過optionparser解析後的options對象中成員的名字,默認使用long option string;
default=:表示比option的默認值;
metavar=:表示顯示到help中option的默認值;
const=:當action爲store_const的時候,需要設置此值;
choices=:當設置type爲choices時,需要設置此值;

5)如果options很多的時候,可以進行分組,使用如下:
group = OptionGroup(parser)
group.add_option()
parser.add_option_group(group)

6)通常的使用如下,其中包含了parser.error()來拋出與optionparser較一致的異常和錯誤信息。
from optparse import OptionParser
[...]
def main():
usage = "usage: %prog [options] arg"
parser = OptionParser(usage)
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")
[...]
(options, args) = parser.parse_args()
if len(args) != 1:
parser.error("incorrect number of arguments")
if options.verbose:
print("reading %s..." % options.filename)
[...]

if name == "main":
main()

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章