Python argparse介绍

argparse 模块是 Python 标准库中推荐的命令行解析模块。用来写命令行脚本十分好用。

命令行分三种情况:

  • 参数
  • 短选项,分无参和有参数
  • 长选项,分无参和有参数

我们就通过以上情况来分别介绍(多看代码和注释)。

导入以及使用模板

# 导入
import argparse
# 获取实例
parser = argparse.ArgumentParser()
# 解析命令行参数
parser.parse_args()

输出结果:

python3 argparse_example.py -h
usage: argparse_example.py [-h]

optional arguments:
  -h, --help  show this help message and exit

argparse 默认有一个帮助选项,用于说明如何使用该命令。

参数

获取一个或者多个参数

# 导入
import argparse
# 设置命令行的描述信息
parser = argparse.ArgumentParser(description='argparse demo')
# 设置一个参数,narges 默认是1,可以不写,type可以是int,str,float等等
parser.add_argument('arg1', nargs=1, help='set arg1', type=int)
# 设置多个参数
parser.add_argument('argn', nargs='*', help='set argn')
# 解析命令行参数
args = parser.parse_args()
# 获取参数
print(args.arg1)
print(args.argn)

输出结果:

python3 argparse_example.py 123 abc def
[123]
['abc', 'def']

注意获取的参数是一个列表。

帮助信息:

python3 argparse_example.py -h
usage: argparse_example.py [-h] arg1 [argn [argn ...]]

argparse demo

positional arguments:
  arg1        set arg1
  argn        set argn

optional arguments:
  -h, --help  show this help message and exit

短选项

不带参数

# 导入
import argparse
# 获取示例
parser = argparse.ArgumentParser(description='argparse demo')
# 设置短选项,store_true表示如果指定-v选项,则把TRUE分配给返回值
parser.add_argument('-v', help='increase output verbosity', action='store_true')
# 解析命令行参数
args = parser.parse_args()
if args.v:
    print('verbosity turned on')
else:
    print('verbosity turned off')

输出:

python3 argparse_example.py -v
verbosity turned on
python3 argparse_example.py
verbosity turned off

帮助信息:

python3 argparse_example.py -h
usage: argparse_example.py [-h] [-v]

argparse demo

optional arguments:
  -h, --help  show this help message and exit
  -v          increase output verbosity

这里 -v 短选项是可选的,如果要设置成必选,可以在 add_argument函数里加参数 required=True

带参数

# 导入
import argparse
# 获取示例
parser = argparse.ArgumentParser(description='argparse demo')
# 设置短选项,并设置参数名
# 我将短选项改成了必须,注意!
parser.add_argument('-v', help='increase output verbosity', 
        metavar='verbosity', required=True)
# 解析命令行参数
args = parser.parse_args()
print(args.v)

输出结果:

python3 argparse_example.py -v abc
abc
python3 argparse_example.py -v      
usage: argparse_example.py [-h] -v verbosity
argparse_example.py: error: argument -v: expected one argument

帮助信息:

python3 argparse_example.py -h
usage: argparse_example.py [-h] -v verbosity

argparse demo

optional arguments:
  -h, --help    show this help message and exit
  -v verbosity  increase output verbosity

如果选项需要n个参数,同样可以设置 narges

长选项

长选项和短选项使用完全相同,将 -v 改成 --Verbosity 即可。

如果短选项和长选项需要同时支持,比如帮助信息里的 -h--help ,总不能都各写一遍吧。其实可以同时申明:

# 导入
import argparse
# 获取示例
parser = argparse.ArgumentParser(description='argparse demo')
# 同时设置短选项和长选项
parser.add_argument('-v', '--Verbosity', help='increase output verbosity', 
        required=True, action='store_true')
# 解析命令行参数
args = parser.parse_args()
print(args.v)

这里我设置的是无参数情况,有参数情况参考上述。

帮助信息:

python3 argparse_example.py -h
usage: argparse_example.py [-h] -v

argparse demo

optional arguments:
  -h, --help       show this help message and exit
  -v, --Verbosity  increase output verbosity

后记

argparse 还有很多其他用法,请参考 官方教程

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

推荐阅读更多精彩内容