作者 yarving


小编:

今天开始写比赛的代码,为了写的更加正规一些,这次就用了argparse。

大体用途就是通过命令行向程序传入参数

基本用法

prog.py是我在linux下测试argparse的文件,放在/tmp目录下,其内容如下:

python中命令行参数 python命令行参数argpaser_可选值

测试:

python中命令行参数 python命令行参数argpaser_互斥_02

  • 第一个没有任何输出和出错
  • 第二个测试为打印帮助信息,argparse会自动生成帮助文档
  • 第三个测试为未定义的-v参数,会出错
  • 第四个测试为未定义的参数foo,出错

positional arguments

positional arguments为英文定义,中文名叫有翻译为定位参数的,用法是不用带-就可用,修改prog.py的内容如下:

python中命令行参数 python命令行参数argpaser_深度学习_03

执行测试如下:

python中命令行参数 python命令行参数argpaser_互斥_04

定义了一个叫echo的参数,默认必选

  • 第一个测试为不带参数,由于echo参数为空,所以报错,并给出用法(usage)和错误信息
  • 第二个测试为打印帮助信息
  • 第三个测试为正常用法,回显了输入字符串hahahaha

optional arguments

中文名叫可选参数,有两种方式:

  1. 一种是通过一个-来指定的短参数,如-h
  2. 一种是通过--来指定的长参数,如--help

这两种方式可以同存,也可以只存在一个,修改prog.py内容如下:

python中命令行参数 python命令行参数argpaser_互斥_05

注意这一行:parser.add_argument("-v", "--verbosity", help="increase output verbosity")定义了可选参数-v--verbosity,通过解析后,其值保存在args.verbosity变量中
用法如下:

python中命令行参数 python命令行参数argpaser_深度学习_06

  • 测试1中,通过-v来指定参数值
  • 测试2中,通过--verbosity来指定参数值
  • 测试3中,通过-h来打印帮助信息
  • 测试4中,没有给-v指定参数值,所以会报错

action='store-true'

上一个用法中-v必须指定参数值,否则就会报错,有没有像-h那样,不需要指定参数值的呢,答案是有,通过定义参数时指定action="store_true"即可,用法如下:

python中命令行参数 python命令行参数argpaser_可选值_07

测试:

python中命令行参数 python命令行参数argpaser_深度学习_08

第一个例子中,-v没有指定任何参数也可,其实存的是TrueFalse,如果出现,则其值为True,否则为False

类型type

默认的参数类型为str,如果要进行数学计算,需要对参数进行解析后进行类型转换,如果不能转换则需要报错,这样比较麻烦
argparse提供了对参数类型的解析,如果类型不符合,则直接报错。如下是对参数进行平方计算的程序:

python中命令行参数 python命令行参数argpaser_互斥_09

测试:

     

python中命令行参数 python命令行参数argpaser_可选值_10

  • 第一个测试为计算2的平方数,类型为int,正常
  • 第二个测试为一个非int数,报错
  • 第三个为打印帮助信息

可选值choices=[]

上述action的例子中定义了默认值为TrueFalse的方式,如果要限定某个值的取值范围,比如6中的整形,限定其取值范围为0, 1, 2,该如何进行呢?
修改prog.py文件如下:

python中命令行参数 python命令行参数argpaser_深度学习_11

测试如下:

python中命令行参数 python命令行参数argpaser_python中命令行参数_12

  • 测试1, 2, 3 为可选值范围,通过其值,打印不同的格式输出;
  • 测试4的verbosity值不在可选值范围内,打印错误
  • 测试5打印帮助信息

自定义帮助信息help

上面很多例子中都为help赋值,如

python中命令行参数 python命令行参数argpaser_深度学习_13

在打印输出时,会有如下内容:

python中命令行参数 python命令行参数argpaser_深度学习_14

也就是help为什么,打印输出时,就会显示什么

程序用法帮助

上面介绍了为每个参数定义帮助文档,那么给整个程序定义帮助文档该怎么进行呢?通过

python中命令行参数 python命令行参数argpaser_互斥_15

即可

修改prog.py内容如下:

python中命令行参数 python命令行参数argpaser_可选值_16

打印帮助信息时即显示calculate X to the power of Y

python中命令行参数 python命令行参数argpaser_深度学习_17

互斥参数

在上个例子中介绍了互斥的参数

python中命令行参数 python命令行参数argpaser_互斥_18

第一行定义了一个互斥组,第二、三行在互斥组中添加了-v-q两个参数,用上个例子中的程序进行如下测试:

python中命令行参数 python命令行参数argpaser_互斥_19

可以看出,-q-v不出现,或仅出现一个都可以,同时出现就会报错。
可定义多个互斥组

默认参数default

介绍了这么多,有没有参数默认值该如何定义呢?
修改prog.py内容如下:

python中命令行参数 python命令行参数argpaser_深度学习_20

测试结果如下:

python中命令行参数 python命令行参数argpaser_可选值_21

可以看到如果不指定-v的值,args.verbosity的值默认为1,为了更清楚的看到默认值,也可以直接打印进行测试。

IELTS a bit

jealous adj. 妒忌的;猜疑的;唯恐失去的;戒备的

quibble n. 谬论;双关语;遁词

            vi. 诡辩;挑剔;模棱两可的话

            vt. 对...诡辩

warn sb. of 警告某人

roaring adj. 喧闹的;兴胜的;狂风暴雨的

            n. 咆哮;怒吼;吼声

            v. 怒吼

apprehensive adj. 忧虑的;不安的;敏悟的;知晓的