python 如何利用argparse解析命令行參數(shù)
命令行參數(shù)工具是我們非常常用的工具,比如當(dāng)我們做實驗希望調(diào)節(jié)參數(shù)的時候,如果參數(shù)都是通過硬編碼寫在代碼當(dāng)中的話,我們每次修改參數(shù)都需要修改對應(yīng)的代碼和邏輯顯然這不太方便。比較好的辦法就是把必要的參數(shù)設(shè)置成通過命令行傳入的形式,這樣我們只需要在運(yùn)行的時候修改參數(shù)就可以了。
sys.argv
解析命令行傳入?yún)?shù)最簡單的辦法就是通過sys.argv,sys.argv可以獲取到我們通過命令行傳入的參數(shù)。
import sysprint(sys.argv)
用法很簡單,只需要調(diào)用sys.argv即可。argv是一個數(shù)組,如果參數(shù)有多個,我們可以通過下標(biāo)進(jìn)行訪問。但是有一點需要注意,argv當(dāng)中存儲的結(jié)果是從Python調(diào)用開始的。
我們來看一個例子,我們隨意傳入一些參數(shù),print sys.argv之后是這樣的。
python test.py -a -c -d=222 >>> [’test.py’, ’-a’, ’-c’, ’-d=222’]
也就是說我們python運(yùn)行test.py這個文件名也當(dāng)做參數(shù)之一,所以我們要獲取自定義參數(shù)的話需要從argv[1]開始。
sys.argv的好處是方便,我們只需要訪問它就可以拿到傳入的參數(shù)了。但是缺點也很明顯,就是功能太少了。假如我們是看其他大神的代碼,我們想要知道運(yùn)行的時候需要傳入什么參數(shù),以及每個參數(shù)代表什么含義就做不到了。
為了解決這個問題,我們需要使用封裝更多功能的工具,也是本篇文章的核心——argparse。
基本用法
argparse是Python當(dāng)中的一個庫,我們需要先import一下,這個庫我沒記錯應(yīng)該是Python自帶的,也不需要安裝,我們直接就可以使用。
在我們使用之前,我們需要先初始化這個parse,也就是一個參數(shù)解析器。
# 這里ArgumentParser可以傳入一個字符串,表示用途parser = argparse.ArgumentParser()parser.parse_args()
這個時候其實就已經(jīng)有了一個解析器了,我們在運(yùn)行的時候可以傳入?yún)?shù)-h,表示help,也就是查看目前解析器當(dāng)中定義的參數(shù)。由于我們現(xiàn)在什么也沒有,所以能顯示出來的就只有help。
必選參數(shù)
首先我們來介紹必選參數(shù),它的定義和函數(shù)當(dāng)中的必填參數(shù)是一樣的,也就是說我們運(yùn)行程序必須要的參數(shù)。如果不傳,那么程序不應(yīng)該執(zhí)行會進(jìn)行報錯并提示。
定義必選參數(shù)的方法非常簡單,我們只需要通過add_argument傳入?yún)?shù)的名稱就可以了。
import argparseparser = argparse.ArgumentParser('For test the parser')parser.add_argument(’test’)args = parser.parse_args()print(args.test)
這樣我們就定義了一個名叫test的參數(shù),我們可以通過args.test來訪問它。
這個時候我們再運(yùn)行python test.py -h就會發(fā)現(xiàn)提示的信息當(dāng)中多了一行:
告訴我們必選參數(shù)當(dāng)中有test,必選參數(shù)直接傳入,不需要加上前綴。所以我們執(zhí)行的時候直接python test.py xxx就可以了。
可選參數(shù)
有必選參數(shù)當(dāng)然就有可選參數(shù),可選參數(shù)由于可選可不選, 所以我們在使用的時候需要在參數(shù)前加上標(biāo)識-或者--。比如我們參數(shù)名叫做test,可以定義成-test或者--test,這兩種都可以,也可以這兩種都定義。
parser.add_argument(’-test’, ’--test’)
我們運(yùn)行-h可以發(fā)現(xiàn)optional arguments當(dāng)中多了test和--test。
但是這個只print出來了參數(shù)名,并沒有告訴我們這個參數(shù)究竟是做什么的,像是help參數(shù)后面就跟了show this help message and exit這個提示語。如果我們也希望help能夠提示我們參數(shù)的作用怎么辦呢?
我們可以通過help參數(shù)傳入我們希望打印出來的提示語,這樣方便使用者在使用的時候了解參數(shù)的情況。
比如我們把這行語句改成:
parser.add_argument(’-test’, ’--test’, help=’just for help’)
這樣當(dāng)我們運(yùn)行的時候,就會看到提示語了:
默認(rèn)值
如果參數(shù)很多的時候,我們有時候可能不希望每一個都指定一個值,而是希望可以在不填的時候有一個默認(rèn)值。這個想法非常正常,想要做到這點也很簡單,我們可以通過default參數(shù)來指定。
import argparseparser = argparse.ArgumentParser('For test the parser')parser.add_argument(’-test’, ’--test’, default=1, help=’just for help’)args = parser.parse_args()print(args.test)
比如這樣我們在代碼當(dāng)中把test參數(shù)的默認(rèn)值設(shè)置成了1,當(dāng)我們運(yùn)行的時候,如果不填test這個參數(shù)的話,那么程序就會使用它的默認(rèn)值也就是1。
但有一點默認(rèn)值的信息并不會print在help當(dāng)中,所以我們需要自己在提示語當(dāng)中告知使用者默認(rèn)值是多少。
type
我們可以定義參數(shù)的默認(rèn)值,當(dāng)然也可以定義它的類型。
因為命令行傳入的參數(shù)默認(rèn)都是字符串,如果我們要進(jìn)行數(shù)學(xué)上的計算,使用str還需要自己轉(zhuǎn)換,這就很不方便。我們可以在傳入?yún)?shù)的時候就完成類型的匹配,這樣如果傳入?yún)?shù)的類型不對, 那么直接報錯,不往下運(yùn)行。
想要做到這點也很簡單,通過type參數(shù)就可以實現(xiàn)。
parser.add_argument(’-test’, ’--test’, default=1, type=int, help=’just for help’)
比如當(dāng)我們定義了一個int型的參數(shù),而傳入的是類型不匹配的話,那么就會引起報錯:
報錯信息當(dāng)中寫得很清楚,我們得到了一個無效的int的值,它是abc。
可選值
它同樣還支持可選值,可選值很好理解,就是我們希望限定傳入?yún)?shù)的范圍僅僅在幾個值當(dāng)中。比如說我們希望傳入的值不是0就是1,或者是在某幾個具體的值當(dāng)中,這個時候我們可以通過choices參數(shù)來實現(xiàn)這一點。
choices參數(shù)傳入的是一個list,也就是我們的限定范圍,只有在這個范圍當(dāng)中的值才被允許。
parser.add_argument(’-test’, ’--test’, default=1, choices=[2, 3, 4], type=int, help=’just for help’)
如果我們運(yùn)行傳入test=1,那么就會引起報錯,告訴我們傳入的值不在choices范圍當(dāng)中。
這是一個挺有意思的例子,仔細(xì)看會發(fā)現(xiàn)我們默認(rèn)值設(shè)置成了1,但是可選值當(dāng)中并沒有1。這也是允許的,默認(rèn)值可以不在可選值范圍內(nèi),但是當(dāng)我們傳入1就會觸發(fā)可選值校驗。
action
action是一個很神奇也很有用的操作,可以指定參數(shù)的處理方式。我們默認(rèn)的方式是store,也就是存儲的意思,這個我們都能理解。除此之外,還有store_true,它表示出現(xiàn)則是true,否則是false。
parser.add_argument(’-test’, ’--test’, action=’store_true’, help=’just for help’)
當(dāng)我們把test參數(shù)的定義改成這樣之后,我們來對比一下運(yùn)行的結(jié)果就明白了。
除了store_true之外還有store_const,也就是說出現(xiàn)就指定為一個固定值。
parser.add_argument(’-test’, ’--test’, action=’store_const’, const=23, help=’just for help’)
這樣當(dāng)我們指定-test參數(shù)之后,它會自動被賦值成23。
除了這兩個之外,另外一個很常用的參數(shù)是append,可以將多次出現(xiàn)的同一個參數(shù)自動存入一個list當(dāng)中。
parser.add_argument(’-test’, ’--test’, action=’append’, type=int, help=’just for help’)
nargs
nargs也是一個非常有用的參數(shù),可以對參數(shù)進(jìn)行一些花式操作。nargs的傳入?yún)?shù)有以下幾種,首先是N,也就是一個整數(shù)。代表可以接收N個參數(shù)值,這N個值會被存入一個list當(dāng)中。
parser.add_argument(’-test’, ’--test’, nargs=2, type=int, help=’just for help’)
另外一種傳入的參數(shù)是’+’或者是’*’,它可以將任意多個值存入一個list當(dāng)中。
parser.add_argument(’-test’, ’--test’, nargs=’*’, type=int, help=’just for help’)
總結(jié)
有了parser之后,我們在Python當(dāng)中處理命令行參數(shù)會變得非常簡單,我們可以做各種各樣的定制化操作。除了我們上面介紹的之外,還有一些其他的做法,相對來說不是非常常用,所以就不一一窮盡了,感興趣的同學(xué)可以自行了解一下。
以上就是python 如何利用argparse解析命令行參數(shù)的詳細(xì)內(nèi)容,更多關(guān)于python 解析命令行的資料請關(guān)注好吧啦網(wǎng)其它相關(guān)文章!
相關(guān)文章:
