Python_argparse.Argumentparser()

纵饮孤独 提交于 2020-02-13 17:29:37

argparse模块简介

官方文档

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

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

argparse使用流程

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()方法解析参数。

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

add_argument()方法

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
  1. name or flags - 一个命名或者一个选项字符串的列表,例如 foo 或 -f, --foo。
  2. action - 当参数在命令行中出现时使用的动作基本类型。
  3. nargs - 命令行参数应当消耗的数目。
  4. const - 被一些 action 和 nargs 选择所需求的常数。
  5. default - 当参数未在命令行中出现时使用的值。
  6. type - 命令行参数应当被转换成的类型。
  7. choices - 可用的参数的容器。
  8. required - 此命令行选项是否可省略 (仅选项可用)。
  9. help - 一个此选项作用的简单描述。
  10. metavar - 在使用方法消息中使用的参数值示例。
  11. dest - 被添加到 parse_args() 所返回对象上的属性名。
标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!