Python parser.add_argument

1.Python解析參數(shù)

import argparse

parser = argparse.ArgumentParser(description = 'TEST')
parser.add_argument ('--start-epoch', default = 0, type = int, help = 'please input number')

def main():
? ? global args
? ? args = parser.parse_args()

? ? print(args)
? ? print(args.start_epoch)

if __name__ == '__main__':
? ? main()

注：在參數(shù)解析時(shí)，參數(shù)中并不區(qū)分字符‘-’和‘_’；如上所述，在添加是使用的是’–start-epoch’，但是在解析時(shí)使用的是args.start_epoch。

2.parser.add_argument參數(shù)action

在使用parser進(jìn)行傳參時(shí)，遇到參數(shù)action，一直不得其解，終有所獲，解釋如下：

parser.add_argument(‘--is_train', action='store_true', default=False)

其中“–is_train”參數(shù)在調(diào)用時(shí)，如下：

python demo1.py ?? ??? ??? ??? ??? ??? ?#無(wú)參數(shù)傳入時(shí)，使用默認(rèn)值False?
python demo1.py --is_train ?? ??? ?#當(dāng)使用此參數(shù)時(shí)，表示該參數(shù)是True, 注意在這里并沒(méi)有對(duì)其賦值，
?? ??? ??? ??? ??? ??? ??? ??? ??? ??? ??? ??? ??? ?#其作用是作為開(kāi)關(guān)使用，來(lái)控制action動(dòng)作

Python parser.add_argument函數(shù)及sys.argv[]

1.argparse

argparse 模塊是 Python 內(nèi)置的一個(gè)用于命令項(xiàng)選項(xiàng)與參數(shù)解析的模塊，argparse 模塊可以讓人輕松編寫(xiě)用戶友好的命令行接口。

通過(guò)在程序中定義好我們需要的參數(shù)，然后 argparse 將會(huì)從 sys.argv 解析出這些參數(shù)。

argparse 模塊還會(huì)自動(dòng)生成幫助和使用手冊(cè)，并在用戶給程序傳入無(wú)效參數(shù)時(shí)報(bào)出錯(cuò)誤信息。

2.步驟

1、創(chuàng)建一個(gè)解析器——創(chuàng)建 ArgumentParser() 對(duì)象

parser = argparse.ArgumentParser(description='PyTorch ImageNet Training')

變量名為parser，ArgumentParser 對(duì)象包含將命令行解析成 Python 數(shù)據(jù)類型所需的全部信息。

關(guān)鍵詞description：

description= '關(guān)鍵字參數(shù)'

這個(gè)參數(shù)簡(jiǎn)要描述這個(gè)程度做什么以及怎么做。在幫助消息中，這個(gè)描述會(huì)顯示在命令行用法字符串和各種參數(shù)的幫助消息之間。

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

調(diào)用 add_argument() 給程序添加參數(shù)信息。這些調(diào)用指定 ArgumentParser 如何獲取命令行字符串并將其轉(zhuǎn)換為對(duì)象。

常用的有，

parser.add_argument('data', metavar='DIR',help='path to dataset') ?# 設(shè)置數(shù)據(jù)路徑
parser.add_argument('--epochs', default=200, type=int, metavar='N', ?# 訓(xùn)練循環(huán)最高次數(shù)
? ? ? ? ? ? ? ? ? ? help='number of total epochs to run')
parser.add_argument('--lr', '--learning-rate', default=0.03, type=float, ?# 學(xué)習(xí)率
? ? ? ? ? ? ? ? ? ? metavar='LR', help='initial learning rate', dest='lr')
parser.add_argument('--seed', default=None, type=int,
? ? ? ? ? ? ? ? ? ? help='seed for initializing training. ') ?# 用于指定隨機(jī)數(shù)生成時(shí)所用算法開(kāi)始的整數(shù)值

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

ArgumentParser 通過(guò) parse_args() 方法解析參數(shù)。它將檢查命令行，把每個(gè)參數(shù)轉(zhuǎn)換為適當(dāng)?shù)念愋腿缓笳{(diào)用相應(yīng)的操作。

在大多數(shù)情況下，這意味著一個(gè)簡(jiǎn)單的 Namespace 對(duì)象將從命令行解析出的屬性構(gòu)建。

args = parser.parse_args()

3.add_argument() 命令行參數(shù)

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

每個(gè)參數(shù)解釋如下:

• name or flags - 選項(xiàng)字符串的名字或者列表，例如 foo 或者 -f, --foo。
• action - 命令行遇到參數(shù)時(shí)的動(dòng)作，默認(rèn)值是 store。
• store_const，表示賦值為const；
• append，將遇到的值存儲(chǔ)成列表，也就是如果參數(shù)重復(fù)則會(huì)保存多個(gè)值;
• append_const，將參數(shù)規(guī)范中定義的一個(gè)值保存到一個(gè)列表；
• count，存儲(chǔ)遇到的次數(shù)；此外，也可以繼承 argparse.Action 自定義參數(shù)解析；
• nargs - 應(yīng)該讀取的命令行參數(shù)個(gè)數(shù)，可以是具體的數(shù)字，或者是?號(hào)，當(dāng)不指定值時(shí)對(duì)于 Positional argument 使用 default，對(duì)于 Optional argument 使用 const；或者是 * 號(hào)，表示 0 或多個(gè)參數(shù)；或者是 + 號(hào)表示 1 或多個(gè)參數(shù)。
• default - 不指定參數(shù)時(shí)的默認(rèn)值。
• type - 命令行參數(shù)應(yīng)該被轉(zhuǎn)換成的類型。
• choices - 參數(shù)可允許的值的一個(gè)容器。
• required - 可選參數(shù)是否可以省略 (僅針對(duì)可選參數(shù))。
• help - 參數(shù)的幫助信息，當(dāng)指定為 argparse.SUPPRESS 時(shí)表示不顯示該參數(shù)的幫助信息.
• metavar - 在 usage 說(shuō)明中的參數(shù)名稱，對(duì)于必選參數(shù)默認(rèn)就是參數(shù)名稱，對(duì)于可選參數(shù)默認(rèn)是全大寫(xiě)的參數(shù)名稱。用來(lái)控制部分命令行參數(shù)的顯示，注意：它只是影響部分參數(shù)的顯示信息，不影響代碼內(nèi)部獲取命令行參數(shù)的對(duì)象。
• dest - 解析后的參數(shù)名稱，默認(rèn)情況下，對(duì)于可選參數(shù)選取最長(zhǎng)的名稱，中劃線轉(zhuǎn)換為下劃線.

4.sys.argv[]

是一個(gè)從程序外部獲取參數(shù)的橋梁，獲得的是一個(gè)列表（list)，其第一個(gè)元素是程序本身，隨后才依次是外部給予的參數(shù)。

sys.argv[0]

對(duì)應(yīng)的是程序本身，即xxx.py，xxx表示程序的名稱。

sys.argv[1]

表示命令行外部輸入的第一個(gè)參數(shù)。

sys.argv[1:]

表示遍歷外部輸入?yún)?shù)的所有。

總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論