python3.x中argparse模組詳解

sys.argv           #命令列引數List，第一個元素是程式本身路徑
sys.exit(n)        #退出程式，正常退出時exit(0)
sys.version        #獲取Python解釋程式的版本資訊
sys.maxint       #  最大的Int值
sys.path           #返回模組的搜尋路徑，初始化時使用PYTHONPATH環境變數的值
sys.platform       #返回作業系統平臺名稱
sys.stdin          #輸入相關
sys.stdout         #輸出相關
sys.stderror       #錯誤相關
   

   

  #### sys.argv練習
  import sys
  for i in sys.argv:
      print(i)

#if name == ‘main’:
# for item in sys.argv:
# print item

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

argparse模組

作用： argparse 是 Python 內建的一個用於命令項選項與引數解析的模組，通過在程式中定義好我們需要的引數，argparse 將會從 sys.argv 中解析出這些引數，並自動生成幫助和使用資訊。當然，Python 也有第三方的庫可用於命令列解析，而且功能也更加強大，比如 docopt，Click。

1. 命令列引數分為位置引數和選項引數：

• 位置引數就是程式根據該引數出現的位置來確定的
  • 如：[root@openstack_1 /]# ls root/ #其中root/是位置引數
• 選項引數是應用程式已經提前定義好的引數，不是隨意指定的
  • 如：[root@openstack_1 /]# ls -l # -l 就是ls命令裡的一個選項引數

2. 使用步驟：

（1）import argparse 首先匯入模組
（2）parser = argparse.ArgumentParser（） 建立一個解析物件
（3）parser.add_argument() 向該物件中新增你要關注的命令列引數和選項
（4）parser.parse_args() 進行解析

3. argparse.ArgumentParser（）方法引數須知：一般我們只選擇用description

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中新增的選項的名字發生衝突時怎麼處理，預設處理是丟擲異常。

4. add_argument()方法引數須知：

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.

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('echo')     # add_argument()指定程式可以接受的命令列選項
args = parser.parse_args()      # parse_args()從指定的選項中返回一些資料
print(args)
print(args.echo)

 

 

• 1
• 2
• 3
• 4
• 5
• 6

parser = argparse.ArgumentParser(description = 'this is a description')
parser.add_argument('--ver', '-v', action = 'store_true', help = 'hahaha')
# 將變數以標籤-值的字典形式存入args字典
args = parser.parse_args()
if args.ver:
    print("Ture")
else:
    print("False")

 

 

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

# required標籤就是說--ver引數是必需的，並且型別為int，輸入其它型別會報錯
parser.add_argument('--ver', '-v', required = True, type = int)

 

 

• 1
• 2

parser.add_argument('file', choices = ['test1', 'test2'])
args = parser.parse_args()
print('read in %s'%(args.file))

 

 

• 1
• 2
• 3

# 表示指令碼可以讀入兩個整數賦予num鍵（此時的值為2個整數的陣列）
parser.add_argument('filename', nargs = 2, type = int)
args = parser.parse_args()
print('read in %s'%(args.filename))

 

 

• 1
• 2
• 3
• 4

分析：nargs還可以’*‘用來表示如果有該位置引數輸入的話，之後所有的輸入都將作為該位置引數的值；‘+’表示讀取至少1個該位置引數。’?'表示該位置引數要麼沒有，要麼就只要一個。（PS：跟正規表示式的符號用途一致。）
如：

parser.add_argument('filename', nargs = '+', type = int)
args = parser.parse_args()
print('read in %s'%(args.filename))

 

 

• 1
• 2
• 3

dest - 設定這個選項的value解析出來後放到哪個屬性中

parser.add_argument('-file', choices = ['test1', 'test2'], dest = 'world')
args = parser.parse_args()
print('read in %s'%(args.world))

 

 

• 1
• 2
• 3

add

如果指令碼很簡單或臨時使用，沒有多個複雜的引數選項，可以直接利用sys.argv將指令碼後的引數依次讀取(讀進來的預設是字串格式)。比如如下名為test.py的指令碼：

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

 

 

• 1
• 2

在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!”

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10

執行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

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

2. 必需引數
   這種模式用於確保某些必需的引數有輸入。

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

 

 

• 1

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)

 

 

• 1
• 2
• 3

輸入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='*)

 

 

• 1
• 2

就可以執行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()

 

 

• 1
• 2
• 3
• 4

5）引數預設值
一般情況下會設定一些預設引數從而不需要每次輸入某些不需要變動的引數，利用default引數即可實現。

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

 

 

• 1

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

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

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

 

 

• 1

action引數
argparse內建6種動作可以在解析到一個引數時進行觸發：

store 儲存引數值，可能會先將引數值轉換成另一個資料型別。若沒有顯式指定動作，則預設為該動作。

store_const 儲存一個被定義為引數規格一部分的值，而不是一個來自引數解析而來的值。這通常用於實現非布林值的命令列標記。

store_ture/store_false 儲存相應的布林值。這兩個動作被用於實現布林開關。

append 將值儲存到一個列表中。若引數重複出現，則儲存多個值。

append_const 將一個定義在引數規格中的值儲存到一個列表中。

version 列印關於程式的版本資訊，然後退出

import argparse

parser = argparse.ArgumentParser()

parser.add_argument(’-s’, action=‘store’, dest=‘simple_value’,
help=‘Store a simple value’)

parser.add_argument(’-c’, action=‘store_const’, dest=‘constant_value’,
const=‘value-to-store’,
help=‘Store a constant value’)

parser.add_argument(’-t’, action=‘store_true’, default=False,
dest=‘boolean_switch’,
help=‘Set a switch to true’)
parser.add_argument(’-f’, action=‘store_false’, default=False,
dest=‘boolean_switch’,
help=‘Set a switch to false’)

parser.add_argument(’-a’, action=‘append’, dest=‘collection’,
default=[],
help=‘Add repeated values to a list’)

parser.add_argument(’-A’, action=‘append_const’, dest=‘const_collection’,
const=‘value-1-to-append’,
default=[],
help=‘Add different values to list’)
parser.add_argument(’-B’, action=‘append_const’, dest=‘const_collection’,
const=‘value-2-to-append’,
help=‘Add different values to list’)

parser.add_argument(’–version’, action=‘version’, version=’%(prog)s 1.0’)

results = parser.parse_args()
print ‘simple_value =’, results.simple_value
print ‘constant_value =’, results.constant_value
print ‘boolean_switch =’, results.boolean_switch
print ‘collection =’, results.collection
print ‘const_collection =’, results.const_collection

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39

$ python argparse_action.py -h

usage: argparse_action.py [-h] [-s SIMPLE_VALUE] [-c] [-t] [-f]
[-a COLLECTION] [-A] [-B] [–version]

optional arguments:
-h, --help show this help message and exit
-s SIMPLE_VALUE Store a simple value
-c Store a constant value
-t Set a switch to true
-f Set a switch to false
-a COLLECTION Add repeated values to a list
-A Add different values to list
-B Add different values to list
–version show program’s version number and exit

$ python argparse_action.py -s value

simple_value = value
constant_value = None
boolean_switch = False
collection = []
const_collection = []

$ python argparse_action.py -c

simple_value = None
constant_value = value-to-store
boolean_switch = False
collection = []
const_collection = []

$ python argparse_action.py -t

simple_value = None
constant_value = None
boolean_switch = True
collection = []
const_collection = []

$ python argparse_action.py -f

simple_value = None
constant_value = None
boolean_switch = False
collection = []
const_collection = []

$ python argparse_action.py -a one -a two -a three

simple_value = None
constant_value = None
boolean_switch = False
collection = [‘one’, ‘two’, ‘three’]
const_collection = []

$ python argparse_action.py -B -A

simple_value = None
constant_value = None
boolean_switch = False
collection = []
const_collection = [‘value-2-to-append’, ‘value-1-to-append’]

$ python argparse_action.py --version

argparse_action.py 1.0

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44
• 45
• 46
• 47
• 48
• 49
• 50
• 51
• 52
• 53
• 54
• 55
• 56
• 57
• 58
• 59
• 60
• 61
• 62
• 63
• 64
• 65
• 66
• 67
• 68

參考

1. https://mkaz.tech/python-argparse-cookbook.html
2. https://docs.python.org/2/howto/argparse.html