Python模組學習——optparse__Python

http://www.cnblogs.com/captain_jack/archive/2011/01/11/1933366.html

Python 有兩個內建的模組用於處理命令列參數：

一個是 getopt，《Deep in python》一書中也有提到，只能簡單處理 命令列參數；

另一個是 optparse，它功能強大，而且便於使用，可以方便地產生標準的、符合Unix/Posix 規範的命令列說明。 樣本

下面是一個使用 optparse 的簡單樣本： 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()    

現在，妳就可以在命令列下輸入： <yourscript> --file=outfile -q   <yourscript> -f outfile --quiet   <yourscript> --quiet --file outfile   <yourscript> -q -foutfile   <yourscript> -qfoutfile    

上面這些命令是相同效果的。除此之外， optparse 還為我們自動產生命令列的協助資訊： <yourscript> -h   <yourscript> --help    

輸出： usage: <yourscript> [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    

  簡單流程

首先，必須 import OptionParser 類，建立一個 OptionParser 對象： from optparse import OptionParser      [...]      parser = OptionParser()    

然後，使用 add_option 來定義命令列參數： parser.add_option(opt_str, ...,                        attr=value, ...)    

每個命令列參數就是由參數名字串和參數屬性群組成的。如 -f 或者 –file 分別是長短參數名： parser.add_option("-f", "--file", ...)    

最後，一旦你已經定義好了所有的命令列參數，調用 parse_args() 來解析程式的命令列： (options, args) = parser.parse_args()    

註： 你也可以傳遞一個命令列參數列表到 parse_args()；否則，預設使用 sys.argv[:1]。

parse_args() 返回的兩個值： options，它是一個對象（optpars.Values），儲存有命令列參數值。只要知道命令列參數名，如 file，就可以訪問其對應的值： options.file 。 args，它是一個由 positional arguments 組成的列表。 Actions

action 是 parse_args() 方法的參數之一，它指示 optparse 當解析到一個命令列參數時該如何處理。actions 有一組固定的值可供選擇，預設是’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”。

當 optparse 解析到’-f’，會繼續解析後面的’foo.txt’，然後將’foo.txt’儲存到 options.filename 裡。當調用 parser.args() 後，options.filename 的值就為’foo.txt’。

你也可以指定 add_option() 方法中 type 參數為其它值，如 int 或者 float 等等： parser.add_option("-n", type="int", dest="num")    

預設地，type 為’string’。也正如上面所示，長參數名也是可選的。其實，dest 參數也是可選的。如果沒有指定 dest 參數，將用命令列的參數名來對 options 對象的值進行存取。

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 值。

其它的 actions 值還有：

store_const 、append 、count 、callback 。