python命令行参数解析库

简介

最近公司项目需要加个小功能,就是python程序运行的时候可以通过命令行输入参数,增加某些选项可配置的功能。在开发过程中,如果遇到希望能够增加命令行参数这种需求,python提供了对应的库argparse, 针对这个task做个小总结

官方文档是这样介绍argparse库的。

The argparse module makes it easy to write user-friendly command-line interfaces. The program defines what arguments it requires, and argparse will figure out how to parse those out of sys.argv. The argparse module also automatically generates help and usage messages and issues errors when users give the program invalid arguments.

可以看到,argparse库提供了可选和必选参数的设置,而且还可以自动生成help和usage的文档并且还提供错误解答,可以说是非常友好了。
argparse的常用API有如下几个:

1.parser = argparse.ArgumentParser() #创建一个解析器
2.parser.add_argument()#增加命令行参数和选项
3.parser.parse_args()#解析命令行参数

creating a parser

官方定义:

class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)

是不是有点眼花了,其实这么多参数,基本都用不到。就记住description是用来描述输入-h或者--help时显示的文字就行了

Adding arguments

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

又是一堆参数,我也很烦,这么多参数看着都头大, 其实一般常用的也就几个。 但是阅读官方文档是程序员必备的一种能力,所以要注意刻意练习锻炼自己的阅读能力。

  • name or flags 必须的参数,分选项参数和位置参数。选项参数类似于--para,位置参数可以是文件名,例如parser.add_argument('filename')

  • action 表示参数应该如何被处理

  • nargs 表示填写的参数后面跟几个取值。

  • const 用来存储常量值,最常用的两种情况就是:

    1. 当action='store_const'或append_const的时候,参数的取值就从const里面读取
    2. 当增加可选参数并且nargs='?'的时候,解析的时候参数会取const的值
  • default表示选项参数的默认值(常用)

  • type表示参数类型

  • choice 表示参数的取值范围

  • required一般是用来表示选项参数是否在输入的时候必须填写(常用)

  • help表示输入-h的时候显示该参数的提示信息(常用)

  • metavar 表示参数在usage里面显示的名字

  • dest 表示指定参数为另外一个名字

Parsing arguments

ArgumentParser.parse_args(args=None, namespace=None)

最后这个就比较简单了,总共两个参数。

  • args 表示要解析的字符串列表,默认是从sys.argv来的
  • namespace 表示对象可取的属性值。默认为空。

说这么多没用,做起来才有用,废话不多说,我们来举个🌰:

import argparseparser = argparse.ArgumentParser('introduce how to use')#创建一个解析器
parser.add_argument('integers', #必选参数                            
                    metavar='number', #'usage'显示成'number'                    
                    type=int, #整形变量                    
                    nargs='+', #至少有一个参数值                    
                    help='an inter for the accumulator')#帮助文档显示
parser.add_argument('--test-para',#可选参数                    
                    required=False,#是否必须携带                    
                    default='this is just a test',#默认值                    
                    help='wirte some instruction here')#帮助文档
args = parser.parse_args()#解析
print(args)

运行python3 intro_parse.py -h结果如下:

image

可以看到我们增加的number和--test-para都已经正确显示出来了。
再运行python3 intro_prase.py 8, 并没有携带--test-para,结果如下:

由于篇幅以及时间匆忙,没有做深入的研究,感兴趣的同学可以根据官方文档详细的尝试一下,多干而不是多看,做技术嘛,切忌眼高手低。

最后还是老样子,如果大家喜欢并认可我,请点个赞,顺手关注一下我的公众号:Morgan的小屋,关注于自我管理和知识学习方面,感谢大家的支持与鼓励,我会一直坚持写下去的。

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

推荐阅读更多精彩内容

  • Python作为网红脚本语言,不少开发者都会选择它来完成一些日常工作,提高效率,特别是在Python2.4以后推出...
    Neo_joke阅读 6,116评论 0 4
  • getopt:和C中的getopt()等价。optparse:2.7后已不推荐使用。argparse:基于optp...
    顾慎为阅读 8,671评论 1 10
  • 对CLI程序来说,参数解析大概是一个首要的问题。 当然,也有例外。 无参数脚本 许多常用命令,不需要输入参数,就可...
    匿蟒阅读 10,063评论 1 5
  • sys.argv sys.argv[0]是脚本文件的名字,如:test.py sys.argv[1:]是以空格分割...
    f9f73935e28c阅读 21,058评论 0 0
  • 不要单单满足于听别人的故事 不要单单满足于知道 发生在别人身上的事 展开你自己的神话 每个人都该明白这句话的意义 ...
    XXKY阅读 536评论 3 26