在多個文件或者不同語言協(xié)同的項(xiàng)目中,python腳本經(jīng)常需要從命令行直接讀取參數(shù)。萬能的python就自帶了argprase包?使得這一工作變得簡單而規(guī)范。PS:optparse包是類似的功能,只不過寫起來更麻煩一些。
如果腳本很簡單或臨時使用,沒有多個復(fù)雜的參數(shù)選項(xiàng),可以直接利用sys.argv將腳本后的參數(shù)依次讀取(讀進(jìn)來的默認(rèn)是字符串格式)。比如如下名為test.py的腳本:
import sys print "Input argument is %s" %(sys.argv)
在shell腳本中運(yùn)行python test.py help可以得到Input argument is help的結(jié)果。
1) 一般形式
但是大多數(shù)情況下,腳本很可能需要多個參數(shù),而且每次參數(shù)的類型用處各不相同,那么這個時候在參數(shù)前添加標(biāo)簽表明參數(shù)的類型和用途便十分有用,而利用argparse模塊可以很方便得實(shí)現(xiàn)這一目的。
同樣用名為test.py的腳本舉個栗子:
import argparse parser = argparse.ArgumentParser(description="your script description") # description參數(shù)可以用于插入描述腳本用途的信息,可以為空 parser.add_argument('--verbose', '-v', action='store_true', help='verbose mode') # 添加--verbose標(biāo)簽,標(biāo)簽別名可以為-v,這里action的意思是當(dāng)讀取的參數(shù)中出現(xiàn)--verbose/-v的時候 # 參數(shù)字典的verbose建對應(yīng)的值為True,而help參數(shù)用于描述--verbose參數(shù)的用途或意義。 args = parser.parse_args() # 將變量以標(biāo)簽-值的字典形式存入args字典 if args.verbose: print "Verbose mode on!" else: print "Verbose mode off!"
運(yùn)行
python test.py
后面跟了--verbose/-v的時候會輸出前者,如果什么都沒有會輸出后者。如果輸入了--verbose/-v以外的參數(shù)則會報錯:unrecognized arguments
稍微提一下,action參數(shù)表示值賦予鍵的方式,這里用到的是bool類型;如果是'count'表示將--verbose標(biāo)簽出現(xiàn)的次數(shù)作為verbose的值;'append'表示將每次出現(xiàn)的該便簽后的值都存入同一個數(shù)組再賦值。(嘛,一般后面兩種用的比較少就不多說了)
PS:--help標(biāo)簽在使用argparse模塊時會自動創(chuàng)建,因此一般情況不需要我們主動定義幫助信息。
$ python test.py --help usage: test.py [-h] [--verbose] your script description optional arguments: -h, --help show this help message and exit --verbose, -v verbose mode
2) 必需參數(shù)
這種模式用于確保某些必需的參數(shù)有輸入。
parser.add_argument('--verbose', required=True, type=int)
required標(biāo)簽就是說--verbose參數(shù)是必需的,并且類型為int,輸入別的類型會報錯。
3)位置參數(shù)(positional arguments)
位置參數(shù)與sys.argv調(diào)用比較像,參數(shù)沒有顯式的--xxx或者-xxx標(biāo)簽,因此調(diào)用屬性也與sys.argv相同。
parser.add_argument('filename') # 輸入的第一個參數(shù)賦予名為filename的鍵 args = parser.parse_args() print "Read in %s" %(args.filename)
輸入
python test.py test.txt
則會輸出
Read in test.txt
此外,可以用nargs參數(shù)來限定輸入的位置參數(shù)的個數(shù),默認(rèn)為1。當(dāng)然nargs參數(shù)也可用于普通帶標(biāo)簽的參數(shù)。
parser.add_argument('num', nargs=2, type=int)
表示腳本可以讀入兩個整數(shù)賦予num鍵(此時的值為2個整數(shù)的數(shù)組)。nargs還可以'*'用來表示如果有該位置參數(shù)輸入的話,之后所有的輸入都將作為該位置參數(shù)的值;‘+'表示讀取至少1個該位置參數(shù)。'?'表示該位置參數(shù)要么沒有,要么就只要一個。(PS:跟正則表達(dá)式的符號用途一致。)比如用:
parser.add_argument('filename') parser.add_argument('num', nargs='*)
就可以運(yùn)行python test.py text.txt 1 2
由于沒有標(biāo)簽,所以用位置參數(shù)的時候需要比較小心。
4)輸入類型
之前已經(jīng)提到了用type參數(shù)就可以指定輸入的參數(shù)類型。而這個type類型還可以表示文件操作的類型從而直接進(jìn)行文件的讀寫操作。
parser.add_argument('file', type=argparser.FileType('r')) # 讀取文件 args = parser.parse_args() for line in args.file: print line.strip()
5)參數(shù)默認(rèn)值
一般情況下會設(shè)置一些默認(rèn)參數(shù)從而不需要每次輸入某些不需要變動的參數(shù),利用default參數(shù)即可實(shí)現(xiàn)。
parser.add_argument('filename', default='text.txt')
這個時候至直接運(yùn)行
python text.py
就能得到
Read in text.txt
而不需要輸入文件名了。
6)候選參數(shù)選擇
表示該參數(shù)能接受的值只能來自某幾個值候選值中,除此以外會報錯,用choices參數(shù)即可。比如:
parser.add_argument('filename', choices=['test1.txt', 'text2.txt'])
參考:https://mkaz.tech/python-argparse-cookbook.html
https://docs.python.org/2/howto/argparse.html
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
更多文章、技術(shù)交流、商務(wù)合作、聯(lián)系博主
微信掃碼或搜索:z360901061

微信掃一掃加我為好友
QQ號聯(lián)系: 360901061
您的支持是博主寫作最大的動力,如果您喜歡我的文章,感覺我的文章對您有幫助,請用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點(diǎn)擊下面給點(diǎn)支持吧,站長非常感激您!手機(jī)微信長按不能支付解決辦法:請將微信支付二維碼保存到相冊,切換到微信,然后點(diǎn)擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對您有幫助就好】元
