【Python】Parser通常用法

1. 介绍

Parser在Python程序中经常使用，使用前需要import argparse，简单来说argparse模块就是对参数进行设置。专业说法如下：

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

2. 使用方法

2.1 实例化ArgumentParser()

实例化创建一个ArgumentParser对象。

• 示例：

import argparse 

if __name__ == "__main__" : 
    parser = argparse.ArgumentParser(description='parser example')

• 参数解析：
  description:大多数对 ArgumentParser 构造方法的调用都会使用 description= 关键字参数。这个参数简要描述这个程度做什么以及怎么做。在帮助消息中，这个描述会显示在命令行用法字符串和各种参数的帮助消息之间。

2.2 添加参数add_argument()

使用add_argument()函数增加参数并设置值。

• 示例：

import argparse 

if __name__ == "__main__" : 
    parser = argparse.ArgumentParser(description='parser example')
    parser.add_argument('--seed', default=1, type=int, help='Random seed')
    parser.add_argument('--lr', default=0.1, type=float, help='learning rate')
    parser.add_argument('--datapath', default='../../dataset/', type=str, help='dataset path')
    parser.add_argument('--resume', action='store_true', help='resume from checkpoint')

• 参数解析：

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

name or flags ：选项字符串的名字或者列表。

action： 命令行遇到参数时的动作，参数选择有 store_true 或store_false。

store_const：表示赋值为const。

append：将遇到的值存储成列表，也就是如果参数重复则会保存多个值。

append_const：将参数规范中定义的一个值保存到一个列表。

count：存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析。

nargs :应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default—对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。

const-action 和 nargs 所需要的常量值。

default： 不指定参数时的默认值。

type： 命令行参数应该被转换成的类型。

choices：参数可允许的值的一个容器。

required：可选参数是否可以省略 (仅针对可选参数)。

help：参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息。

metavar：在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称。

dest： 解析后的参数名称，默认情况，对于可选参数选取最长的名称，中划线转换为下划线。

2.3 解析参数parse_args()

ArgumentParser 通过 parse_args() 方法解析参数。它将检查命令行，把每个参数转换为适当的类型然后调用相应的操作。在大多数情况下，这意味着一个简单的 Namespace 对象将从命令行解析出的属性构建。

• 示例：

import argparse 

if __name__ == "__main__" : 
    parser = argparse.ArgumentParser(description='parser example')
    parser.add_argument('--seed', default=1, type=int, help='Random seed')
    parser.add_argument('--lr', default=0.1, type=float, help='learning rate')
    parser.add_argument('--datapath', default='../../dataset/', type=str, help='dataset path')
    parser.add_argument('--resume', action='store_true', help='resume from checkpoint')

    args = parser.parse_args()

3. 案例实践

完整程序：

import argparse 

if __name__ == "__main__" : 
    parser = argparse.ArgumentParser(description='parser example')
    parser.add_argument('--seed', default=1, type=int, help='Random seed')
    parser.add_argument('--lr', default=0.1, type=float, help='learning rate')
    parser.add_argument('--datapath', default='../../dataset/', type=str, help='dataset path')
    parser.add_argument('--resume', action='store_true', help='resume from checkpoint')

    args = parser.parse_args()
    print('1: ', args.lr)
    print('2: ', args.resume)
    print('3: ', args)

run:

python parser_test.py

python parser_test.py --lr 0.3 --resume

4. 参考

Python】Parser 用法-通俗易懂！

python ----Parser使用