本文參考:http://docs.python.org/2/library/optparse.html
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
from optparse import OptionParser [...] parser = OptionParser()
現在可以定義命令列選項,基本語法是:
parser.add_option(opt_str, ..., attr=value, ...)
每種選項各有一個或多個選項的字串,比如 -f 或 –file,通常每個選項將有一個短選項和一個長選項。例如:
parser.add_option("-f", "--file", ...)
(options, args) = parser.parse_args()
parser.add_option("-f", "--file", action="store", type="string", dest="filename") args = ["-f", "foo.txt"] (options, args) = parser.parse_args(args) print options.filename
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()
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"
-m MODE, --mode=MODE
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)