Argparse(命令行选项、参数和子命令解析器) 使用

声明：本文是作者在学习过程中对argpaser的学习总结，文章主要内容来源于argparse的官方中文文档。有不太理解的地方可以直接连接到官方文档查看，谢谢。

一、 argparse 介绍 官方文档

argparse 模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数，然后 argparse 将弄清如何从 sys.argv 解析出那些参数。 argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

二、官方示例

通过该示例额，可以知道该模块主要完成哪些功能

下面代码是一个Python程序，它的主要作用是：获取一个整数列表，并提供计算总和或者求最大值的两个功能。

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

假设上面的 Python 代码保存在名为 prog.py 的文件中，它可以在命令行运行并提供有用的帮助信息：

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

optional arguments:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

当使用适当的参数运行时，它会输出命令行传入整数的总和或者最大值：

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

如果传入无效参数，则会报出错误：

$ python prog.py a b c
usage: prog.py [-h] [--sum] N [N ...]
prog.py: error: argument N: invalid int value: 'a'

三、如何使用Argparse

分步介绍Argparse使用的方法

1、创建一个解析器

使用argparse的第一步就是创建一个ArgumentParser对象，该对象包含将命令行解析成Python数据类型所需的全部信息。

parser = argparse.ArgumentParser(description='Process some integers.')

2、添加参数

给一个ArgumentParser 添加程序参数信息是通过调用 add_argument()方法完成的。

parser.add_argument('integers', metavar='N', type=int, nargs='+', help='an integer for the accumulator')

3、解析参数

ArgumentParser 通过 parse_args() 方法解析参数。它将检查命令行，把每个参数转换为适当的类型然后调用相应的操作。

>>> parser.parse_args(['--sum', '7', '-1', '42'])
Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])

四、ArgumentParser 属性

class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)

创建一个新的 ArgumentParser 。所有的参数都应当作为关键字参数传入。它们是：

• prog - 程序的名称（默认值：sys.argv[0]）
• usage - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）
• description - 在参数帮助文档之前显示的文本（默认值：无）
• epilog - 在参数帮助文档之后显示的文本（默认值：无）
• parents - 一个 ArgumentParser 对象的列表，它们的参数也应包含在内
• formatter_class - 用于自定义帮助文档输出格式的类
• prefix_chars - 可选参数的前缀字符集合（默认值： ‘-’）
• fromfile_prefix_chars - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值： None）
• argument_default - 参数的全局默认值（默认值： None）
• conflict_handler - 解决冲突选项的策略（通常是不必要的）
• add_help - 为解析器添加一个 -h/–help 选项（默认值： True）
• allow_abbrev - 如果缩写是无歧义的，则允许缩写长选项 （默认值：True）

五、add_argument()方法

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

定义单个的命令行参数应当如何解析。每个形参都在下面有它自己更多的描述，长话短说有：

• name or flags - 一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo。
• action - 当参数在命令行中出现时使用的动作基本类型。
• nargs - 命令行参数应当消耗的数目。
• const - 被一些 action 和 nargs 选择所需求的常数。
• default - 当参数未在命令行中出现时使用的值。
• type - 命令行参数应当被转换成的类型。
• choices - 可用的参数的容器。
• required - 此命令行选项是否可省略 （仅选项可用）。
• help - 一个此选项作用的简单描述。
• metavar - 在使用方法消息中使用的参数值示例。
• dest - 被添加到 parse_args() 所返回对象上的属性名。

六、parse_args() 方法

ArgumentParser.parse_args(args=None, namespace=None)

将参数字符串转换为对象并将其设为命名空间的属性。 返回带有成员的命名空间。
之前对 add_argument()的调用决定了哪些对象被创建以及它们如何被赋值。 请参阅 add_argument() 的文档了解详情。

• args - 要解析的字符串列表。 默认值是从 sys.argv 获取。
• namespace - 用于获取属性的对象。 默认值是一个新的空 Namespace 对象。