python中的argparse模块

前言

    最近开始看一篇论文的代码，发现这篇论文代码的执行是我之前没有见过的，让我觉得之前的东西都白学了，没错它用的就是python中argparse模块。

---

顺便说一下，今天早上的状态我很喜欢，很专注，毕竟导师要我们开始写周报了，把我打了个措手不及……

一、argparse是什么？有什么用？

    argparse是python中对命令及其参数进行解析的库，同时还能生成相信的帮助信息。这个库的特点是可以让我们直接在命令行给程序传入参数并执行。

接下来让我们直接用代码演示它的使用方法和作用（我依然觉得实践最能让人理解）

二、实例演示

2.1 实例1

我们直接创建一个名为module_argparser.py的文件
代码如下（示例）：

import argparse

parser = argparse.ArgumentParser(description='请在命令行中传入你的ID')
parser.add_argument('ID1', type=str, help='所传入的ID1')
parser.add_argument('ID2', type=str, help='所传入的ID2')
parser.add_argument('ID3', type=str, help='所传入的ID3')
args = parser.parse_args()

print(args)

好，那我们直接执行这行代码

    相信大家如果像我一样用编译器（如pycharm）直接编译上面这几行代码，那肯定会有这两行报错信息。
    因为argparse代码的执行必须通过命令行输入才可以实现。所以大家可以在cmd或者pycharm的Terminal上运行这几行代码。
代码如下（以cmd为例）:

python module_argarser.py -h

运行结果如下:

那假如给命令行传入实际的参数呢
代码如下（以cmd为例）:

python module_argarser.py 5 7 8

运行结果如下:

接下来直接看一下这几行代码的意思

parser = argparse.ArgumentParser(description='请在命令行中传入你的ID')
parser.add_argument('ID1', type=str, help='所传入的ID1')
parser.add_argument('ID2', type=str, help='所传入的ID2')
parser.add_argument('ID3', type=str, help='所传入的ID3')
args = parser.parse_args()

(1)ArgumentParser()是用来创建argparse对象
        description：说明要传入些什么参数
(2)add_argument()是用来添加数据的
        第一个传入的参数（也就是ID1，ID2，ID3）可以说是你所传入数据的名字，有点像字典中的key
        type:是指定 你所传入数据的名字 的数据类型
        help:帮助信息，对你要传入的数据进行解释
(3)parse_args() 是用来解析argparse对象中的数据的

2.2 实例2

代码如下（示例）：

import argparse

parser = argparse.ArgumentParser(description='请在命令行中传入你的ID')
parser.add_argument('ID1', type=str, help='所传入的ID1')
parser.add_argument('ID2', type=str, help='所传入的ID2')
parser.add_argument('ID3', type=str, help='所传入的ID3')
args = parser.parse_args()

print(args.ID1+args.ID2+args.ID3)

运行:

python module_argarser.py 5 7 8

运行结果如下:

578

以上可以看出，我们其实可以在代码里面调用我们给命令行传入的数据并进行运算

2.3 实例3

代码如下（示例）：

import argparse

parser = argparse.ArgumentParser(description='请在命令行中传入你的ID')
parser.add_argument('ID1', type=str, nargs='+', help='所传入的ID1')
parser.add_argument('ID2', type=str, help='所传入的ID2')
parser.add_argument('ID3', type=str, help='所传入的ID3')
args = parser.parse_args()

print(args.ID1)
print(args.ID2)
print(args.ID3)

运行(注意空格的个数):

python module_argarser.py 5 7 8  4  5

运行结果如下:

['5', '7', '8']
4
5

在上面我们加入了一个新参数：
        nargs:表示传入数据的个数，‘+’表示传入大于等于1个数据

2.4 实例4

代码如下（示例）：

import argparse

parser = argparse.ArgumentParser(description='请在命令行中传入你的ID')
parser.add_argument('--ID1', type=str, nargs='+', default=['5', '7', '8'], help='所传入的ID1')
parser.add_argument('--ID2', type=str, default=4, help='所传入的ID2')
parser.add_argument('--ID3', type=str, default=5, help='所传入的ID3')
args = parser.parse_args()

print(args.ID1)
print(args.ID2)
print(args.ID3)

运行:

python module_argarser.py --ID2=9

运行结果如下:

['5', '7', '8']
9
5

在上面我们又加入了一个新参数：
        default:表示传入数据的默认值，如果我们没有给命令行传入数据，那么程序就会使用默认数据。需要注意的是，使用默认值的使用要在数据名字前期加上 – 这个符号

2.5 实例5

代码如下（示例）：

import argparse

parser = argparse.ArgumentParser(description='请在命令行中传入你的ID')
parser.add_argument('--ID1', type=str, default=7, dest='--ID11', help='所传入的ID1')
parser.add_argument('--ID2', type=str, default=4, dest='--ID12', help='所传入的ID2')
parser.add_argument('--ID3', type=str, default=5, dest='--ID13', help='所传入的ID3')
args = parser.parse_args()

print(args.ID1)
print(args.ID2)
print(args.ID3)

运行:

python module_argarser.py -h

运行结果如下:

这次的新参数：
        dest:表示解析后的数据名称。当数据被解析了，就会用dest来代替原本的数据名称。

---

总结

通过以上几个实例带大家大致了解了一下argparse这个模块

(1)ArgumentParser()是用来创建argparse对象
        description：说明要传入些什么参数
(2)add_argument()是用来添加数据的
        第一个传入的参数（也就是ID1，ID2，ID3）可以说是你所传入数据的名字，有点像字典中的key
        type:是指定 你所传入数据的名字 的数据类型
        help:帮助信息，对你要传入的数据进行解释
        nargs:表示传入数据的个数，‘+’表示传入大于等于1个数据
        default:表示传入数据的默认值，如果我们没有给命令行传入数据，那么程序就会使用默认数据。需要注意的是，使用默认值的使用要在数据名字前期加上 – 这个符号
        dest:表示解析后的数据名称。当数据被解析了，就会用dest来代替原本的数据名称。
(3)parse_args() 是用来解析argparse对象中的数据的

argpares还有很多参数，这里就不细讲了……