python模塊之Argparse

背景

Argparse 顧名思義參數(shù)解析器嚣伐,是命令行運行 python 文件時解析參數(shù)的模塊,多用在需要多次修改代碼參數(shù)的時候萍丐。比如 batch_size 轩端、epoch 等,那么使用該模塊將無比簡單逝变。

基本結構

假設 python 文件名為 :test.py 基茵。

import argparse

parser = argparse.ArgumentParser(description="Demo of argparse.")

parser.add_argument('--batch_size', default=32, help='nums of a batch data')
parser.add_argument('-p', dest='path', default='data/', help='the path of data')
parser.add_argument('-m', '--model', default='train', help='train or eval')

args = parser.parse_args()

print(args)

命令行運行時輸入:

python test.py [--batch_size [128]] [-p [save/]] [-m [train]]

使用詳解

第一步

parser = argparse.ArgumentParser(description='Demo of argparse')

使用 argparse 創(chuàng)建一個 ArgumentParser 對象,主要使用 description 參數(shù)壳影,目的是在命令行運

行時使用 -h 顯示程序的一個自定義簡單描述拱层。像這樣:

E:\> python test.py -h
usage: test.py [-h] [--batch_size BATCH_SIZE] [-p PATH] [-m MODEL]

Demo of argparse.

optional arguments:
  -h, --help            show this help message and exit
  --batch_size BATCH_SIZE
                        nums of a batch data
  -p P ATH                 the path of data
  -m MODEL, --model MODEL
                        train or eval

第二步

parser.add_argument('-m', '--model', default='train', help='train or eval')

通過 add_argument() 方法添加需要的一些參數(shù)。

該方法本身共包含11個參數(shù)宴咧,下面只展開幾個常用的:

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

    nameflags 分別以可以 --- 開頭根灯,兩者可以都設置,也可以只設置其中一個。從第一步

    的運行結果可以看到若同時定義了這兩個烙肺,會以 - 為主芥驳,但是命令行運行時兩者都可以用。

    比如:

    python test.py [--batch_size [128]] [-p [save/]] -m train
    

    或者

    python test.py [--batch_size [128]] [-p [save/]] --model train
    
  • default
    要添加參數(shù)的默認值茬高,比如命令行中省略 -p 時兆旬,默認 args.path 值是 data\

  • type
    要添加參數(shù)的類型怎栽,默認為 str 類型丽猬。若需要布爾類型或者浮點型,設成 boolfloat 熏瞄。

  • required
    命令行中是否必須使用該參數(shù)脚祟,默認為 False 。若設 required=True 强饮,就算有默認值由桌,沒有使用也會報錯。

  • help
    要添加參數(shù)的一個簡單描述邮丰,忘了這個參數(shù)有什么用時可以查看行您。

  • dest
    要添加參數(shù)的名字,默認為 -- 或者 - 剪廉,用法在第三步娃循。

第三步

args = parser.parse_args()
path = args.path

通過 parse_args() 方法調用已經(jīng)定義的參數(shù),然后通過 args.'dest' 獲得添加的參數(shù)值斗蒋。

Reference

argparse—Parser for command-line options, arguments and sub-commands

?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末捌斧,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子泉沾,更是在濱河造成了極大的恐慌捞蚂,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,406評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件跷究,死亡現(xiàn)場離奇詭異姓迅,居然都是意外死亡,警方通過查閱死者的電腦和手機揭朝,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評論 3 393
  • 文/潘曉璐 我一進店門队贱,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人潭袱,你說我怎么就攤上這事柱嫌。” “怎么了屯换?”我有些...
    開封第一講書人閱讀 163,711評論 0 353
  • 文/不壞的土叔 我叫張陵编丘,是天一觀的道長与学。 經(jīng)常有香客問我柴淘,道長幌衣,這世上最難降的妖魔是什么剑令? 我笑而不...
    開封第一講書人閱讀 58,380評論 1 293
  • 正文 為了忘掉前任辆童,我火速辦了婚禮,結果婚禮上亏推,老公的妹妹穿的比我還像新娘呻顽。我一直安慰自己茧痕,他們只是感情好敞斋,可當我...
    茶點故事閱讀 67,432評論 6 392
  • 文/花漫 我一把揭開白布截汪。 她就那樣靜靜地躺著,像睡著了一般植捎。 火紅的嫁衣襯著肌膚如雪衙解。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,301評論 1 301
  • 那天焰枢,我揣著相機與錄音蚓峦,去河邊找鬼。 笑死济锄,一個胖子當著我的面吹牛暑椰,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播拟淮,決...
    沈念sama閱讀 40,145評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼干茉,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了很泊?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,008評論 0 276
  • 序言:老撾萬榮一對情侶失蹤沾谓,失蹤者是張志新(化名)和其女友劉穎委造,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體均驶,經(jīng)...
    沈念sama閱讀 45,443評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡昏兆,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,649評論 3 334
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了妇穴。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片爬虱。...
    茶點故事閱讀 39,795評論 1 347
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖腾它,靈堂內(nèi)的尸體忽然破棺而出跑筝,到底是詐尸還是另有隱情,我是刑警寧澤瞒滴,帶...
    沈念sama閱讀 35,501評論 5 345
  • 正文 年R本政府宣布曲梗,位于F島的核電站赞警,受9級特大地震影響,放射性物質發(fā)生泄漏虏两。R本人自食惡果不足惜愧旦,卻給世界環(huán)境...
    茶點故事閱讀 41,119評論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望定罢。 院中可真熱鬧笤虫,春花似錦、人聲如沸祖凫。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,731評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽蝙场。三九已至凌停,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間售滤,已是汗流浹背罚拟。 一陣腳步聲響...
    開封第一講書人閱讀 32,865評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留完箩,地道東北人赐俗。 一個月前我還...
    沈念sama閱讀 47,899評論 2 370
  • 正文 我出身青樓,卻偏偏與公主長得像弊知,于是被迫代替她去往敵國和親阻逮。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,724評論 2 354

推薦閱讀更多精彩內(nèi)容