python模块之Argparse

背景

Argparse 顾名思义参数解析器,是命令行运行 python 文件时解析参数的模块,多用在需要多次修改代码参数的时候。比如 batch_sizeepoch 等,那么使用该模块将无比简单。

基本结构

假设 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 创建一个 ArgumentParser 对象,主要使用 description 参数,目的是在命令行运

行时使用 -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() 方法添加需要的一些参数。

该方法本身共包含11个参数,下面只展开几个常用的:

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
    要添加参数的默认值,比如命令行中省略 -p 时,默认 args.path 值是 data\

  • type
    要添加参数的类型,默认为 str 类型。若需要布尔类型或者浮点型,设成 boolfloat

  • required
    命令行中是否必须使用该参数,默认为 False 。若设 required=True ,就算有默认值,没有使用也会报错。

  • help
    要添加参数的一个简单描述,忘了这个参数有什么用时可以查看。

  • dest
    要添加参数的名字,默认为 -- 或者 - ,用法在第三步。

第三步

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

通过 parse_args() 方法调用已经定义的参数,然后通过 args.'dest' 获得添加的参数值。

Reference

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,525评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,203评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,862评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,728评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,743评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,590评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,330评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,244评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,693评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,885评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,001评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,723评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,343评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,919评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,042评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,191评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,955评论 2 355

推荐阅读更多精彩内容