Python学习之argparse模块


前言

  近几天一直在学习解析命令行参数和选项的模块argparse,这是Python再带的用于解析命令行参数和选项的标准模块,很早之前的optparse模块已经过时并被argparse模块取代。相信很多小伙伴在学习这个库的时候遇到了很多不懂的问题,很多坑,看官方的API由于是英文的很多小伙伴也甚至捉急,其实最好的学习方法还是看官方文档,博主就根据自己在学习时候遇到的坑来浅谈一下argparse。

基本认识

  最好的认知方法那就是举例子,下面我们先从一个基本的程序说起。

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

我们将以上代码保存成prog.py文件,在dos下运行这个脚本文件下面我们看一下运行结果:

$ python prog.py
$ python prog.py --help
usage: prog.py [-h]

optional arguments:
-h, --help show this help message and exit
$ python prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo

结果分析:

  1. 若不给参数而运行这个程序,将不会得到任何结果。
  2. 第二条命名显示了使用的argparse的好处,你什么也没做,却得到了一个很好的帮助信息。
  3. 我们无需人为设置–help参数,就能得到一个良好的帮助信息。但是若给其他参数(比如foo)就会产生一个错误。

使用步骤

1:import argparse

2:parser = argparse.ArgumentParser()

3:parser.add_argument()

4:parser.parse_args()

   我们对这四个步骤解释一下:首先导入该模块;然后创建一个解析对象;然后向该对象中添加你要关注的命令行参数和选项,每一个add_argument方法对应一个你要关注的参数或选项;最后调用parse_args()方法进行解析;解析成功之后即可使用。

   接下来我们来说明一下argparse模块中最重要的两个部分:ArgumentParser()add_argument()

   首先,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)

   这些参数都有默认值,当调用parser.print_help()或者运行程序时由于参数不正确(此时python解释器其实也是调用了pring_help()方法)时,会打印这些描述信息,一般只需要传递description参数,如上所示。

下面将对ArgumentParser参数的简单说明进行中文版本的简单说明:

  1. description - 命令行帮助的开始文字,大部分情况下,我们只会用到这个参数
  2. epilog - 命令行帮助的结尾文字
  3. prog - (default: sys.argv[0])程序的名字,一般不需要修改,另外,如果你需要在help中使用到程序的名字,可以使用%(prog)s
  4. prefix_chars - 命令的前缀,默认是-,例如-f/–file。有些程序可能希望支持/f这样的选项,可以使用prefix_chars=”/”
  5. fromfile_prefix_chars - (default: None)如果你希望命令行参数可以从文件中读取,就可能用到。例如,如果fromfile_prefix_chars=’@’,命令行参数中有一个为”@args.txt”,args.txt的内容会作为命令行参数
  6. add_help - 是否增加-h/-help选项 (default: True),一般help信息都是必须的,所以不用设置啦。
  7. parents - 类型是list,如果这个parser的一些选项跟其他某些parser的选项一样,可以用parents来实现继承,例如parents=[parent_parser]
  8. 三个允许的值: # class argparse.RawDescriptionHelpFormatter 直接输出description和epilog的原始形式(不进行自动换行和消除空白的操作) # class argparse.RawTextHelpFormatter 直接输出description和epilog以及add_argument中的help字符串的原始形式(不进行自动换行和消除空白的操作) # class argparse.ArgumentDefaultsHelpFormatter 在每个选项的帮助信息后面输出他们对应的缺省值,如果有设置的话。这个最常用吧!
  9. argument_default - (default: None)设置一个全局的选项的缺省值,一般每个选项单独设置,所以这个参数用得少,不细说
  10. usage - (default: generated)如果你需要修改usage的信息(usage: PROG [-h] [–foo [FOO]] bar [bar …]),那么可以修改这个,一般不要修改。
  11. conflict_handler - 不建议使用。这个在极端情况下才会用到,主要是定义两个add_argument中添加的选项的名字发生冲突时怎么处理,默认处理是抛出异常。

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

其中:

  1. name or flags - 指定参数的形式,想写几个写几个,不过我们一般就写两个,一个短参数,一个长参数,看下面的例子”-f”, “–file”
  2. 可选的选项,位置不固定,想怎么写就怎么写,默认是可选的 # parser.add_argument(“-f”, “–file”, help=”test test test”)
  3. 位置固定的选项,例如”prog i_am_bar”,这样子的话,i_am_bar就是bar选项的值啦,默认是必须有的 # parser.add_argument(“bar”, help=”test test test”)
  4. nargs - 指定这个参数后面的value有多少个,例如,我们希望使用-n 1 2 3 4,来设置n的值为[1, 2, 3, 4] #parser.add_argument(“-n”, “–num”, nargs=”+”, type=int) # 这里nargs=”+”表示,如果你指定了-n选项,那么-n后面至少要跟一个参数,+表示至少一个,?表示一个或0个,*0个或多个 。
  5. default - 如果命令行没有出现这个选项,那么使用default指定的默认值 #parser.add_argument(“+g”, “++gold”, help=”test test test”,default=”test_gold”)#需要prefix_chars包含”+” 。
  6. type - 如果希望传进来的参数是指定的类型(例如 float, int or file等可以从字符串转化过来的类型),可以使用 #parser.add_argument(“-x”, type=int) 。
  7. choices - 设置参数值的范围,如果choices中的类型不是字符串,记得指定type哦 #parser.add_argument(“-y”, choices=[‘a’, ‘b’, ‘d’])
  8. required - 通常-f这样的选项是可选的,但是如果required=True那么就是必须的了 #parser.add_argument(“-z”, choices=[‘a’, ‘b’, ‘d’], required=True)
  9. metavar - 参数的名字,在显示 帮助信息时才用到. # parser.add_argument(“-o”, metavar=”OOOOOO”)
  10. help - 设置这个选项的帮助信息
  11. dest - 设置这个选项的值就是解析出来后放到哪个属性中 #parser.add_argument(“-q”, dest=”world”)
  12. args = parser.parse_args(args) # 如果你没有args参数,那么就使用sys.argv,也就是命令行参数啦。有这个参数,就方便我们调试啊 。# args.world就是-q的值啦
  13. action - The basic type of action to be taken when this argument is encountered at the command line.
  14. const - A constant value required by some action and nargs selections.

最常用的参数也就是以上这些,如果有更多的需求,那么可以查看官方的API文档。

实例

下面我们将用官网的一个实例来进一步认识一下argparse。

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
const=sum, default=max,
help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

在控制台终端上输入python prog.py -h即可获得帮助说明。

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
N an integer for the accumulator

optional arguments:
-h, --help show this help message and exit
--sum sum the integers (default: find the max)

注意上面的 -h, –help, –sum 都是可选参数。

在再终端带参数输入命令行中,即可求得值:

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

我们下面来看一段代码:

# -*- coding: utf-8 -*-

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
const=sum, default=max,
help='sum the integers (default: find the max)')
parser.add_argument("--square", help="display a square of a given number",
type=int)

args = parser.parse_args()
print(args.accumulate(args.integers), args.square**2)

我们在控制台dos界面下输入 python prog.py 4 5 6 –square 7
我们可以看一下运行结果:

这里写图片描述

  可以看到输出结果是 6 49 这里的49我们很容易理解,是对输入的参数7进行平方操作,那么为什么前面是6呢,注意看我们上面定义的前两个parser.add_argument()这两个方法的参第一个参数形式是不同,一个是不带有“–”前缀的,而另外一个是带有这个前缀的,那么这两个有什么区别呢。原来带有“–”这个前缀的参数是可选参数,即进行参数传递时可以有选择的进行传递,如果直接写参数的话,那就是默认操作,可以看出是取参数中列表中的最大值,如果想对这个可选参数进行参数传递,那就得按照后面的“–”带有这个前缀的参数传递方法与“–square”一样,这样传递过去参数就是执行sum的操作了,下面我们就操作一下看看。

   在dos窗口下键入python prog.py –sum 4 5 6 –square 7,按回车键我们来看一下运行结果:

这里写图片描述

可以看到输出结果是 15 49 ,神奇吧。还有一个要注意的问题就是:add_argument()方法传递的参数类型默认为字符型,如果你要用到其他类型的数据,可以在最后结果上面强制转换,也可以像上面的–square一样指明type,官方还是比较推荐后面这种做法。

这次的分享就到这里吧,还要继续学习前行啊!


注意!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系我们删除。



 
  © 2014-2022 ITdaan.com 联系我们: