Python基础-使用argparse命令行参数模块

argparse模块是Python内置的基础模块之一，它的主要作用是在命令行程序中实现友好的用户接口，更方便的解析用户输入的配置参数。

如果你想写出更加专业的Python代码，argparse是你需要学会的基础模块之一。在这篇文章中我们将使用一个简单的小例子来介绍argparse基础的使用。

命令行接口参数举例

在这个例子中我们使用opencv读取一张图片，如果用户参数中存在flip参数，那么我们将图片翻转,且如果翻转参数等于x，那么在x轴翻转，如果翻转参数等于y，那么在y轴上翻转，否则直接显示图片。

#使用argparse的简单例子
parser = argparse.ArgumentParser(formatter_class = argparse.RawTextHelpFormatter,
description= "---------------\n使用argpasrse的第一个例子\n---------------\n")
parser.add_argument("-i", "--image", metavar="IMAGE", help = "图像路径")
parser.add_argument("-f", "--flip", metavar="IMAGE_FLIP", help = "翻转方向\nx代表x轴\ny代表y轴")
args = parser.parse_args()
image = cv2.imread(args.image)
if args.flip:
   #参数中存在flip那么翻转图像
   flipdir=0 if args.flip=='x'else 1
   flip_img = cv2.flip(image, flipdir)
   # 展示翻转的图像
   cv2.imshow("dog flip", flip_img)
else:
   #没有flip翻转参数时直接显示图像
   cv2.imshow("dog", image)
cv2.waitKey(0)

我们在命令行中输入如下命令运行：

python 1.py -i dog.jpg

在命令行中增加参数-f y ，可以看到狗狗沿着y轴做了镜像翻转

python 1.py -i dog.jpg -f y

在命令行中增加参数-f x 命令

python 1.py -i dog.jpg -f x

可以看到狗狗沿着x轴做了镜像翻转

在这个小例子中定义了两个参数image和flip，使用argparse进行参数的解析，下面详细解释argparse的基本使用方法。

创建argparse对象

使用argparse的第一步是创建一个argparse对象，在构造参数中输入你的帮助信息，调用脚本时加入-h参数，这些提示信息将会呈现给用户。

构造函数中增加参数 formatter_class = argparse.RawTextHelpFormatter ，这样会使帮助文本中的回车符的有效，输出更加易读的多行提示，如本例中所示。

parser = argparse.ArgumentParser(formatter_class = argparse.RawTextHelpFormatter,

description= "---------------\n使用argpasrse的第一个例子\n---------------\n")

添加Positional 参数和optional 参数

接下来第二步使用add_argument增加你的配置参数，这个例子中我们有两个参数，一个是图像路径，一个是翻转方向，如下。

parser.add_argument("-i", "--image", metavar="IMAGE", help = "图像路径")
parser.add_argument("-f", "--flip", metavar="IMAGE_FLIP", help = "翻转方向\nx代表x轴\ny代表y轴")

需要注意的是这里的参数是带有 - 和-- 前缀的，这种参数叫optional 参数,脚本调用时使用参数名+参数值的调用方式。例如:

python 1.py -i dog.jpg
python 1.py --image dog.jpg

脚本调用时使用-i和--image均可，-i是--image的简写方式。

如果我们将 -- 和- 前缀去掉，使用如下的定义方式，这种参数被叫做位置参数

parser.add_argument("image", metavar="IMAGE", help = "图像路径")
parser.add_argument("flip", metavar="IMAGE_FLIP", help = "翻转方向\nx代表x轴\ny代表y轴")

命令行调用时按照参数定义的顺序直接输入参数值，而不需要输入参数名字，例如

python 1.py dog.jpg x

上面的命令中根据输入参数的先后顺序被赋值给程序的image和 flip参数，为了更大的灵活性，推荐使用optional 参数设计你的程序，所以此处不对位置参数做进一步的讨论。

参数添加帮助提示

parser.add_argument("image", metavar="IMAGE", help = "图像路径")
parser.add_argument("flip", metavar="IMAGE_FLIP", help = "翻转方向\nx代表x轴\ny代表y轴")

本例中为了更友好地显示帮助信息添加了\n回车符，由于我在定义argparse对象使用了参数formatter_class = argparse.RawTextHelpFormatter，这样帮助信息中会换行显示。

使用python 1.py -h的命令可以查看本例子的帮助信息

增加参数默认值

在add_argument中使用defalut可以增加参数的默认值

parser.add_argument("-i", "--image", metavar="IMAGE", default="dog.jpg",help = "图像路径")
parser.add_argument("-f", "--flip", metavar="IMAGE_FLIP",default="x", help = "翻转方向\nx代表x轴\ny代表y轴")

输入命令：

python 1.py

在不输入任何参数的情况下，程序使用默认参数默认对图像在x轴翻转

此外参数中也可以存在不需要参数值的参数，例如在这个例子中增加--gray参数实现图像的灰度化,gray参数不需要赋值，在参数中存在就会对图像就行灰度化

import cv2
import argparse
#使用argparse的简单例子
parser = argparse.ArgumentParser(formatter_class = argparse.RawTextHelpFormatter,
description= "---------------\n使用argpasrse的第一个例子\n---------------\n")
parser.add_argument("-i", "--image", metavar="IMAGE", default="dog.jpg",help = "图像路径")
parser.add_argument("-f", "--flip", metavar="IMAGE_FLIP",default="x", help = "翻转方向\nx代表x轴\ny代表y轴")
#添加一个不需要赋值的参数
parser.add_argument("--gray", metavar="IMAGE_GRAY", action= 'store_const', const=True ,default=False, help = "灰度化")
args = parser.parse_args()
image = cv2.imread(args.image)
if args.gray:
      image = cv2.cvtColor(image,cv2.COLOR_BGR2GRAY)
if args.flip:
      #参数中存在flip那么翻转图像
      flipdir=0 if args.flip=='x'else 1
      flip_img = cv2.flip(image, flipdir)
      # 展示翻转的图像
      cv2.imshow("dog flip", flip_img)
else:
      #没有flip翻转参数时直接显示图像
      cv2.imshow("dog", image)
cv2.waitKey(0)

--gray参数中的action= 'store_const', const=True 说明了此参数存在时会被赋予常量True，如果不存在时会使用默认False

输入如下命令：

python 1.py --gray

设置参数类型

add_argument中默认参数类型都是str，你可以使用type=类型，来设置参数的类型。例如下面的例子中明确参数类型是int

parser.add_argument("channel", help="输入整数通道", type=int)
args = parser.parse_args()
print(type(args.channel))

使用参数

使用参数时首先调用args = parser.parse_args() 解析参数，然后就可以像使用对象属性一样使用命令行参数了

args = parser.parse_args()
print(args.image)

总结:

本文对命令行参数模块argparse做了基本的介绍，还有很多高级功能大家可以自己去发现。