python optparse命令解析模塊
來源:http://www.cnblogs.com/pping/p/3989098.html?utm_source=tuicool&utm_medium=referral
來源:http://www.cnblogs.com/darkpig/p/5677153.html
來源:點擊打開鏈接
Python 有兩個內建的模塊用於處理命令行參數:
一個是 getopt只能簡單處理 命令行參數;
另一個是 optparse,它功能強大,而且易於使用,可以方便地生成標準的、符合Unix/Posix 規範的命令行說明。會自動幫你負責-h幫助選項。
[python] view plain copy
- import optparse
- #usage 定義的是使用方法,%prog 表示腳本本身,version定義的是腳本名字和版本號
- parse=optparse.OptionParser(usage=‘"usage:%prog [options] arg1,arg2"‘,version="%prog 1.2")
- parse.add_option(‘-u‘,‘--user‘,dest=‘user‘,action=‘store‘,type=str,metavar=‘user‘,help=‘Enter User Name!!‘)
- parse.add_option(‘-p‘,‘--port‘,dest=‘port‘,type=int,metavar=‘xxxxx‘,default=3306,help=‘Enter Mysql Port!!‘)
- parse.add_option(‘-v‘,help=‘Mysql Version!!‘)
- #-u,--user 表示一個是短選項 一個是長選項
- #dest=‘user‘ 將該用戶輸入的參數保存到變量user中,可以通過options.user方式來獲取該值
- #type=str,表示這個參數值的類型必須是str字符型,如果是其他類型那麽將強制轉換為str(可能會報錯)
- #metavar=‘user‘,當用戶查看幫助信息,如果metavar沒有設值,那麽顯示的幫助信息的參數後面默認帶上dest所定義的變量名
- #help=‘Enter..‘,顯示的幫助提示信息
- #default=3306,表示如果參數後面沒有跟值,那麽將默認為變量default的值
- parse.set_defaults(v=1.2) #也可以這樣設置默認值
- options,args=parse.parse_args()
- print ‘OPTIONS:‘,options
- print ‘ARGS:‘,args
- print ‘~‘*20
- print ‘user:‘,options.user
- print ‘port:‘,options.port
- print ‘version:‘,options.v
parse_args() 返回的兩個值:
options,它是一個對象(optpars.Values),保存有命令行參數值。只要知道命令行參數名,如 user,就可以訪問其對應的值: options.user
args:返回一個位置參數的列表
action有三種類型:
action=‘store‘ 默認類型,可以忽略不寫。用戶必須給出一個明確的參數值,該類型定義了將實際參數值保存到dest指定變量中
action=‘store_true‘ 用戶不需給出參數值,該類型定義了將布爾值true保存到dest指定的變量中
action=‘store_false‘ 用戶不需給出參數值,該類型定義了將布爾值false保存到dest指定的變量中
[root@localhost ~]# python mysql.py -uroot -p3306
OPTIONS: {‘v‘: 1.2, ‘port‘: 3306, ‘user‘: ‘root‘}
ARGS: []
~~~~~~~~~~~~~~~~~~~~
user: root
port: 3306
version: 1.2
[root@localhost ~]# python 001.py --version 001.py 1.2
示例 2
[python] view plain copy
- <span style="font-size:12px;"># coding = utf-8
- from optparse import OptionParser
- from optparse import OptionGroup
- usage = ‘Usage: %prog [options] arg1 arg2 ...‘
- parser = OptionParser(usage,version=‘%prog 1.0‘)
- #通過OptionParser類創建parser實例,初始參數usage中的%prog等同於os.path.basename(sys.argv[0]),即
- #你當前所運行的腳本的名字,version參數用來顯示當前腳本的版本。
- ‘‘‘‘‘
- 添加參數,-f、--file是長短options,有一即可。
- action用來表示將option後面的值如何處理,比如:
- XXX.py -f test.txt
- 經過parser.parse_args()處理後,則將test.txt這個值存儲進-f所代表的一個對象,即定義-f中的dest
- 即option.filename = ‘test.txt‘
- action的常用選項還有store_true,store_false等,這兩個通常在布爾值的選項中使用。
- metavar僅在顯示幫助中有用,如在顯示幫助時會有:
- -f FILE, --filename=FILE write output to FILE
- -m MODE, --mode=MODE interaction mode: novice, intermediate, or expert
- [default: intermediate]
- 如果-f這一項沒有metavr參數,則在上面會顯示為-f FILENAME --filename=FILENAME,即會顯示dest的值
- defalut是某一選項的默認值,當調用腳本時,參數沒有指定值時,即采用default的默認值。
- ‘‘‘
- parser.add_option(‘-f‘,‘--file‘,
- action=‘store‘,dest=‘filename‘,
- metavar=‘FILE‘,help=‘write output to FILE‘)
- parser.add_option(‘-m‘,‘--mode‘,
- default = ‘intermediate‘,
- help=‘interaction mode:novice,intermediate,or expert [default:%default]‘)
- 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)")
- group = OptionGroup(parser,‘Dangerous Options‘,
- ‘Caution: use these options at your own risk.‘
- ‘It is believed that some of them bite.‘)
- #調用OptionGroup類,定制以組顯示的option
- group.add_option(‘-g‘,action=‘store_true‘,help=‘Group option.‘)
- #添加option
- parser.add_option_group(group)
- #將剛定制的groupoption加入parser中
- 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)
- (options,args) = parser.parse_args()
- #解析腳本輸入的參數值,options是一個包含了option值的對象
- #args是一個位置參數的列表</span>
- <span style="font-size:12px;">python.exe xxx.py --help顯示結果如下:
- Usage: test_optparse.py [options] arg1 arg2 ...
- Options:
- --version show program‘s version number and exit
- -h, --help show this help message and exit
- -f FILE, --file=FILE write output to FILE
- -m MODE, --mode=MODE interaction mode:novice,intermediate,or expert
- [default:intermediate]
- -v, --verbose make lots of noise [default]
- -q, --quiet be vewwy quiet (I‘m hunting wabbits)
- Dangerous Options:
- Caution: use these options at your own risk.It is believed that some
- of them bite.
- -g Group option.
- Debug Options:
- -d, --debug Print debug information.
- -s, --sql Print all SQL statements executed
- -e Print every action done</span>
Python: 使用 optparse 處理命令行參數
Python 有兩個內建的模塊用於處理命令行參數,一個是 getopt,《Deep in
python》一書中也有提到,只能簡單處理命令行參數;另一個是 optparse,它功能強大,而且易於使用,可以方便地生成標準的、符合
Unix/Posix 規範的命令行說明。
示例
下面是一個使用 optparse 的簡單示例:
[python] view plain copy- 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("optionsnd -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("incorrecter of arguments")
if options.verbose:
print "reading %s..." % options.filename
[...]
if __name__ == "__main__":
main()
參考資料
- http://docs.python.org/lib/module-optparse.html
python optparse命令解析模塊