argparse.ArgumentParser()用法解析

最新推荐文章于 2023-04-25 22:12:49 发布

m0_61899108

最新推荐文章于 2023-04-25 22:12:49 发布

阅读量1.2k

点赞数

分类专栏：代码阅读系列文章标签： python

本文链接：https://blog.csdn.net/m0_61899108/article/details/121258618

版权

代码阅读系列专栏收录该内容

37 篇文章 5 订阅

订阅专栏

argparse介绍：

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

常见使用步骤:

1：import argparse # 引入模块

2：parser = argparse.ArgumentParser() # 创建解析器

3：parser.add_argument() # 添加参数

4：parser.parse_args() # 解析参数

上面四个步骤解释如下：首先导入该模块；然后创建一个解析对象；然后向该对象中添加你要关注的命令行参数和选项，每一个add_argument方法对应一个你要关注的参数或选项；最后调用parse_args()方法进行解析；解析成功之后即可使用。

ArgumentParser 对象：

包含将命令行解析成 Python 数据类型所需的全部信息。

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)

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

代码实例：

if __name__ == '__main__':
    # argparse模块的作用是用于解析命令行参数。
    parser = argparse.ArgumentParser(   # 创建一个解析对象
        'End-to-End Human Object Interaction training and evaluation script',  #prog 程序的名称，program缩写
        parents=[get_args_parser()]  # 一个 ArgumentParser 对象的列表，它们的参数也应包含在内
    )
    # parser.add_argument()  # 用于向该对象中添加你要关注的命令行参数和选项
    args = parser.parse_args()  # 调用parse_args()方法进行解析
    if args.output_dir:
        args.output_dir += f"/{args.group_name}/{args.run_name}/"   # 输出路径命名
        Path(args.output_dir).mkdir(parents=True, exist_ok=True)  # 依据路径创建文件
    
    main(args)  #主要功能函数