pythonargparse模块命令行参数用法及说明

Fawn ·

更新时间:2024-11-13

· 1529 次阅读

先上代码

下面针对一些特殊点再作详述

程序用法帮助

argparse 是 python 的一个命令行解析包，可根据需要编写高可读性的程序。

网上的许多教程较为冗长和散漫，没有达到精练好掌握的目的，本文针对项目中对 argparse 的用法，用实例对各个参数进行讲解，力求达到让读者秒懂的目的。

先上代码

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)

代码示例中写上了详细的注释，观看注释也可了解各大概。

下面针对一些特殊点再作详述 action='store_true'

表示该选项不需要接收参数，直接设定该参数为 true，当然，如果不指定 -v2, 则该参数就是 false。

但如果把 action=’store_true’ 去掉，就必须给 -v2 指定一个值。

程序用法帮助

比如该程序命名为 testArg.py，则可在命令行执行如下语句：

python3 testArg.py -h

运行得到函数的用法帮助文档：