argparse详述

参见 https://docs.python.org/2/howto/argparse.html

1. 创建一个prog.py
# -*- coding: utf-8 -*-
import argparse
import os

def main():
    """ main func """
    parser = argparse.ArgumentParser()
    parser.parse_args()

if __name__ == '__main__':
    """ TEST FUNC """
    main()
  • 第1次尝试：执行python prog.py，但是并未打出任何有用的信息
  • 第2次尝试：执行python prog.py --help 或者 python prog.py --h，我们基本什么都没有获取，但是可以看到一个usage的提醒。（注： --help 选项, 可简化为-h，它可以在命令行运行并提供有用的帮助信息）
  • 第3次尝试：执行python prog.py --verbose, 由于传入的--verbose为无效参数，此时会报出error
2. 位置参数介绍
(1) 示例1

现在我们使用add_argument方法用来增加命令行参数选项 echo；
而parse_args()方法实际上是返回特定的命令行参数选项 ，本例中是echo.

# -*- coding: utf-8 -*-
import argparse
import os

def main():
    """ main func """
    parser = argparse.ArgumentParser()
    parser.add_argument("echo")
    args = parser.parse_args()
    print args.echo

if __name__ == '__main__':
    """ TEST FUNC """
    main()
  • 第1次尝试，执行python prog.py，显示缺少参数
  • 第2次尝试，执行python prog.py --help，显示缺少参数
  • 第3次尝试，执行python prog.py echo，python prog.py foo，显示缺少参数
(2) 示例2

先再add_argument 增加help= 可显示具体的帮助信息

# -*- coding: utf-8 -*-
import argparse
import os

def main():
    """ main func """
    parser = argparse.ArgumentParser()
    parser.add_argument("mysqure", help="对给定的参数，进行平方操作")
    args = parser.parse_args()
    print args.mysqure ** 2

if __name__ == '__main__':
    """ TEST FUNC """
    main()
  • 第1次尝试，执行python prog.py，显示缺少参数，可自行尝试
  • 第2次尝试，执行python prog.py -h，显示缺少参数，可自行尝试
  • 第3次尝试，执行python prog.py 1，显示缺少参数。虽然我们将命令行参数传入了1，但是 argparse将传入的选项视为string，导致运行失败


所以！！！需要告诉 argparse 传入的类型为int

  • 第4次尝试，传入参数为'int'
# -*- coding: utf-8 -*-
import argparse
import os

def main():
    """ main func """
    parser = argparse.ArgumentParser()
    parser.add_argument("mysqure", help="对给定的参数，进行平方操作", type=int)
    args = parser.parse_args()
    print args.mysqure ** 2

if __name__ == '__main__':
    """ TEST FUNC """
    main()

测试用例；



3. 可选参数介绍
# -*- coding: utf-8 -*-
import argparse
import os

def main():
    """ main func """
    parser = argparse.ArgumentParser()
    parser.add_argument("--verbosity", help="增加可选参数")
    args = parser.parse_args()
    if args.verbosity:
        print "已传入可选参数verbosity: %s" % args.verbosity

if __name__ == '__main__':
    """ TEST FUNC """
    main()
  • 测试用例python prog.py --verbosity hello等测试例子，测试结果如下
4. 短选项
  • 命令行缩写如下
# -*- coding: utf-8 -*-
import argparse
import os

def main():
    """ main func """
    parser = argparse.ArgumentParser()
    parser.add_argument("-v", "--verbosity", help="增加可选参数")
    args = parser.parse_args()
    if args.verbosity:
        print "已传入可选参数verbosity: %s" % args.verbosity

if __name__ == '__main__':
    """ TEST FUNC """
    main()

测试结果：


5. 结合位置参数和可选参数
  • 示例1
# -*- coding: utf-8 -*-
import argparse
import os

def main():
    """ main func """
    parser = argparse.ArgumentParser()
    parser.add_argument("mysquare", type=int, help="输入要计算平方的参数")
    parser.add_argument("-v", "--verbosity", action="store_true", help="增加可选参数")
    args = parser.parse_args()
    print "mysquare: ", args.mysquare, "args.verbosity: ", args.verbosity
    answer = args.mysquare**2
    if args.verbosity:
        print "the square of {} equals {}".format(args.mysquare, answer)
    else:
        print answer

if __name__ == '__main__':
    """ TEST FUNC """
    main()

测试结果：注 python prog.py 3 --verbosity 和 python prog.py --verbosity 3 是一样的，与顺序无关!

  • 多种可选verbosity参数值
# -*- coding: utf-8 -*-
import argparse
import os

def main():
    """ main func """
    parser = argparse.ArgumentParser()
    parser.add_argument("mysquare", type=int, help="输入要计算平方的参数")
    parser.add_argument("-v", "--verbosity", type=int, help="增加可选参数")
    args = parser.parse_args()
    print "mysquare: ", args.mysquare, "args.verbosity: ", args.verbosity
    answer = args.mysquare**2
    if args.verbosity == 2:
        print "the square of {} equals {}".format(args.mysquare, answer)
    elif args.verbosity == 1:
        print " {}^2 = {}".format(args.mysquare, answer)
    else:
        print answer

if __name__ == '__main__':
    """ TEST FUNC """
    main()

测试结果：


  • 限定verbosity参数值

增加choices=[0, 1, 2]，限定verbosity取值为0，1， 2

# -*- coding: utf-8 -*-
import argparse
import os

def main():
    """ main func """
    parser = argparse.ArgumentParser()
    parser.add_argument("mysquare", type=int, help="输入要计算平方的参数")
    parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],help="增加可选参数")
    args = parser.parse_args()
    print "mysquare: ", args.mysquare, "args.verbosity: ", args.verbosity
    answer = args.mysquare**2
    if args.verbosity == 2:
        print "the square of {} equals {}".format(args.mysquare, answer)
    elif args.verbosity == 1:
        print " {}^2 = {}".format(args.mysquare, answer)
    else:
        print answer

if __name__ == '__main__':
    """ TEST FUNC """
    main()

测试结果:


最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,402评论 6赞 499
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,377评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,483评论 0赞 353
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,165评论 1赞 292
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,176评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,146评论 1赞 297
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,032评论 3赞 417
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,896评论 0赞 274
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,311评论 1赞 310
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2赞 332
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,413评论 5赞 343
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,008评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1赞 269
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2赞 353