Python进阶话题杂谈(八)argparse模块

argparse模块是Python中最重要的模块之一,其用于命令行参数解析。此模块的内容非常复杂,本文只选取其中较为实用的部分进行讨论。

使用argparse主要分为三个部分,第一部分是创建一个解析器实例:

parser = argparse.ArgumentParser()

第二部分为多次调用add_argument函数添加命令行参数,每一次add_argument函数的调用都对应于一个命令行参数的配置。add_argument函数的主要参数如下:

第一、二位置参数:用于设定一个参数的单横线或双横线参数名,或同时设定这二者。注意,单横线参数名只能使用单个字母,多于一个字母的参数名则必须使用双横线。

以下参数均为add_argument函数的关键字参数:

action:主要用于将普通参数修改为开关参数。当此参数被设定为字符串store_true时,当前命令行参数变为无需参数的开关参数,如果给出此命令行参数,则参数值解析为True,如果不给出,则解析为False。反之,如果action设定为字符串store_false,则开关参数给出时,参数被解析为False,不给出时,才解析为True。

nargs:默认情况下,一个命令行参数只能接一个后续参数值,而如果将nargs设定为字符串星号或加号时,当前参数将自动被解析为列表,且可以在一个命令行参数后给出多个值。星号与加号的区别类似于正则表达式:星号代表能够接受0到任意数量的参数,而加号则表示参数至少需要给出一个。此参数也可给定为一个具体的整数,则参数数量必须严格等于该值。

default:用于设定默认值。当没有为这个命令行参数给出值时,就使用此默认值。

type:给定为一个函数,默认为str。一般可给定为int或float,可将字符串形式的参数通过指定的函数转换为其他类型。

required:默认为False,此时当不给出这个参数时,命令行参数就将被解析为None。而如果指定为True,则该命令行参数必须给出,否则程序将报错。

help:指定为一个帮助字符串。这个字符串将显示在调用-h命令时。

dest:指定为一个变量名,用于后续的parse_args函数。

argparse的第三部分为通过parse_args函数将参数解析。此函数返回一个对象,对此对象进行属性访问即可获取到各个命令行参数。而属性的名称遵循以下规则:如果某个参数定义了dest参数,则使用这个参数作为属性名,如果没有,则使用去掉横线的位置参数名作为属性名,如-i参数就对应于i属性。

以下通过一个完整的函数说明上文的各种用法:

import argparse

def _inputArguments():

   parser = argparse.ArgumentParser()

   parser.add_argument('-a', '--aa',

       help = 'Argument: A')

   parser.add_argument('-b', dest = 'bbb', required = True, nargs = '*',

       help = 'Argument: B')

   parser.add_argument('-c', action = 'store_true',

       help = 'Argument: C')

   parser.add_argument('-d', type = int, default = 1,

       help = 'Argument: D')

   args = parser.parse_args()

   return args.aa, args.bbb, args.c, args.d

print(_inputArguments())

首先,argparse将自动定义-h与—help参数,用于生成帮助信息。而上述代码定义了四个参数,A参数为较普通的参数,通过-a或—aa进行给定。B参数为一个必须给出的不定长参数,给出的各个参数之间以空格隔开即可,如:-b 1 2 3,则此参数就将被解析为:['1', '2', '3']。如果不给出b参数,程序将报错,且由于设定了dest参数,故解析时此参数应使用dest参数所给出的属性名,而不是b。C参数为一个开关参数,如果给出-c,则解析出的args.c为True,否则为False。D参数为一个类型为整形的参数,默认值为1,如果给出D参数,则参数将自动套用int函数转为整数,否则如果不给出此参数,则默认为1。


2018年6月于苏州

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

推荐阅读更多精彩内容