argparse用法

PS: 该文章主要用于自用，官方文档

1. 该模块用于获取命令行参数。
2. 若参数比较多则通过定义函数default_argument_parser()来获取。

1. 例子

1.1 代码(test.py)

import argparse    # 导入模块

def main():
    parser = argparse.ArgumentParser(description="Demo of argparse")   # 生成参数解析器
    parser.add_argument('-n','--name', default=' Li ')     # 增加参数name
    parser.add_argument('-y','--year', default='20')         # 增加参数year
    args = parser.parse_args()    # 解析参数
    print(args)
    name = args.name
    year = args.year
    print('Hello {}  {}'.format(name,year))

if __name__ == '__main__':
    main()

1.2 调用

test.py --name Li  --year 20

1.3 输出

2. 详细用法

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, exit_on_error=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）
• exit_on_error - 决定当错误发生时是否让 ArgumentParser 附带错误信息退出。 (默认值: 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() 所返回对象上的属性名。

3. 常见用法

3.1 输入为数字

parser.add_argument("--num-gpus", type=int, default=1, help="number of gpus *per machine*")

3.2 输入为文件

parser.add_argument("--config-file", default="", metavar="FILE", help="path to config file")

1. add_argument函数的metavar参数，用来控制部分命令行参数的显示,可以让命令的帮助信息更好看一些！

3.3 输入为Boolean

parser.add_argument("--eval-only", action="store_true", help="perform evaluation only")

1. 默认情况下，action=‘store’，可以不用写出来，含义是保存输入的值。如果require!=True，不输出此命令含参数，值为None：
2. action=‘store_true’ or action=‘store_false’， store_true表示如果配置，值为True，store_false表示如果配置，值为False。这两个action也很常用，此时命令行参数后面不能配置具体的值。

3.4 可选参数

parser.add_argument("opts", help="Modify config options using the command-line", default=None,
                    nargs=argparse.REMAINDER)

1. nargs=argparse.REMAINDER，所有剩余的参数，均转化为一个列表赋值给此项，通常用此方法来将剩余的参数传入另一个parser进行解析。如果nargs没有定义，则可传入参数的数量由action决定，通常情况下为一个，并且不会生成长度为一的列表。