【Python】argparse 包的简单介绍

---

一、介绍

argparse 是 python 的一个标准模块，作用：解析命令行参数和选项，代替已经过时的 optparse 模块。

argparse 模块的作用是用于解析命令行参数。

我们很多时候，需要用到解析命令行参数的程序。

---

二、使用步骤

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

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

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

---

三、实例

#-*- coding: UTF-8 -*-
import argparse   #步骤一

def parse_args():
    """
    :return:进行参数的解析
    """
    description = "you should add those parameter"                   # 步骤二
    parser = argparse.ArgumentParser(description=description)        # 这些参数都有默认值，当调用parser.print_help()或者运行程序时由于参数不正确(此时python解释器其实也是调用了pring_help()方法)时，
                                                                     # 会打印这些描述信息，一般只需要传递description参数，如上。
    help = "The path of address"
    parser.add_argument('--addresses',help = help)                   # 步骤三，后面的help是我的描述
    args = parser.parse_args()                                       # 步骤四
    return args

if __name__ == '__main__':
    args = parse_args()
    print(args.addresses)            #直接这么获取即可。

在命令行执行上述python文件：

python wsl.py -h

输出结果为：

usage: wsl.py [-h] [--addresses ADDRESSES]
you should add those parameter
optional arguments:
  -h, --help            show this help message and exit
  --addresses ADDRESSES
                        The path of address

说明我们添加的 --addresses 命令行参数成功解析。

---

四、参考链接

1. python学习之argparse模块