argparse模块

目录

一、argparse是什么？

二、使用步骤

三、举例说明

个人理解

---

一、argparse是什么？

argparse是python用于解析命令行参数和选项的标准模块，用于代替已经过时的optparse模块。argparse模块的作用是用于解析命令行参数。我们很多时候，需要用到解析命令行参数的程序，目的是在终端窗口(ubuntu是终端窗口，windows是命令行窗口)输入训练的参数和选项。
 

二、使用步骤

我们常常可以把argparse的使用简化成下面四个步骤

1：import argparse

2：parser = argparse.ArgumentParser()

3：parser.add_argument()

4：parser.parse_args()

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

三、举例说明

代码如下（示例）：

import math
import argparse

parser = argparse.ArgumentParser(description="Calculate volume of a Cylinder")//描述解析对象
parser.add_argument('-R','--radius',type = int,help = 'Radius of Cylinder')
parser.add_argument('-H','--height',type = int,help = 'Height of Cylinder')
args = parser.parse_args()

def cylinder_volume(radius,height):
    vol = (math.pi)*(radius**2)*(height)
    return vol

if __name__ == '__main__':
    print(cylinder_volume(args.radius,args.height))

PS E:\python learning\pythonProject> python test.py -h
usage: test.py [-h] [-R RADIUS] [-H HEIGHT]

Calculate volume of a Cylinder

optional arguments:
  -h, --help            show this help message and exit
  -R RADIUS, --radius RADIUS
                        Radius of Cylinder
  -H HEIGHT, --height HEIGHT
                        Height of Cylinder

PS E:\python learning\pythonProject> python test.py -R 4 -H 2
100.53096491487338

---

个人理解

argparse是在自己写程序的时候用的，作用是在使用命令行运行程序时，可以让程序接收命令行传过来的参数。我们在命令行窗口中使用到的shell命令，部分命令可以在后面加上参数，例如经常会使用的命令ls，当使用ls -l命令时，可以输出当前目录的文件和文件夹的详细信息，这里后面的-l就是附加的参数。如果我们想让自己的程序在命令行中运行的时候可以加上相关的参数，就用到了argparse这个python官方模块。