python optparse模塊

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

一個是 getopt，getopt只能簡單處理 命令行參數。

另外一個是 optparse，是一個可以讓程式設計人員輕鬆設計出簡單明瞭、易於使用、符合標準的Unix命令列程式的Python模塊。生成使用和幫助信息。

下面是一個簡單的示例腳本optparse_exampl_1.py：

[root@localhost python]# vim optparse_exampl_1.py

#!/usr/bin/env python 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

optparse將打印腳本的選項和幫助信息：

[root@localhost python] # ./optparse_exampl_1.py -h Usage: optparse_exampl_1.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

下面簡單介紹optparse的用法：

aptparse 在大多數狀況下是至關靈活和強大的，本文介紹常見的optparse用法。

首先要導入OptionParser類，在主程序中要建立一個類：

from  optparse import OptionParser [...] parser  =  OptionParser()

如今能夠定義命令行選項，基本語法是：

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 組成的列表。

瞭解選項操做：

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" )

注意：這個選項沒有長選項，長選項也是可選的，若是沒有指定dest選項，將用命令行的參數名對options對象的值進行存取。store也有其餘的兩種形式: stort_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

默認值

parse_args() 方法提供了一個 default 參數用於設置默認值。如：

parser.add_option( "-v" , action = "store_true" , dest = "verbose" ) parser.add_option( "-q" , action = "store_false" , dest = "verbose" , default = True )

又或者使用set_defaults例如：

parser.set_defaults(verbose = True ) parser.add_option(...) (options, args)  =  parser.parse_args()

程序生成幫助

optparse 另外一個方便的功能是自動生成程序的幫助信息。你只須要爲 add_option() 方法的 help 選項指定幫助信息文本：

usage  =  "usage: %prog [options] arg1 arg2" parser  =  OptionParser(usage=usage) parser.add_option( "-v" ,  "--verbose" , action = "store_true" , dest = "verbose" , default = True , help = "make lots of noise [default]" ) parser.add_option( "-q" ,  "--quiet" , action = "store_false" , dest = "verbose" , help = "be vewwy quiet (I'm hunting wabbits)" ) parser.add_option( "-f" ,  "--filename" , metavar = "FILE" ,  help = "write output to FILE" ) parser.add_option( "-m" ,  "--mode" , default = "intermediate" , help = "interaction mode: novice, intermediate, " "or expert [default: %default]" )

當 optparse 解析到 -h 或者 –help 命令行參數時，會調用 parser.print_help() 打印程序的幫助信息：

Usage: <yourscript> [options] arg1 arg2 Options: - h,  - - help             show this help message and exit - v,  - - verbose         make lots of noise [default] - q,  - - quiet           be vewwy quiet (I'm hunting wabbits) - f  FILE ,  - - filename = FILE write output to  FILE - m MODE,  - - mode = MODE  interaction mode: novice, intermediate,  or expert [default: intermediate]

（注意：當腳本打印幫助信息後會退出，不會解析其餘選項參數）

自定義程序使用方法：

usage  =  "usage: %prog [options] arg1 arg2"

這行信息會優先打印在程序的選項信息前。當中的 %prog，optparse 會以當前程序名的字符串來替代：如 os.path.basename.(sys.argv[0])。

若是用戶沒有提供自定義的使用方法信息，optparse 會默認使用： 「usage: %prog [options]」。

用戶在定義命令行參數的幫助信息時，不用擔憂換行帶來的問題，optparse 會處理好這一切。

設置 add_option 方法中的 metavar 參數，有助於提醒用戶，該命令行參數所期待的參數，如 metavar=「mode」：

- m MODE,  - - mode = MODE

注意： metavar 參數中的字符串會自動變爲大寫。

在 help 參數的幫助信息裏使用 %default 能夠插入該命令行參數的默認值。

若是程序有不少的命令行參數，你可能想爲他們進行分組，這時能夠使用  OptionGroup：

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)

輸出以下：

Usage: <yourscript> [options] arg1 arg2 Options: - h,  - - help             show this help message and exit - v,  - - verbose         make lots of noise [default] - q,  - - quiet           be vewwy quiet (I'm hunting wabbits) - f  FILE ,  - - filename = FILE write output to  FILE - m MODE,  - - mode = MODE  interaction mode: novice, intermediate,  or expert [default: intermediate] Dangerous Options: Caution: use these options at your own risk.  It  is  believed that some of them bite. - g                  Group option.

完整的列子：

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) group  =  OptionGroup(parser, "Debug Options") group.add_option( "-d" ,  "--debug" , action = "store_true" , help = "Print debug information" ) group.add_option( "-s" ,  "--sql" , action = "store_true" , help = "Print all SQL statements executed" ) group.add_option( "-e" , action = "store_true" ,  help = "Print every action done" ) parser.add_option_group(group)