標簽:python
參考:
Argparse Tutorial:https://docs.python.org/2.7/howto/argparse.html#id1
argparse - Parser for command-line options, arguments and sub-commands:https://docs.python.org/2.7/library/argparse.html?highlight=argparse#module-argparse
#################################################
模塊argparse是Python標準庫中推薦的命令行解析模塊
有兩個其他模塊也能完成相同的功能,即getopt和optparse模塊。其中,argparse是基于optparse模塊實現(xiàn)的,因此在用法上也非常相似。
##################################################
基礎
最簡單的一個例子,編寫prog.py:
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.parse_args()
運行上述腳本并且沒有添加任何參數(shù)時,輸出無結果
添加--help參數(shù)時,argparse模塊會自動輸出幫助信息,這是它的優(yōu)勢(參數(shù)--help也可以簡化為-h,這兩個參數(shù)是不需要我們編輯的)
當指定其他參數(shù)時報錯,即便如此,也可以得到一個有用的用法信息
###############################################################
位置參數(shù)
指定位置參數(shù)后,程序必須輸入該參數(shù)值才能運行
修改prog.py腳本:
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.add_argument("echo")
args?=?parser.parse_args()
printargs.echo
增加add_argument()方法,在這個方法中,我們指定程序將要去接受的命令行選項,在這里我們命名為echo(只是一個名字,可以隨意更改)
此時,調用程序需要輸入一個參數(shù)
方法parse_args()實際上會返回一些選項指定的值,上述例子中,選項為echo
在argparse模塊中,當你指定位置參數(shù)名為echo時,此時想要提取該參數(shù)值,必須指定為args.echo
可以在add_argument()方法中添加help選項以便該位置參數(shù)更加明了
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.add_argument("echo",?help="echo?the?string?you?use?here")
args?=?parser.parse_args()
printargs.echo
一般我們要求輸出位置參數(shù)是為了以后程序的運算。由于argparse將輸入的參數(shù)均視為strings類型,而有時我們需要的是int類型,比如
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.add_argument("square",?help="display?a?square?of?a?given?number")
args?=?parser.parse_args()
printargs.square**2
當我們需要輸入一個int類型值時,由于默認輸入?yún)?shù)值均為str類型,所以出錯。此時有兩種方法
第一種,在計算過程中轉換str為int類型:
[python]view plaincopy
printint(args.square)**2
第二種,可以在add_argument()方法中用關鍵字type指定輸入類型,即可解決:
[python]view plaincopy
parser.add_argument("square",?help="display?a?square?of?a?given?number",?help=int)
推薦使用第二種
######################################################################33
可選參數(shù)
一個簡單的例子
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.add_argument("--verbosity",?help="increase?output?verbosity")
args?=?parser.parse_args()
ifargs.verbosity:
print"verbosity?turned?on"
設置可選參數(shù)后,程序可以不輸入該參數(shù)值運行
如果程序運行時要賦值可選參數(shù),必須先指定該可選參數(shù)。例如
[python]view plaincopy
python?prog.py?--verbosity?hel
如果程序運行時沒有賦值給可選參數(shù)verbosity,則相應的args.verbosity也會為空(None)
如果程序使用了可選參數(shù),后面必須跟參數(shù)值,不然會報錯
默認可選參數(shù)會被賦值為str,而在實際情況中,很多時候,可選參數(shù)是作為一個標識而不是一個確切的值,僅需要確定是true或false即可,可以指定關鍵字action,賦值為"store_true":
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.add_argument("--verbosity",?help="increase?output?verbosity",?action="store_true")
args?=?parser.parse_args()
ifargs.verbosity:
print"verbosity?turned?on"
這樣--verbosity就可以像--help類似,只需輸入?yún)?shù)即可
############################################################################3
快捷選項(短選項)
類似命令行用法,長選項總會有相應的短選項,只需在相應的add_argument()方法中加上即可:
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.add_argument("-v","--verbose",?help="increase?verbosity",?action="store_true")
args?=?parser.parse_args()
ifargs.verbose:
print"verbosity?turned?on"
####################################################################
結合使用位置參數(shù)(positional arguments)和可選參數(shù)(optional arguments)
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.add_argument("square",?type=int,?help="display?a?square?of?a?given?number")
parser.add_argument("-v","--verbose",?action="store_true",?help="increase?output?verbosity")
args?=?parser.parse_args()
answer?=?args.square**2
ifargs.verbose:
print"the?square?of?{}?equals?{}".format(args.square,?answer)
else:
printanswer
注意,參數(shù)順序沒有關系
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.add_argument("square",?type=int,?help="display?a?square?of?a?given?number")
parser.add_argument("-v","--verbosity",?type=int,?help="increase?output?verbosity")
args?=?parser.parse_args()
answer?=?args.square**2
ifargs.verbosity?==2:
print"the?square?of?{}?equals?{}".format(args.square,?answer)
elifargs.verbosity?==1:
print"{}^2?==?{}".format(args.square,?answer)
else:
printanswer
上述程序中還可改進以下,可以指定可選參數(shù)的取值范圍,用關鍵字choices:
[python]view plaincopy
parser.add_argument("-v","--verbosity",?type=int,?choices=[0,1,2],?help="increase?output?verbosity")
此處還有另一種方法來執(zhí)行程序,這也很普遍,并且這種方式匹配CPython可執(zhí)行程序
[python]view plaincopy
parser.add_argument("-v","--verbosity",?action="count",?help="increase?output?verbosity")
還可以指定關鍵字default來指定選項默認的值
[python]view plaincopy
parser.add_argument("-v","--verbosity",?default=2,?action="count",?help="increase?output?verbosity")
############################################################################
進階用法
可以使用多個位置參數(shù):
[python]view plaincopy
importargparse
parser?=?argparse.ArgumentParser()
parser.add_argument("x",?type=int,?help="the?base")
parser.add_argument("y",?type=int,?help="the?exponent")
parser.add_argument("-v","--verbosity",?action="count",?default=0)
args?=?parser.parse_args()
answer?=?args.x**args.y
ifargs.verbosity?>=2:
print"{}?to?the?power?{}?equals?{}".format(args.x,?args.y,?answer)
elifargs.verbosity?>=1:
print"{}^{}?==?{}".format(args.x,?args.y,?answer)
else:
printanswer
可以使用可選參數(shù)來顯示不同級別的信息:
[python]view plaincopy
parser?=?argparse.ArgumentParser()
parser.add_argument("x",?type=int,?help="the?base")
parser.add_argument("y",?type=int,?help="the?exponent")
parser.add_argument("-v","--verbosity",?action="count",?default=0)
args?=?parser.parse_args()
answer?=?args.x**args.y
ifargs.verbosity?>=2:
print"Running?'{}'".format(__file__)
ifargs.verbosity?>=1:
print"{}^{}?==?".format(args.x,?args.y)
printanswer
##################################################
以下是DIGITS中的一段源碼:
[python]view plaincopy
if__name__?=='__main__':
script_start_time?=?time.time()
parser?=?argparse.ArgumentParser(description='Classification?example?-?DIGITS')
###?Positional?arguments
parser.add_argument('caffemodel',???help='Path?to?a?.caffemodel')
parser.add_argument('deploy_file',??help='Path?to?the?deploy?file')
parser.add_argument('image',????????help='Path?to?an?image')
###?Optional?arguments
parser.add_argument('-m','--mean',
help='Path?to?a?mean?file?(*.npy)')
parser.add_argument('-l','--labels',
help='Path?to?a?labels?file')
parser.add_argument('--nogpu',
action='store_true',
help="Don't?use?the?GPU")
args?=?vars(parser.parse_args())
image_files?=?[args['image']]
classify(args['caffemodel'],?args['deploy_file'],?image_files,
args['mean'],?args['labels'],notargs['nogpu'])
print'Script?took?%s?seconds.'%?(time.time()?-?script_start_time,)