一、基本用法
optparse，是一個更夠讓程序設計人員輕鬆設計出簡單明瞭、易於使用、符合標準的Unix命令例程式的Python模塊。生成使用和幫助信息
首先你必須導入該類，並創建一個OptionParser對象，然後再使用parser.add_option(...)待定義命令行參數，及其幫助文檔。
每個命令行參數就是由參數名字符串和參數屬性組成的。如 -f 或者 file 分別是長短參數名:
parser.add_option("-f", "--file", ...)
當你將所有的命令行參數都定義好了的時候，我們需要調用parse_args()方法賴際熙add_option()函數依次傳入的參數：
options,args = parser.parser_args()
options 是一個字典，其key字典中的關鍵字可能會是是我們所有的add_option()函數中的dest參數值，其對應的value值，是命令行輸入的對應的add_option()函數的參數值。
args,它是一個由 positional arguments 組成的列表。
爲了更好的理解，我們看下面一段代碼。
from optparse import OptionParser
optParser = OptionParser()
optParser.add_option('-f', '--file', action='store', type="string", dest='filename')
optParser.add_option("-v", "--vison", action="store_false", dest="verbose",
default='hello', help="make lots of noise [default]")
# optParser.parse_args() 剖析並返回一個字典和列表，
# 字典中的關鍵字是我們所有的add_option()函數中的dest參數值，
# 而對應的value值，是add_option()函數中的default的參數或者是由用戶傳入optParser.parse_args()的參數
fakeArgs = ['-f', 'file.txt', '-v', 'how are you', 'arg1', 'arg2']
option, args = optParser.parse_args()
op, ar = optParser.parse_args(fakeArgs)
print("option : ", option)
print("args : ", args)
print("op : ", op)
print("ar : ", ar)
輸出：
option : {'filename': None, 'verbose': 'hello'}
args : []
op : {'filename': 'file.txt', 'verbose': False}
ar : ['how are you', 'arg1', 'arg2']
二、add_option()函數參數深入分析
add_option()參數說明：
action:存儲方式，分爲三種store、store_false、store_true
type:類型
dest:存儲的變量
default:默認值
help:幫助信息
action
我們先來看看源代碼中的action取值
# The set of actions that involve storing a value somewhere;
# also listed just for constructor argument validation. (If
# the action is one of these, there must be a destination.)
STORE_ACTIONS = ("store",
"store_const",
"store_true",
"store_false",
"append",
"append_const",
"count")
action的取值有那麼多，我着重說三個store、store_false、store_true 三個取值。 action默認取值store。
--store 上表示命令行參數的值保存在options對象中。例如上面一段代碼，如果我們對optParser.parse_args()函數傳入的參數列表中帶有‘-f’，那麼就會將列表中‘-f’的下一個元素作爲其dest的實參filename的值，他們兩個參數形成一個字典中的一個元素{filename：file_txt}。相反當我們的參數列表中沒有‘-f’這個元素時，那麼filename的值就會爲空。
--store_false fakeArgs 中存在'-v'verbose將會返回False，而不是‘how are you’，也就是說verbose的值與'-v'的後一位無關，只與‘-v’存在不存在有關。
--store_ture 這與action="store_false"類似，只有其中有參數'-v'存在，則verbose的值爲True,如果'-v'不存在，那麼verbose的值爲None。
三、簡單示例
下面是一個使用 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 還爲我們自動生成命令行的幫助信息：
Python代碼
<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）：
這行信息會優先打印在程序的選項信息前。當中的 %prog，optparse 會以當前程序名的字符串來替代：如 os.path.basename.(sys.argv[0])。
如果用戶沒有提供自定義的使用方法信息，optparse 會默認使用： “usage: %prog [options]”。
usage = "usage: %prog [options] arg1 arg2"
-
用戶在定義命令行參數的幫助信息時，不用擔心換行帶來的問題，optparse 會處理好這一切。
-
設置 add_option 方法中的 metavar 參數，有助於提醒用戶，該命令行參數所期待的參數，如 metavar=“mode”：
注意： metavar 參數中的字符串會自動變爲大寫。
-m MODE, --mode=MODE
-
在 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()
轉載於：
https://blog.csdn.net/m0_37717595/article/details/80603884