Python解析命令行讀取參數之argparse模塊

在多個文件或者不同語言協同的項目中，python腳本經常需要從命令行直接讀取參數。萬能的python就自帶了argprase包 使得這一工作變得簡單而規范。PS：optparse包是類似的功能，只不過寫起來更麻煩一些。

如果腳本很簡單或臨時使用，沒有多個復雜的參數選項，可以直接利用sys.argv將腳本后的參數依次讀取(讀進來的默認是字符串格式)。比如如下名為test.py的腳本：

import sys
print "Input argument is %s" %(sys.argv)

在shell腳本中運行python test.py help可以得到Input argument is help的結果。

1) 一般形式

但是大多數情況下，腳本很可能需要多個參數，而且每次參數的類型用處各不相同，那么這個時候在參數前添加標簽表明參數的類型和用途便十分有用，而利用argparse模塊可以很方便得實現這一目的。

同樣用名為test.py的腳本舉個栗子：

import argparse

parser = argparse.ArgumentParser(description="your script description")   # description參數可以用于插入描述腳本用途的信息，可以為空
parser.add_argument('--verbose', '-v', action='store_true', help='verbose mode') # 添加--verbose標簽，標簽別名可以為-v，這里action的意思是當讀取的參數中出現--verbose/-v的時候
                     # 參數字典的verbose建對應的值為True，而help參數用于描述--verbose參數的用途或意義。
args = parser.parse_args()               # 將變量以標簽-值的字典形式存入args字典
if args.verbose:
 print "Verbose mode on!"
else:
 print "Verbose mode off!"

運行python test.py后面跟了--verbose/-v的時候會輸出前者，如果什么都沒有會輸出后者。如果輸入了--verbose/-v以外的參數則會報錯：unrecognized arguments

稍微提一下，action參數表示值賦予鍵的方式，這里用到的是bool類型；如果是'count'表示將--verbose標簽出現的次數作為verbose的值；'append'表示將每次出現的該便簽后的值都存入同一個數組再賦值。（嘛，一般后面兩種用的比較少就不多說了）

PS：--help標簽在使用argparse模塊時會自動創建，因此一般情況不需要我們主動定義幫助信息。

$ 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) 必需參數

這種模式用于確保某些必需的參數有輸入。

parser.add_argument('--verbose', required=True, type=int)

required標簽就是說--verbose參數是必需的，并且類型為int，輸入別的類型會報錯。

3）位置參數（positional arguments）

位置參數與sys.argv調用比較像，參數沒有顯式的--xxx或者-xxx標簽，因此調用屬性也與sys.argv相同。

parser.add_argument('filename') # 輸入的第一個參數賦予名為filename的鍵
args = parser.parse_args()
print "Read in %s" %(args.filename)

輸入python test.py test.txt則會輸出Read in test.txt

此外，可以用nargs參數來限定輸入的位置參數的個數，默認為1。當然nargs參數也可用于普通帶標簽的參數。
parser.add_argument('num', nargs=2, type=int)表示腳本可以讀入兩個整數賦予num鍵（此時的值為2個整數的數組）。nargs還可以'*'用來表示如果有該位置參數輸入的話，之后所有的輸入都將作為該位置參數的值；‘+'表示讀取至少1個該位置參數。'?'表示該位置參數要么沒有，要么就只要一個。（PS：跟正則表達式的符號用途一致。）比如用：

parser.add_argument('filename')
parser.add_argument('num', nargs='*)

就可以運行python test.py text.txt 1 2

由于沒有標簽，所以用位置參數的時候需要比較小心。

4）輸入類型

之前已經提到了用type參數就可以指定輸入的參數類型。而這個type類型還可以表示文件操作的類型從而直接進行文件的讀寫操作。

parser.add_argument('file', type=argparser.FileType('r')) # 讀取文件
args = parser.parse_args()
for line in args.file:
 print line.strip()

5）參數默認值

一般情況下會設置一些默認參數從而不需要每次輸入某些不需要變動的參數，利用default參數即可實現。

parser.add_argument('filename', default='text.txt')

這個時候至直接運行python text.py就能得到Read in text.txt而不需要輸入文件名了。

6）候選參數選擇

表示該參數能接受的值只能來自某幾個值候選值中，除此以外會報錯，用choices參數即可。比如：

parser.add_argument('filename', choices=['test1.txt', 'text2.txt'])

參考：https://mkaz.tech/python-argparse-cookbook.html
https://docs.python.org/2/howto/argparse.html

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。