Python进阶话题杂谈（八）argparse模块

argparse模块是Python中最重要的模块之一，其用于命令行参数解析。此模块的内容非常复杂，本文只选取其中较为实用的部分进行讨论。

使用argparse主要分为三个部分，第一部分是创建一个解析器实例：

parser = argparse.ArgumentParser()

第二部分为多次调用add_argument函数添加命令行参数，每一次add_argument函数的调用都对应于一个命令行参数的配置。add_argument函数的主要参数如下：

第一、二位置参数：用于设定一个参数的单横线或双横线参数名，或同时设定这二者。注意，单横线参数名只能使用单个字母，多于一个字母的参数名则必须使用双横线。

以下参数均为add_argument函数的关键字参数：

action：主要用于将普通参数修改为开关参数。当此参数被设定为字符串store_true时，当前命令行参数变为无需参数的开关参数，如果给出此命令行参数，则参数值解析为True，如果不给出，则解析为False。反之，如果action设定为字符串store_false，则开关参数给出时，参数被解析为False，不给出时，才解析为True。

nargs：默认情况下，一个命令行参数只能接一个后续参数值，而如果将nargs设定为字符串星号或加号时，当前参数将自动被解析为列表，且可以在一个命令行参数后给出多个值。星号与加号的区别类似于正则表达式：星号代表能够接受0到任意数量的参数，而加号则表示参数至少需要给出一个。此参数也可给定为一个具体的整数，则参数数量必须严格等于该值。

default：用于设定默认值。当没有为这个命令行参数给出值时，就使用此默认值。

type：给定为一个函数，默认为str。一般可给定为int或float，可将字符串形式的参数通过指定的函数转换为其他类型。

required：默认为False，此时当不给出这个参数时，命令行参数就将被解析为None。而如果指定为True，则该命令行参数必须给出，否则程序将报错。

help：指定为一个帮助字符串。这个字符串将显示在调用-h命令时。

dest：指定为一个变量名，用于后续的parse_args函数。

argparse的第三部分为通过parse_args函数将参数解析。此函数返回一个对象，对此对象进行属性访问即可获取到各个命令行参数。而属性的名称遵循以下规则：如果某个参数定义了dest参数，则使用这个参数作为属性名，如果没有，则使用去掉横线的位置参数名作为属性名，如-i参数就对应于i属性。

以下通过一个完整的函数说明上文的各种用法：

import argparse

def _inputArguments():

   parser = argparse.ArgumentParser()

   parser.add_argument('-a', '--aa',

       help = 'Argument: A')

   parser.add_argument('-b', dest = 'bbb', required = True, nargs = '*',

       help = 'Argument: B')

   parser.add_argument('-c', action = 'store_true',

       help = 'Argument: C')

   parser.add_argument('-d', type = int, default = 1,

       help = 'Argument: D')

   args = parser.parse_args()

   return args.aa, args.bbb, args.c, args.d

print(_inputArguments())

首先，argparse将自动定义-h与—help参数，用于生成帮助信息。而上述代码定义了四个参数，A参数为较普通的参数，通过-a或—aa进行给定。B参数为一个必须给出的不定长参数，给出的各个参数之间以空格隔开即可，如：-b 1 2 3，则此参数就将被解析为：['1', '2', '3']。如果不给出b参数，程序将报错，且由于设定了dest参数，故解析时此参数应使用dest参数所给出的属性名，而不是b。C参数为一个开关参数，如果给出-c，则解析出的args.c为True，否则为False。D参数为一个类型为整形的参数，默认值为1，如果给出D参数，则参数将自动套用int函数转为整数，否则如果不给出此参数，则默认为1。

2018年6月于苏州