python-argparse.ArgumentParser()用法解析

Posted 2021-06-04 小猪猪

argparse.ArgumentParser()用法解析

argparse是一个Python模块：命令行选项、参数和子命令解析器。
主要有三个步骤：
创建 ArgumentParser() 对象
调用 add_argument() 方法添加参数
使用 parse_args() 解析添加的参数

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\')

3. 解析参数

parser.parse_args([\'--sum\', \'7\', \'-1\', \'42\'])
Namespace(accumulate=, integers=[7, -1, 42])
1
2
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)

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）

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() 所返回对象上的属性名。

参数源码getopt

def usage():
    print(\'-h help \\n\' \\
          \'-v vmname\\n\' \\
          \'--VmName=vmname\\n\' \\
          \'\')


if __name__ == \'__main__\':
    import getopt
    import sys

    if len(sys.argv) <= 1:
        usage()
        sys.exit()
    try:
        # sys.argv[1:] 取值范围 "hv:"  ：前的一个字母为必选项 [\'VmName=\'] 参数别名
        options, args = getopt.getopt(sys.argv[1:], "hv:", [\'VmName=\'])
        for name, value in options:
            if name in (\'-h\'):
                usage()
            if name in (\'-v\', \'--VmName\'):
                start(value)
    except getopt.GetoptError:
        usage()
        sys.exit()