原文地址：http://www.cnblogs.com/arkenstone/p/6250782.html

http://blog.csdn.net/WIinter_FDd/article/details/75786410

https://oldpan.me/archives/argparse-python-order-command--------Argparse-parser模塊:python快捷實現命令行操作

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

1. import sys
2. print("Input argument is %s" %(sys.argv[0]))

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

1) 一般形式

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

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

運行python test.py後面跟了--verbose/-v的時候會輸出前者，如果什麽都沒有會輸出後者。如果輸入了--verbose/-v以外的參數則會報錯：unrecognized arguments
稍微提一下，action參數表示值賦予鍵的方式，這裏用到的是bool類型；如果是‘count‘表示將--verbose標簽出現的次數作為verbose的值；‘append‘表示將每次出現的該便簽後的值都存入同一個數組再賦值。（嘛，一般後面兩種用的比較少就不多說了）

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

1. $ python test.py --help
2. usage: test.py [-h] [--verbose]
4. your script description
6. optional arguments:
7. -h, --help show this help message and exit
8. --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相同。

1. parser.add_argument(‘filename‘) # 輸入的第一個參數賦予名為filename的鍵
2. args = parser.parse_args()
3. 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：跟正則表達式的符號用途一致。）比如用：

1. parser.add_argument(‘filename‘)
2. parser.add_argument(‘num‘, nargs=‘*)

就可以運行python test.py text.txt 1 2
由於沒有標簽，所以用位置參數的時候需要比較小心。

4）輸入類型

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

1. import argparse
3. parser = argparse.ArgumentParser(description="your script description")
4. parser.add_argument(‘file‘, type=argparse.FileType(‘r‘)) # 讀取文件
5. args = parser.parse_args()
6. for line in args.file:
7. print (line.strip())

寫文件

1. import argparse
3. parser = argparse.ArgumentParser(description="your script description")
4. parser.add_argument(‘file‘, type=argparse.FileType(‘w‘)) # 寫文件
5. args = parser.parse_args()
6. fp=args.file
7. fp.write(‘123345‘)
8. fp.flush()
9. fp.close()

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

7）使用步驟

1：import argparse

2：parser = argparse.ArgumentParser()

3：parser.add_argument()

4：parser.parse_args()

我們對這四個步驟解釋一下：首先導入該模塊；然後創建一個解析對象；然後向該對象中添加你要關註的命令行參數和選項，每一個add_argument方法對應一個你要關註的參數或選項；最後調用parse_args()方法進行解析；解析成功之後即可使用。

接下來我們來說明一下argparse模塊中最重要的兩個部分：ArgumentParser（）和add_argument()。

1. ArgumentParser(prog=None,usage=None,description=None, epilog=None, parents=[ ]，
2. formatter_class=argparse.HelpFormatter, prefix_chars=’-‘，fromfile_prefix_chars=None,
3. argument_default=None, conflict_handler=’error’，add_help=True）

這些參數都有默認值，當調用parser.print_help()或者運行程序時由於參數不正確(此時python解釋器其實也是調用了pring_help()方法)時，會打印這些描述信息，一般只需要傳遞description參數，如上所示。

下面將對ArgumentParser參數的簡單說明進行中文版本的簡單說明：

1. description - 命令行幫助的開始文字，大部分情況下，我們只會用到這個參數
2. epilog - 命令行幫助的結尾文字
3. prog - (default: sys.argv[0])程序的名字，一般不需要修改，另外，如果你需要在help中使用到程序的名字，可以使用%(prog)s
4. prefix_chars - 命令的前綴，默認是-，例如-f/–file。有些程序可能希望支持/f這樣的選項，可以使用prefix_chars=”/”
5. fromfile_prefix_chars - (default: None)如果你希望命令行參數可以從文件中讀取，就可能用到。例如，如果fromfile_prefix_chars=’@’,命令行參數中有一個為”@args.txt”，args.txt的內容會作為命令行參數
6. add_help - 是否增加-h/-help選項 (default: True)，一般help信息都是必須的，所以不用設置啦。
7. parents - 類型是list，如果這個parser的一些選項跟其他某些parser的選項一樣，可以用parents來實現繼承，例如parents=[parent_parser]
8. 三個允許的值： # class argparse.RawDescriptionHelpFormatter 直接輸出description和epilog的原始形式（不進行自動換行和消除空白的操作） # class argparse.RawTextHelpFormatter 直接輸出description和epilog以及add_argument中的help字符串的原始形式（不進行自動換行和消除空白的操作） # class argparse.ArgumentDefaultsHelpFormatter 在每個選項的幫助信息後面輸出他們對應的缺省值，如果有設置的話。這個最常用吧！
9. argument_default - (default: None)設置一個全局的選項的缺省值，一般每個選項單獨設置，所以這個參數用得少，不細說
10. usage - (default: generated)如果你需要修改usage的信息（usage: PROG [-h] [–foo [FOO]] bar [bar …]），那麽可以修改這個，一般不要修改。
11. conflict_handler - 不建議使用。這個在極端情況下才會用到，主要是定義兩個add_argument中添加的選項的名字發生沖突時怎麽處理，默認處理是拋出異常。

1. add_argument(name or flags…[, action][, nargs][, const][, default][, type][, choices]
2. [, required][, help][, metavar][, dest])

1. name or flags - 指定參數的形式，想寫幾個寫幾個，不過我們一般就寫兩個，一個短參數，一個長參數，看下面的例子”-f”, “–file”
2. 可選的選項，位置不固定，想怎麽寫就怎麽寫，默認是可選的 # parser.add_argument(“-f”, “–file”, help=”test test test”)
3. 位置固定的選項，例如”prog i_am_bar”，這樣子的話，i_am_bar就是bar選項的值啦，默認是必須有的 # parser.add_argument(“bar”, help=”test test test”)
4. nargs - 指定這個參數後面的value有多少個，例如，我們希望使用-n 1 2 3 4，來設置n的值為[1, 2, 3, 4] #parser.add_argument(“-n”, “–num”, nargs=”+”, type=int) # 這裏nargs=”+”表示，如果你指定了-n選項，那麽-n後面至少要跟一個參數，+表示至少一個,?表示一個或0個,*0個或多個 。
5. default - 如果命令行沒有出現這個選項，那麽使用default指定的默認值 #parser.add_argument(“+g”, “++gold”, help=”test test test”,default=”test_gold”)#需要prefix_chars包含”+” 。
6. type - 如果希望傳進來的參數是指定的類型（例如 float, int or file等可以從字符串轉化過來的類型），可以使用 #parser.add_argument(“-x”, type=int) 。
7. choices - 設置參數值的範圍，如果choices中的類型不是字符串，記得指定type哦 #parser.add_argument(“-y”, choices=[‘a’, ‘b’, ‘d’])
8. required - 通常-f這樣的選項是可選的，但是如果required=True那麽就是必須的了 #parser.add_argument(“-z”, choices=[‘a’, ‘b’, ‘d’], required=True)
9. metavar - 參數的名字，在顯示 幫助信息時才用到. # parser.add_argument(“-o”, metavar=”OOOOOO”)
10. help - 設置這個選項的幫助信息
11. dest - 設置這個選項的值就是解析出來後放到哪個屬性中 #parser.add_argument(“-q”, dest=”world”)
12. args = parser.parse_args(args) # 如果你沒有args參數，那麽就使用sys.argv，也就是命令行參數啦。有這個參數，就方便我們調試啊 。# args.world就是-q的值啦
13. action - The basic type of action to be taken when this argument is encountered at the command line.
14. const - A constant value required by some action and nargs selections.

最常用的參數也就是以上這些，如果有更多的需求，那麽可以查看官方的API文檔。

實例

下面我們將用官網的一個實例來進一步認識一下argparse。

1. import argparse
3. parser = argparse.ArgumentParser(description=‘Process some integers.‘)
4. parser.add_argument(‘integers‘, metavar=‘N‘, type=int, nargs=‘+‘,
5. help=‘an integer for the accumulator‘)
6. parser.add_argument(‘--sum‘, dest=‘accumulate‘, action=‘store_const‘,
7. const=sum, default=max,
8. help=‘sum the integers (default: find the max)‘)
10. args = parser.parse_args()
11. print(args.accumulate(args.integers))

1. $ python prog.py -h
2. usage: prog.py [-h] [--sum] N [N ...]
4. Process some integers.
6. positional arguments:
7. N an integer for the accumulator
9. optional arguments:
10. -h, --help show this help message and exit
11. --sum sum the integers (default: find the max)

1. $ python prog.py 1 2 3 4
2. 4
4. $ python prog.py 1 2 3 4 --sum
5. 10

我們下面來看一段代碼：

1. # -*- coding: utf-8 -*-
3. import argparse
5. parser = argparse.ArgumentParser(description=‘Process some integers.‘)
6. parser.add_argument(‘integers‘, metavar=‘N‘, type=int, nargs=‘+‘,
7. help=‘an integer for the accumulator‘)
8. parser.add_argument(‘--sum‘, dest=‘accumulate‘, action=‘store_const‘,
9. const=sum, default=max,
10. help=‘sum the integers (default: find the max)‘)
11. parser.add_argument("--square", help="display a square of a given number",
12. type=int)
14. args = parser.parse_args()
15. print(args.accumulate(args.integers), args.square**2)

在控制臺dos界面下輸入 python prog.py 4 5 6 –square 7

結果： 6 49

在dos窗口下鍵入python prog.py –sum 4 5 6 –square 7，按回車鍵我們來看一下運行結果：

結果：15 49

(轉)Python3 -- argparse模塊