Python argparse模块、argparse.ArgumentParser()用法解析

参考：原文链接、python3中argparse模块、官方英文版argparse模块、官方中文版argparse模块

此模块有中文文档，建议看到此文的读者链接到中文文档查看，本文只是自己学习、个人理解的重点总结

目录：

1. argparse模块 官方文档

2. 使用流程

      1）创建解析器 

      2）添加参数

     3）解析参数

3. ArgumentParser 对象

4. add_argument() 方法

---

1. argparse模块 官方文档

       argparse是一个Python模块：用于命令行选项、参数和子命令的解析器。

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

2. 使用流程

      1）创建解析器 

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

        使用 argparse 的第一步是创建一个 ArgumentParser 对象。

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

      2）添加参数

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

         给一个 ArgumentParser 添加程序参数信息是通过调用 add_argument() 方法完成的。

     3）解析参数

parser.parse_args(['--sum', '7', '-1', '42'])
Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])

        ArgumentParser 通过 parse_args() 方法解析参数。

3. 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)

• 参数须知：一般我们只选择用description
• 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）

4. add_argument() 方法

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

• 参数须知：name or flags...    - 必选，指定参数的形式，一般写两个，一个短参数，一个长参数
• name or flags - 一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo。
• action - 当参数在命令行中出现时使用的动作基本类型。
• nargs - 命令行参数应当消耗的数目。
• const - 被一些 action 和 nargs 选择所需求的常数。
• default - 当参数未在命令行中出现时使用的值。
• type - 命令行参数应当被转换成的类型。
• choices - 可用的参数的容器。
• required - 此命令行选项是否可省略 （仅选项可用）。
• help - 一个此选项作用的简单描述。
• metavar - 在使用方法消息中使用的参数值示例。
• dest - 被添加到 parse_args() 所返回对象上的属性名。

name or flags：

是一个选项，例如 -f 或 --foo；或是一个位置参数，例如一组文件名。

第一个传递给 add_argument() 的参数必须是一系列 flags 或者是一个简单的参数名。

       For example, an optional argument could be created like:（选项参数）

   >>> parser.add_argument('-f', '--foo')

       while a positional argument could be created like:  （位置参数）

   >>> parser.add_argument('bar')

 当 parse_args() 被调用，选项会以 - 前缀识别，剩下的参数则会被假定为位置参数:

help：

The help value is a string containing a brief description of the argument.

When a user requests help (usually by using -h or --help at the command line), these help descriptions will be displayed with each argument：

>>> parser = argparse.ArgumentParser(prog='frobble')
>>> parser.add_argument('--foo', action='store_true',
...                     help='foo the bars before frobbling')
>>> parser.add_argument('bar', nargs='+',
...                     help='one of the bars to be frobbled')
>>> parser.parse_args(['-h'])
usage: frobble [-h] [--foo] bar [bar ...]

positional arguments:（位置参数）
 bar     one of the bars to be frobbled

optional arguments:（选项参数）
 -h, --help  show this help message and exit
 --foo   foo the bars before frobbling