一、Argparse.ArgumentParser()用法解析

argparse是一个Python模块:命令行选项、参数和子命令解析器。主要有三个步骤:

  1. 创建ArgumentParser()对象
  2. 调用add_argument()方法添加参数
  3. 使用parse_args()解析添加的参数

1. 创建解析器

  1. parser = argparse.ArgumentParser(description = 'Process some integers.')

使用argparse的第一步是创建一个ArgumentParser对象。ArgumentParser对象包含将命令行解析成Python数据类型所需的全部信息。

2. 添加参数

  1. parser.add_argument('integers', metavar='N', type=int, nargs='+', help='an integer for the accumulator')

3. 解析参数

  1. parser.parse_args(['--sum', '7', '-1', '42']);

二、ArgumentParser 对象

  1. class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[],
  2. formatter_class=argparse.HelpFormatter, prefix_chars='-',
  3. fromfile_prefix_chars=None, argument_default=None, conflict_handler='error',
  4. add_help=True, allow_abbrev=True)
  • prog: 程序的名称
  • usage: 描述程序用途的字符串(默认值:从添加到解析器的参数生成)
  • description: 在参数帮助文档之前显示的文本(默认值:无)
  • epilog: 在参数帮助文档之后显示的文本(默认值:无)
  • parents: 一个ArgumentParser对象的列表,它们的参数也应包含在内
  • formatter_class: 用于自定义帮助文档输出格式的类
  • prefix_chars: 可选参数的前缀字符集合(默认值: ‘-‘)
  • promfile_prefix_chars: 当需要从文件中读取其他参数时,用于标识文件名的前缀字符集合(默认值:None)
  • argument_default: 参数的全局默认值(默认值:None)
  • conflict_handler: 解决冲突选项的策略(通常是不需要的)
  • add_help: 为解析器添加一个-h/-help选项(默认值:True)
  • allow_abbrev: 如果缩写是无歧义的,则允许缩写长选项(默认值:True)

三、add_argument() 方法

  1. ArgumentParser.add_argument(name or flags...[, action][, nargs][, const]
  2. [, default][, type][, choices][, required][, help]
  3. [, metavar][, dest])
  • name or flags - 一个命名或者一个选项字符串的列表,例如 foo 或 -f, —foo。
  • action - 当参数在命令行中出现时使用的动作基本类型。
  • nargs - 命令行参数应当消耗的数目。
  • const - 被一些 actionnargs 选择所需求的常数。
  • default - 当参数未在命令行中出现时使用的值。
  • type - 命令行参数应当被转换成的类型。
  • choices - 可用的参数的容器。
  • required - 此命令行选项是否可省略 (仅选项可用)。
  • help - 一个此选项作用的简单描述。
  • metavar - 在使用方法消息中使用的参数值示例。
  • dest - 被添加到 parse_args() 所返回对象上的属性名。

    四、示例

    ```python

    -- coding: utf-8 --

import argparse

parser = argparse.ArgumentParser() parser.add_argument(‘—Name’, help=”the name of person”, type=str, default=’LaoWang’) parser.add_argument(‘—Age’, help=”the age of person”, type=int, default=23) args = parser.parse_args() print(args.Name, args.Age) ```

LaoWang 23