Python經常使用模塊-命令行參數設置

時間 2019-11-10

原文原文鏈接

optparse是一個比getopt更方便靈活強大的來設置命令行參數的一個模塊。html

示例

下面是一個使用 optparse 的簡單示例：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()

如今，妳就能夠在命令行下輸入：app

<yourscript> --file=outfile -q wordpress
<yourscript> -f outfile --quiet ui
<yourscript> --quiet --file outfile this
<yourscript> -q -foutfile spa
<yourscript> -qfoutfile 命令行

上面這些命令是相同效果的。除此以外， optparse 還爲咱們自動生成命令行的幫助信息：code

<yourscript> -h htm
<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]」。