argparse · Magic_sword2

[TOC] # 简介说明 原文链接： - [argparse](https://docs.python.org/zh-cn/3.9/library/argparse.html#module-argparse) ``` 版本：argparse 作用：命令行参数解析包 ``` # argparse.ArgumentParser # [new]-ArgumentParser() ***** 创建解析参数对象 ### 参数说明 prog: * 类型：字符串 * 默认值：sys.argv[0] * 描述：程序的名称 * 可选值：[ ] usage: * 类型：字符串 * 默认值：sys.argv[0] * 描述：描述程序用途的字符串 * 可选值：[ ] description: * 类型：字符串 * 默认值：无 * 描述：在参数帮助文档之前显示的文本 * 可选值：[ ] epilog: * 类型：字符串 * 默认值：无 * 描述：在参数帮助文档之后显示的文本 * 可选值：[ ] parents: * 类型：列表 * 默认值：无 * 描述：一个 ArgumentParser 对象的列表，它们的参数也应包含在内 * 可选值：[ ] formatter_class: * 类型：argparse.HelpFormatter * 默认值：无 * 描述：用于自定义帮助文档输出格式的类 * 可选值：[ ] prefix_chars: * 类型：字符串 * 默认值：\- * 描述：可选参数的前缀字符集合，许多命令行会使用 - 当作前缀，比如 \-f/\-\-foo * 可选值：[ ] fromfile_prefix_chars: * 类型：字符串 * 默认值：无 * 描述：当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合 * 可选值：[ ] argument_default: * 类型：字符串 * 默认值：无 * 描述：参数的全局默认值，默认情况参数会有None的默认值，想要禁用设置SUPPRESS * 可选值：[ argparse.SUPPRESS ] conflict_handler: * 类型：字符串 * 默认值：error * 描述：解决冲突选项的策略 * 可选值：[ ] add_help: * 类型：布尔 * 默认值：无 * 描述：为解析器添加一个 -h/--help 选项 * 可选值：[ ] allow_abbrev: * 类型：布尔 * 默认值：False * 描述：是否允许识别参数缩写 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` parser = argparse.ArgumentParser(description='Process some integers.') ``` 2. fromfile_prefix_chars使用方式 ``` >>> with open('args.txt', 'w') as fp: ... fp.write('-f\nbar') >>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@') >>> parser.add_argument('-f') >>> parser.parse_args(['-f', 'foo', '@args.txt']) Namespace(f='bar') ``` # add_argument() ***** 添加操作参数 ### 参数说明 name | flags: * 类型：字符串 * 默认值：无 * 描述：一个命名或者一个选项字符串的列表，例如 foo 或 -f, -\-foo * 可选值：[ ] type: * 类型：obj * 默认值：无 * 描述：命令行参数应当被转换成的类型 * 可选值：[ ] const: * 类型：字符串 * 默认值：无 * 描述：被一些 action 和 nargs 选择所需求的常数 * 可选值：[ ] default: * 类型：字符串 * 默认值：无 * 描述：当参数未在命令行中出现时使用的值 * 可选值：[ ] action: * 类型：字符串 * 默认值：store * 描述：当参数在命令行中出现时使用的动作基本类型 * 可选值：[ count | help | extend ] ![action](https://img.kancloud.cn/0c/4f/0c4f50687635c66f62caa227c5a11818_705x1265.png) nargs: * 类型：字符串 * 默认值：无 * 描述：命令行参数应当处理的数目 * 可选值：[ argarse.REMAINDER ] ![nargs](https://img.kancloud.cn/ea/5b/ea5bec2487919f64146d853ff0a48e09_717x1235.png) help: * 类型：字符串 * 默认值：无 * 描述：一个此选项作用的简单描述 * 可选值：[ ] metavar: * 类型：列表或字符串 * 默认值：无 * 描述：打印帮助时提示的格式，可选参数的占位名称 * 可选值：[ ] dest: * 类型：字符串 * 默认值：无 * 描述：指定被添加到 parse_args() 所返回对象上的属性名 * 可选值：[ ] choices: * 类型：列表 * 默认值：无 * 描述：可用的参数的容器 * 可选值：[ ] required: * 类型：布尔 * 默认值：无 * 描述：此命令行选项是否可省略 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` # 直接输入参数，必须的位置参数 parser.add_argument("echo") # 操作符号参数，可选参数 parser.add_argument("-SV", "--set_version", help="set version", action="store_true", default='1') parser.add_argument("-I", "--number", type=int, help="get number", choices=[0, 1, 2]) ``` # add_subparsers() ***** 添加子命令 ### 返回类型 ``` _SubParsersAction ``` ### 参数说明 title: * 类型：字符串 * 默认值：无 * 描述：帮助输出中子解析器组的标题 * 可选值：[ ] description: * 类型：字符串 * 默认值：无 * 描述：帮助输出中子解析器组的描述 * 可选值：[ ] prog: * 类型：字符串 * 默认值：无 * 描述：用法信息将与子命令帮助一起显示 * 可选值：[ ] parser_class: * 类型：Parser * 默认值：无 * 描述：用于创建子解析器实例的类 * 可选值：[ ] action: * 类型：字符串 * 默认值：无 * 描述：默认执行动作 * 可选值：[ ] dest: * 类型：字符串 * 默认值：无 * 描述：属性名 * 可选值：[ ] required: * 类型：布尔 * 默认值：无 * 描述：是否必须 * 可选值：[ ] help: * 类型：字符串 * 默认值：无 * 描述：一个此选项作用的简单描述 * 可选值：[ ] metavar: * 类型：列表或字符串 * 默认值：无 * 描述：打印帮助时提示的格式 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` import argparse def install_callback(path): print("install", path) parser = argparse.ArgumentParser(prog='PROG') subparsers = parser.add_subparsers(help='sub-command help') # 添加子命令 add parser_a = subparsers.add_parser('add', help='add help') parser_a.add_argument('-x', type=int, help='x value') parser_a.add_argument('-y', type=int, help='y value') # 添加子命令 sub parser_s = subparsers.add_parser('sub', help='sub help') parser_s.add_argument('-x', type=int, help='x value') parser_s.add_argument('-y', type=int, help='y value') install = subparsers.add_parser("install") install.set_defaults(cb=install_callback) install.add_argument("path") args = parser.parse_args(["install", "hardoor"]) args.cb(args.path) ``` # add_argument_group() ***** 仅仅是概念上的分组，获取时候并不能安装组名获取 ### 参数说明 title: * 类型：字符串 * 默认值：无 * 描述：组名 * 可选值：[ ] description: * 类型：字符串 * 默认值：无 * 描述：描述作用的内容 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) >>> group = parser.add_argument_group('group') >>> group.add_argument('--foo', help='foo help') >>> group.add_argument('bar', help='bar help') >>> parser.print_help() usage: PROG [--foo FOO] bar group: bar bar help --foo FOO foo help ``` # add_mutually_exclusive_group() ***** 添加互斥操作参数组 ### 示例内容 1. 举例说明 ``` # 添加操作参数 group = parser.add_mutually_exclusive_group() # 互斥参数组 group.add_argument("-v", "--verbose", action="store_true") group.add_argument("-q", "--quiet", action="store_true") ``` # set_defaults() ***** 设置默认属性值 ### 示例内容 1. 举例说明 ``` parser = argparse.ArgumentParser() parser.add_argument('foo', type=int) parser.set_defaults(bar=42, baz='badger') parser.parse_args(['736']) 输出结果： Namespace(bar=42, baz='badger', foo=736) ``` # get_default() ***** 获取默认属性值 ### 示例内容 1. 举例说明 ``` parser = argparse.ArgumentParser() parser.add_argument('--foo', default='badger') parser.get_default('foo') 输出结果： 'badger' ``` # format_usage() ***** 定义usage信息格式 # format_help() ***** 定义help信息格式 # print_help() ***** 打印帮助信息 # print_usage() ***** 打印有关应如何在命令行上调用ArgumentParser的简要说明 # exit() ***** 此方法将终结程序，退出时附带指定的 status，并且如果给出了 message 则会在退出前将其打印输出 # error() ***** 此方法将向标准错误打印包括 message 的用法消息并附带状态码 2 终结程序 # parse_known_args() ***** 前缀解析，使用该解析模式产生额外参数会加入一个额外列表而不会报错 # parse_args() ***** 解析参数内容，并返回 ### 参数说明 args: * 类型：字符串 * 默认值：sys.argv * 描述：要解析的字符串列表 * 可选值：[ ] namespace: * 类型：namespace * 默认值：store * 描述：带有属性的对象。默认值为一个新的空命名空间对象。 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` content = parser.parse_args() 获取解析内容，如--number的内容 print(content.number) ``` # parse_known_intermixed_args() ***** 混杂解析已知参数 # parse_intermixed_args() ***** 混杂解析 # argparse.FileType # [new]-FileType() ***** FileType对象 ### 示例内容 1. 举例说明 ``` parser.add_argument('--raw', type=argparse.FileType('wb', 0)) parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8')) parser.parse_args(['--raw', 'raw.dat', 'file.txt']) ``` # argparse.RawDescriptionHelpFormatter # [new]-RawDescriptionHelpFormatter() ***** 可选格式风格，在正文的描述和展示上给与了更多的控制 # argparse.RawTextHelpFormatter # [new]-RawTextHelpFormatter() ***** 可选格式风格，在正文的描述和展示上给与了更多的控制 # argparse.ArgumentDefaultsHelpFormatter # [new]-ArgumentDefaultsHelpFormatter() ***** 可选格式风格，自动添加默认的值的信息到每一个帮助信息的参数中 # argparse.MetavarTypeHelpFormatter # [new]-MetavarTypeHelpFormatter() ***** 可选格式风格，为它的值在每一个参数中使用 type 的参数名当作它的显示名