argparse

@TOC

argparse 官方教程

本文只是作为以后回顾所学知识所用

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

如何使用

1. 创建解析器
   创建一个 ArgumentParser 对象：

   parser = argparse.ArgumentParser(description='Process some integers.')
   
        
        
   
        
        
   1

   ArgumentParser 对象包含将命令行解析成 Python 数据类型所需的全部信息。
2. 添加参数
   通过调用 add_argument() 方法给 ArgumentParser对象添加程序所需的参数信息：

   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)')
   
        
        
   
        
        
   1
   2
   3
   4
   5

   解析参数时将会返回一个具有 integers 和 accumulate 两个属性的对象。integers 属性将是一个包含一个或多个整数的列表，而 accumulate 属性当命令行中指定了 --sum 参数时将是 sum() 函数，否则则是 max() 函数。
3. 解析参数
   通过 parse_args() 方法解析参数：

   parser.parse_args(['--sum', '7', '-1', '42'])
   Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])
   
        
        
   
        
        
   1
   2

   在脚本中，通常 parse_args() 会被不带参数调用，而 ArgumentParser 将自动从 sys.argv 中确定命令行参数。

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]） 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])

   
   

   
   
1

参数说明：

• name or flags - 一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo。
  add_argument() 方法必须知道它是否是一个选项，例如 -f 或 --foo，或是一个位置参数，例如一组文件名。第一个传递给 add_argument() 的参数必须是一系列 flags 或者是一个简单的参数名。选项-f或--foo 位置参数positional argument 'bar’
• action - 当参数在命令行中出现时使用的动作基本类型。
• nargs - 命令行参数应当消耗的数目。
• const - 被一些 action 和 nargs 选择所需求的常数。
• default - 当参数未在命令行中出现时使用的值。
• type - 命令行参数应当被转换成的类型。
• choices - 可用的参数的容器。
• required - 此命令行选项是否可省略 （仅选项可用）。
• help - 一个此选项作用的简单描述。
• metavar - 在使用方法消息中使用的参数值示例。
• dest - 被添加到 parse_args() 所返回对象上的属性名。

3.8 新版功能.
您还可以通过传递 Action 子类或实现相同接口的其他对象来指定任意操作。建议的方法是扩展 Action，覆盖 call 方法和可选的 init 方法。

parse_args() 方法

ArgumentParser.parse_args(args=None, namespace=None)

   
   

   
   
1

参数说明：

• args - 要分析的字符串列表。默认值取自sys.argv。
• namespace -获取属性的对象。默认值是新的空 Namespace对象。