天天看點

Python 之opt parse子產品(使用opt parse處理指令行參數)

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。

預設值

parse_args() 方法提供了一個 default 參數用于設定預設值。如:

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

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

又或者使用 set_defaults():

parser.set_defaults(filename="foo.txt",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]

注意: 列印出幫助資訊後,optparse 将會退出,不再解析其它的指令行參數。

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

    *

      自定義的程式使用方法資訊(usage message):

      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 可以插入該指令行參數的預設值。

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

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:  [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)

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

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

                       [default], 'expert'

  Dangerous Options:

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

    some of them bite.

    -g                 Group option.

顯示程式版本

象 usage message 一樣,你可以在建立 OptionParser 對象時,指定其 version 參數,用于顯示目前程式的版本資訊:

parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")

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

$ /usr/bin/foo --version

foo 1.0

處理異常

包括程式異常和使用者異常。這裡主要讨論的是使用者異常,是指因使用者輸入無效的、不完整的指令行參數而引發的異常。optparse 可以自動探測并處理一些使用者異常:

$ /usr/bin/foo -n 4x

usage: foo [options]

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

$ /usr/bin/foo -n

usage: foo [options]

foo: error: -n option requires an argument

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

(options, args) = parser.parse_args()

[...]

if options.a and options.b:

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

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

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

完整的程式例子

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

參考: http://docs.python.org/lib/module-optparse.html