简介

argparse相当于optparse的升级版，optparse模块已经不再维护，新代码最好使用argparse模块
argparse对比optparse模块有以下优势

• 处理位置参数。
• 支持子命令。
• 允许替代选项前缀例如 + 和 /。
• 处理零个或多个以及一个或多个风格的参数。
• 生成更具信息量的用法消息。
• 提供用于定制 type 和 action 的更为简单的接口。

用法步骤与optparse模块类似，先通过一个实例来整体看下argparse模块的用法

一个实例

import argparse

parser = argparse.ArgumentParser(description='simple test for argparse')

parser.add_argument('-o', '--output', dest='filename', help='write to file')
parser.add_argument('-v', '--verbose', action='store_true', default=False, help='print status messages to stdout')
parser.add_argument('-n', dest='num', metavar='NUMBER', type=int, default=0, help='print status messages to stdout')
parser.add_argument('--version', action='version', version='1.0')

subparser = parser.add_subparsers(help='sub command help')
parser_a = subparser.add_parser('cal', help='help for sub commd "a"')
parser_a.add_argument('--sum', dest='accumulate', action='store_const', const=sum, default=max, help='sum the integers (default: find the max)')
parser_a.add_argument('integers', metavar='N', type=int, nargs='+', help='an integer for the accumulator')
parser_a.add_argument('--version', action='version', version='1.0')

args = parser.parse_args()

print(args)
print(args.accumulate(args.integers))

从实例源码来看与optparse模块很像，也有一些新的特性，像子命令（subparser），并且帮助文档也比optparse模块更合理，像位置参数与选项参数分开显示，如下

PS D:\scan\python> python .\argparseTest.py -h       
usage: argparseTest.py [-h] [-o FILENAME] [-v] [-n NUMBER] [--version] {cal} ...

simple test for argparse

positional arguments:
  {cal}                 sub command help                       # 带大括号的表示子命令
    cal                 help for sub commd "a"

optional arguments:
  -h, --help            show this help message and exit
  -o FILENAME, --output FILENAME
                        write to file
  -v, --verbose         print status messages to stdout
  -n NUMBER             print status messages to stdout
  --version             show program's version number and exit
PS D:\scan\python>

模块用法

模块用法与optparse模块类似，也是分为三步：创建解析器对象、添加参数、解析参数

创建解析器对象

• 此模块无需显示的添加usage信息，可以根据后面添加的参数自动解析
• 版本信息作为命令选项参数添加，而不再在这里添加
• 可以使用prog参数指定usage信息中程序的名称，例如上面例子中默认显示的是argparseTest.py，可以通过prog='argparseTest'将后缀名去掉，也可以指定自定义的名称
• description参数可以描述本程序的简介信息，是最常用的一个参数

其他的参数可以参考官方文档:argumentparser-objects

添加参数

添加选项的接口原型

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

• name or flags表示选项名称，可以是短选项、也可以是长选项，也可以两者并存

• action中增加了一个version，用于处理程序版本信息

• nargs表示命令行参数应该消耗的数目，也即一个参数对应于命令行中非选项参数的个数，有以下几种取值

  1. nargs=[number]通过具体数值限制一个参数要对应到命令行中number个非选项参数，聚成一个列表，不管命令行中对应参数是多还是少，都会报错

     import argparse
     
     parser = argparse.ArgumentParser()
     parser.add_argument('a', nargs=1)
     parser.add_argument('-b', nargs=2)
     
     args = parser.parse_args()
     
     print(args)
     

     使用及输出如下：

     PS D:\scan\python> python .\testarg.py -h   
     usage: testarg.py [-h] [-b B B] a
     
     positional arguments:
       a
     
     optional arguments:
       -h, --help  show this help message and exit
       -b B B
     PS D:\scan\python> python .\testarg.py 1 
     Namespace(a=['1'], b=None)
     PS D:\scan\python>
     PS D:\scan\python> python .\testarg.py 1 -b 2
     usage: testarg.py [-h] [-b B B] a
     testarg.py: error: argument -b: expected 2 arguments
     PS D:\scan\python> python .\testarg.py 1 -b 2 3
     Namespace(a=['1'], b=['2', '3'])
     PS D:\scan\python> python .\testarg.py 0 1 -b 2 3
     usage: testarg.py [-h] [-b B B] a
     testarg.py: error: unrecognized arguments: 1
     PS D:\scan\python>
     

  2. nargs=?的一个更普遍用法是允许可选的输入或输出文件

     >>> parser = argparse.ArgumentParser()
     >>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'),
     ...                     default=sys.stdin)
     >>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
     ...                     default=sys.stdout)
     >>> parser.parse_args(['input.txt', 'output.txt'])
     Namespace(infile=<_io.TextIOWrapper name='input.txt' encoding='UTF-8'>,
               outfile=<_io.TextIOWrapper name='output.txt' encoding='UTF-8'>)
     >>> parser.parse_args([])
     Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>,
               outfile=<_io.TextIOWrapper name='<stdout>' encoding='UTF-8'>)
     

  3. nargs=*，所有当前命令行参数被聚集到一个列表中。可以有0个或者多个
  4. nargs=+，所有当前命令行参数被聚集到一个列表中。可以有1个或者多个

• 其他参数说明参考官方文档：the-add-argument-method

另外一个比较常用的是子命令接口

ArgumentParser.add_subparsers([title][, description][, prog][, parser_class][, action][, option_string][, dest][, required][, help][, metavar])

参数说明参考官方文档：sub-commands

解析参数

接口原型

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

返回一个列表，包含添加的所有的参数，可以通过.来访问

参考

本章学习了argparse模块最常用的一些用法，大部分场景已经可以满足要求
还有更多好用的特性，可以参考官方文档说明：argparse模块