argparser的使用方法

本篇內容主要講解“argparser的使用方法”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“argparser的使用方法”吧!

通過命令行運行Python腳本時，可以通過ArgumentParser來高效地接受并解析命令行參數。

一.流程

使用argparse 配置命令行參數時，需要三步：

1. 創建 ArgumentParser() 對象

2. 調用 add_argument() 方法添加參數

3. 使用 parse_args() 解析添加的參數

二.創建 ArgumentParser() 對象

新建一個ArgumentParser類對象，然后來添加若干個參數選項，最后通過parse_args()方法解析并獲得命令行傳來的參數。

parser = argparse.ArgumentParser()

    parser.add_argument("-p", "--port",
        dest='port',
        default="/dev/ttyUSB0",
        help="serial port where the MCU is connected to.)

    parser.add_argument("-v", "--version",
        dest='version',
        action='store_true',
        help="show the version number of this program and exit.")

    args = parser.parse_args()

三. ArgumentParser對象add_argument()方法

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

參數：
    name or flags：傳遞給add_argument() 的第一個參數因此必須是一個標記序列或者一個簡單的參數名字
    action：指出應該如何處理命令行參數（支持的操作：’store’ ，’store_const’，’store_true’，’store_false’，’append’，’append_const’，’count’，’help’，’version’）
    nargs：將一個動作與不同數目的命令行參數關聯在一起（支持的值：N,’?’,’*’,’+’）
    const：用于保存常量值，它們不是從命令行讀入但是是ArgumentParser 的動作所要求的
    default：其默認值為None，指出如果命令行參數沒有出現時它們應該是什么值
    type：允許任意必要的類型檢查并作類型轉換
    choices：某些命令行參數應該從一個受限的集合中選擇
    required：如果要使得選項是必需的，可以指定True作為required=關鍵字參數的值給add_argument()
    help：包含參數簡短描述的字符串
    metavar：默認情況下，對于位置參數直接使用dest的值，對于可選參數則將dest的值變為大寫。注意metavar只會改變顯示出來的名字parse_args() 對象中屬性的名字仍然由dest的值決定。
    dest：對于位置參數的動作，dest 通常作為第一個參數提供給add_argument()，對于可選參數的動作，dest的動作通常從選項字符串推導出來，如：ArgumentParser生成的dest的值是將第一個長的選項字符串前面的–字符串去掉。如果沒有提供長選項字符串，dest的獲得則是將第一個短選項字符串前面的-字符去掉。任何內部的-將被轉換為字符以確保字符串是合法的屬性名字。（即對于可選參數，先找長的選項字符串，再找短選項字符串，并且內部的-會被轉換為字符。）

四.舉例

舉例1

import argparse
 
parser = argparse.ArgumentParser()
parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version or not.')
parser.add_argument('--seed', type=int, default=72, help='Random seed.')
parser.add_argument('--epochs', type=int, default=10000, help='Number of epochs to train.')
 
args = parser.parse_args()
 
print(args.sparse)
print(args.seed)
print(args.epochs)

結果為：

/home/user/anaconda3/bin/python3.6 /home/user/lly/pyGAT-master/test.py
False
72
10000
 
Process finished with exit code 0

舉例2

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 --helpusage: 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'])

到此，相信大家對“argparser的使用方法”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！