argparse —— 命令行选项、参数和子命令解析器

1.概述

argparse是一个Python模块：命令行选项、参数和子命令解析器。
argparse模块可以让人轻松地编写出用户友好的命令行接口。程序定义它所需要的参数，然后argparse 可以从 sys.argv 中解析出那些参数。 argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

可以把argparse的使用简化成以下四个步骤

import argparse
parser = argparse.ArgumentParser()
parser.add_argument()
parser.parse_args()

上面四个步骤的解释如下：首先导入该模块；然后创建一个解析对象；然后向该对象中添加你要关注的命令行参数和选项，每一个add_argument方法对应一个你要关注的参数或选项；最后调用parse_args()方法进行解析；解析成功之后即可使用。

2. 实例

import argparse
def parse_args():
    parser = argparse.ArgumentParser(description="you should add those parameter")                                                                    # 会打印这些描述信息，一般只需要传递description参数，如上。
    parser.add_argument('--addresses',default="China", help = "The path of address")
    parser.add_argument('--name', required=True, help = "please give your name")
    parser.add_argument('--man',dest='isMan',action='store_true')
    parser.add_argument(dest='opts',nargs='...')
    args = parser.parse_args()
    return args
if __name__ == '__main__':
    args = parse_args()
    print(args.addresses,args.name,args.isMan,args.opts)

执行结果如下：

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, exit_on_error=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）
  • 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 - 当参数在命令行中出现时使用的动作基本类型【action='store_true'，指触发action时为真，不触发为假；也就是说，只要运行时该变量有传参就将该变量设为True】
  • nargs - 命令行参数应当消耗的数目【即关联多少个命令行参数到单一动作】
  • const - 被一些 action 和 nargs 选择所需求的常数。
  • default - 当参数未在命令行中出现并且也不存在于命名空间对象时所产生的值。
  • type - 命令行参数应当被转换成的类型。
  • choices - 可用的参数的容器。
  • required - 此命令行选项是否可省略 （仅选项可用）。
  • help - 一个此选项作用的简单描述。
  • metavar - 在使用方法消息中使用的参数值示例。
  • dest - 被添加到 parse_args() 所返回对象上的属性名。

参考

https://www.cnblogs.com/yibeimingyue/p/13800159.html
https://blog.csdn.net/The_Time_Runner/article/details/97941409

posted @ 2021-06-27 10:29  MorStar  阅读(227)  评论(0)  编辑  收藏  举报