详解Python argparse ---命令行选项、参数和子命解析器

一、 模块简介

argparse模块使编写用户友好的命令行界面变得容易。该程序定义了它需要什么参数，argparse将找出如何从sys.argv中解析这些参数自动生成帮助和使用消息。当用户给予程序无效时，该模块也会发出错误论点。

-------注：来自官网文档介绍

二、使用步骤

• import argparse
• parser = argparse.ArgumentParser() ————表示：创建参数解析对象。
• parser.add_argument() ————表示：想解析对象添加你要关注的命令行参数和选项，每一个add_argument方法对应一个你要关注的参数或选项
• args = parser.parse_args() ————表示：调用parse_args()方法进行解析；解析成功之后即可使用
• return args/处理参数

三、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 - 程序的名称 (默认值: os.path.basename(sys.argv[0]))
• usage - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）
• description - Text to display before the argument help (by default, no text)
• epilog - Text to display after the argument help (by default, no text)
• 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)

四、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 - A sequence of the allowable values for the argument.
• required - 此命令行选项是否可省略 （仅选项可用）。
• help - 一个此选项作用的简单描述。
• metavar - 在使用方法消息中使用的参数值示例。
• dest - 被添加到 parse_args() 所返回对象上的属性名。

五、示例

import argparse
parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',const=sum, default=max,help='sum the integers (default: find the max)')
args = parser.parse_args()
print(args.accumulate(args.integers))

显示结果：
click 这里查看官方文档

一键三连 Please!!!