argparser的使用方法

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

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

一.流程

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

1. 創(chuàng)建 ArgumentParser() 對象

2. 調(diào)用 add_argument() 方法添加參數(shù)

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

二.創(chuàng)建 ArgumentParser() 對象

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

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])

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

四.舉例

舉例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)

結(jié)果為：

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

舉例2

1) 一般形式
但是大多數(shù)情況下，腳本很可能需要多個參數(shù)，而且每次參數(shù)的類型用處各不相同，那么這個時候在參數(shù)前添加標(biāo)簽表明參數(shù)的類型和用途便十分有用，而利用argparse模塊可以很方便得實現(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 --helpusage: 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ù)即可實現(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'])

到此，相信大家對“argparser的使用方法”有了更深的了解，不妨來實際操作一番吧！這里是億速云網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！