Python模塊學習——optparse

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

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

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

示例

下面是一個使用 optparse 的簡單示例:

Python代碼
  1. from optparse import OptionParser  

  2. [...]  

  3. parser = OptionParser()  

  4. parser.add_option("-f", "--file", dest="filename",  

  5.                  help="write report to FILE", metavar="FILE")  

  6. parser.add_option("-q", "--quiet",  

  7.                  action="store_false", dest="verbose", default=True,  

  8.                  help="don't print status messages to stdout")  

  9. (options, args) = parser.parse_args()  

現在,妳就可以在命令行下輸入:

Python代碼
  1. <yourscript> --file=outfile -q  

  2. <yourscript> -f outfile --quiet  

  3. <yourscript> --quiet --file outfile  

  4. <yourscript> -q -foutfile  

  5. <yourscript> -qfoutfile  

上面這些命令是相同效果的。除此之外, optparse 還爲我們自動生成命令行的幫助信息:

Python代碼
  1. <yourscript> -h  

  2. <yourscript> --help  

輸出:

Python代碼
  1. usage: <yourscript> [options]  

  2. options:  

  3.  -h, --help            show this help message and exit  

  4.  -f FILE, --file=FILE  write report to FILE  

  5.  -q, --quiet           don't print status messages to stdout  


簡單流程

首先,必須 import OptionParser 類,創建一個 OptionParser 對象:

Python代碼
  1. from optparse import OptionParser  

  2. [...]  

  3. parser = OptionParser()  

然後,使用 add_option 來定義命令行參數:

Python代碼
  1. parser.add_option(opt_str, ...,  

  2.                  attr=value, ...)  

每個命令行參數就是由參數名字符串和參數屬性組成的。如 -f 或者 –file 分別是長短參數名:

Python代碼
  1. parser.add_option("-f", "--file", ...)  

最後,一旦你已經定義好了所有的命令行參數,調用 parse_args() 來解析程序的命令行:

Python代碼
  1. (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 對象裏。

示例

Python代碼
  1. parser.add_option("-f", "--file",  

  2.                  action="store", type="string", dest="filename")  

  3. args = ["-f", "foo.txt"]  

  4. (options, args) = parser.parse_args(args)  

  5. print options.filename  

最後將會打印出 “foo.txt”。

當 optparse 解析到’-f’,會繼續解析後面的’foo.txt’,然後將’foo.txt’保存到 options.filename 裏。當調用 parser.args() 後,options.filename 的值就爲’foo.txt’。

你也可以指定 add_option() 方法中 type 參數爲其它值,如 int 或者 float 等等:

Python代碼
  1. parser.add_option("-n", type="int", dest="num")  

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

store 也有其它的兩種形式: store_truestore_false ,用於處理帶命令行參數後面不 帶值的情況。如 -v,-q 等命令行參數:

Python代碼
  1. parser.add_option("-v", action="store_true", dest="verbose")  

  2. parser.add_option("-q", action="store_false", dest="verbose")  

這樣的話,當解析到 ‘-v’,options.verbose 將被賦予 True 值,反之,解析到 ‘-q’,會被賦予 False 值。

其它的 actions 值還有:

store_constappendcountcallback


默認值

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

Python代碼
  1. parser.add_option("-f","--file", action="store", dest="filename", default="foo.txt")  

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

又或者使用 set_defaults():

Python代碼
  1. parser.set_defaults(filename="foo.txt",verbose=True)  

  2. parser.add_option(...)  

  3. (options, args) = parser.parse_args()  


生成程序幫助

optparse 另一個方便的功能是自動生成程序的幫助信息。你只需要爲 add_option() 方法的 help 參數指定幫助信息文本:

Python代碼
  1. usage = "usage: %prog [options] arg1 arg2"

  2. parser = OptionParser(usage=usage)  

  3. parser.add_option("-v", "--verbose",  

  4.                  action="store_true", dest="verbose", default=True,  

  5.                  help="make lots of noise [default]")  

  6. parser.add_option("-q", "--quiet",  

  7.                  action="store_false", dest="verbose",  

  8.                  help="be vewwy quiet (I'm hunting wabbits)")  

  9. parser.add_option("-f", "--filename",  

  10.                  metavar="FILE", help="write output to FILE"),  

  11. parser.add_option("-m", "--mode",  

  12.                  default="intermediate",  

  13.              help="interaction mode: novice, intermediate, "

  14. "or expert [default: %default]")  

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

Python代碼
  1. usage: <yourscript> [options] arg1 arg2  

  2. options:  

  3.  -h, --help            show this help message and exit  

  4.  -v, --verbose         make lots of noise [default]  

  5.  -q, --quiet           be vewwy quiet (I'm hunting wabbits)  

  6.  -f FILE, --filename=FILE  

  7.                        write output to FILE  

  8.  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or

  9.                        expert [default: intermediate]  

注意: 打印出幫助信息後,optparse 將會退出,不再解析其它的命令行參數。

以上面的例子來一步步解釋如何生成幫助信息:

  • 自定義的程序使用方法信息(usage message):

    Python代碼
    1. usage = "usage: %prog [options] arg1 arg2"

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

    如果用戶沒有提供自定義的使用方法信息,optparse 會默認使用: “usage: %prog [options]”。

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

  • 設置 add_option 方法中的 metavar 參數,有助於提醒用戶,該命令行參數所期待的參數,如 metavar=“mode”:

    Python代碼
    1. -m MODE, --mode=MODE  

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

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

如果程序有很多的命令行參數,你可能想爲他們進行分組,這時可以使用 OptonGroup:

Python代碼
  1. group = OptionGroup(parser, ``Dangerous Options'',  

  2.                    ``Caution: use these options at your own risk.  ``  

  3.                    ``It is believed that some of them bite.'')  

  4. group.add_option(``-g'', action=''store_true'', help=''Group option.'')  

  5. parser.add_option_group(group)  

下面是將會打印出來的幫助信息:

Python代碼
  1. usage:  [options] arg1 arg2  

  2. options:  

  3.  -h, --help           show this help message and exit  

  4.  -v, --verbose        make lots of noise [default]  

  5.  -q, --quiet          be vewwy quiet (I'm hunting wabbits)  

  6.  -fFILE, --file=FILE  write output to FILE  

  7.  -mMODE, --mode=MODE  interaction mode: one of 'novice', 'intermediate'

  8.                       [default], 'expert'

  9.  Dangerous Options:  

  10.    Caution: use of these options is at your own risk.  It is believed that  

  11.    some of them bite.  

  12.    -g                 Group option.  


顯示程序版本

象 usage message 一樣,你可以在創建 OptionParser 對象時,指定其 version 參數,用於顯示當前程序的版本信息:

Python代碼
  1. parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")  

這樣,optparse 就會自動解釋 –version 命令行參數:

Python代碼
  1. $ /usr/bin/foo --version  

  2. foo 1.0


處理異常

包括程序異常和用戶異常。這裏主要討論的是用戶異常,是指因用戶輸入無效的、不完整的命令行參數而引發的異常。optparse 可以自動探測並處理一些用戶異常:

Python代碼
  1. $ /usr/bin/foo -n 4x

  2. usage: foo [options]  

  3. foo: error: option -n: invalid integer value: '4x'

  4. $ /usr/bin/foo -n  

  5. usage: foo [options]  

  6. foo: error: -n option requires an argument  

用戶也可以使用 parser.error() 方法來自定義部分異常的處理:

Python代碼
  1. (options, args) = parser.parse_args()  

  2. [...]  

  3. if options.a and options.b:  

  4.    parser.error("options -a and -b are mutually exclusive")  

上面的例子,當 -b 和 -b 命令行參數同時存在時,會打印出“options -a and -b are mutually exclusive“,以警告用戶。

如果以上的異常處理方法還不能滿足要求,你可能需要繼承 OptionParser 類,並重載 exit() 和 erro() 方法。


完整的程序例子

Python代碼
  1. from optparse import OptionParser  

  2. [...]  

  3. def main():  

  4.    usage = "usage: %prog [options] arg"

  5.    parser = OptionParser(usage)  

  6.    parser.add_option("-f", "--file", dest="filename",  

  7.                      help="read data from FILENAME")  

  8.    parser.add_option("-v", "--verbose",  

  9.                      action="store_true", dest="verbose")  

  10.    parser.add_option("-q", "--quiet",  

  11.                      action="store_false", dest="verbose")  

  12.    [...]  

  13.    (options, args) = parser.parse_args()  

  14. if len(args) != 1:  

  15.        parser.error("incorrect number of arguments")  

  16. if options.verbose:  

  17. print"reading %s..." % options.filename  

  18.    [...]  

  19. if __name__ == "__main__":  

  20.    main()  

參考資料


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