python argparse 模块命令行参数解析

1.概述

  argparse 是 python 的一个命令行解析包，可根据需要编写高可读性的程序。本文针对项目中对 argparse 的用法，用实例对各个参数进行讲解，力求达到让读者秒懂的目的。

2.api概述

2.1 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）

2.2 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() 所返回对象上的属性名。

2.案例演示

import argparse

if __name__ == '__main__':
    # 创建命令行解析器句柄，并自定义描述信息
    parser = argparse.ArgumentParser(description='test the argparse package')
    # 定义必选参数 positionArg
    parser.add_argument('positionArg') 
    # 定义可选参数verbosity1
    parser.add_argument('--verbosity1', '-v1', help='test the optional arguments') 
    # 定义可选参数verbosity2，并通过设定store_true表示该选项不需要接收参数，若不设action，则默认是需要接收参数的，否则报错
    parser.add_argument('--verbosity2', '-v2', action='store_true', help='test the action arg') 
    # 指定参数类型（默认是 str）
    parser.add_argument('x', type=int, help='test the type')
    # 设置参数的可选范围
    parser.add_argument('--verbosity3', '-v3', type=str, choices=['one', 'two', 'three', 'four'], help='test choices')
    # 设置参数默认值
    parser.add_argument('--verbosity4', '-v4', type=str, choices=['one', 'two', 'three'], default=1, help='test default value')
    args = parser.parse_args()  # 返回一个命名空间
    print(args)
    params = vars(args)  # 返回 args 的属性和属性值的字典
    for k, v in params.items():
        print(k, v)

执行以下语句：

python3 test.py -h 

完整的命令行参数执行命令和效果如下：

python3 test.py hehe -v1 verb1 --verbosity2 1 -v3 one -v4 two

打印的 Namespace 为参数解析返回的命名空间。
参考：https://blog.csdn.net/huangfei711/article/details/80325946