Python argparse 介绍

在 Python 中，argparse 模块用于处理命令行参数和选项。argparse 模块的基本使用方法是定义 ArgumentParser 对象，然后添加各种选项以及程序需要接受的参数，最后解析这些选项和参数。下面介绍 argparse 模块的使用。

安装 argparse 模块

在 Python 2.7及以上版本中，默认会安装 argparse 模块。如果您使用的是早于 Python 2.7 的版本，那么需要手动安装 argparse 模块。使用 pip 命令安装 argparse：

pip install argparse

定义 ArgumentParser 对象

首先要做的是创建一个 ArgumentParser 对象。ArgumentParser 对象将会保存程序定义的命令行选项和参数。例如：

import argparse

parser = argparse.ArgumentParser(description='这是一个命令行参数示例')

在上面的代码中，我们创建了一个 ArgumentParser 对象，同时为 ArgumentParser 对象添加了一个 description 属性，这个属性对应了一个简单的描述。

添加命令行选项和参数

在创建 ArgumentParser 对象后，我们需要添加各种命令行选项和参数。例如：

parser.add_argument('--name', dest='name', type=str, required=True,
                    help='设置名称')

parser.add_argument('--count', dest='count', type=int, default=1,
                    help='设置数量')

在上面的代码中，我们添加了两个命令行选项，一个是 --name，一个是 --count。这两个选项都有相应的 dest、type、help 等属性。

dest 属性指定了这个选项在解析后存储到的属性名。type 属性指定了这个选项的数据类型。help 属性指定了这个选项的使用方式。

解析命令行选项和参数

在添加完命令行选项和参数后，就可以开始解析命令行选项和参数了。例如：

args = parser.parse_args()

在上面的代码中，我们使用 parse_args() 方法解析命令行选项和参数，并将解析后的结果存储在 args 变量中，可以通过 args.name 和 args.count 来获取相应的选项值和参数值。

完整示例

下面是一个完整的使用 argparse 模块的示例：

import argparse

parser = argparse.ArgumentParser(description='一个命令行参数示例')

parser.add_argument('--name', dest='name', type=str, required=True,
                    help='设置名称')

parser.add_argument('--count', dest='count', type=int, default=1,
                    help='设置数量')

args = parser.parse_args()

print("name: {}, count: {}".format(args.name, args.count))

执行这个示例程序时，需要从命令行传入 --name 选项和它的值，以及 --count 选项和它的值。例如：

python example.py --name=hello --count=2

输出结果为：

name: hello, count: 2

总结

argparse 模块使 Python 命令行程序的开发和使用变得更容易。要使用 argparse 模块，需要创建 ArgumentParser 对象，然后添加各种命令行选项和参数，最后解析命令行选项和参数。