python argparse理解与实例

argparse包的一个作用是我们可以通过命令行来更改程序中的参数，就是说可以在不修改程序的情况下更改一些需要调整的参数。下面举一个例子。

实例

假设我们写了一个求圆柱体体积的程序：

import math

def cylinder_volume(redius, height):
    vol = math.pi * (redius**2) * height
    return vol

if __name__ == '__main__':
    print(cylinder_volume(2, 4))

程序文件命名为parse_demo.py，用命令行运行这个程序：

我们计算得到半径为2、高为4的圆柱体体积，但如果我们想计算半径为3、高为5圆柱体的体积，我们不得不回到程序中去修改参数。但如果使用了argparse包，我们可以直接在命令行界面修改参数。程序如下（程序中的一些函数参数我们将在后文介绍）。

import math
import argparse

parser = argparse.ArgumentParser(description='Calculate a volume of a cylinder')   # 创建一个解析对象
parser.add_argument('radius', type=int, help='Radius of Cylinder')   # 向该对象中添加你要关注的命令行参数和选项
parser.add_argument('height', type=int, help='Height of Cylinder')
args = parser.parse_args()   # 对变量进行解析，从指定的选项中返回一些数据。变量与相应的数据组成字典的items，存到args字典中

def cylinder_volume(redius, height):
    vol = math.pi * (redius**2) * height
    return vol

if __name__ == '__main__':
    print(cylinder_volume(args.radius, args.height))

用命令行运行这个程序：

我们在python argparse_demo.py后面加了两个数字，第一个数字会被传给radius参数，第二个数字会被传给height参数，因为我们默认使用的是位置参数。通过修改最后两个数字，我们可以很轻松的修改radius和height，计算得到相应的圆柱体体积。

argparse.ArgumentParser()方法参数，一般我们只选择用description

1. description - 命令行帮助的开始文字，大部分情况下，我们只会用到这个参数
2. epilog - 命令行帮助的结尾文字
3. prog - (default: sys.argv[0])程序的名字，一般不需要修改，另外，如果你需要在help中使用到程序的名字，可以使用%(prog)s
4. prefix_chars - 命令的前缀，默认是-，例如-f/–file。有些程序可能希望支持/f这样的选项，可以使用prefix_chars=”/”
5. fromfile_prefix_chars - (default: None)如果你希望命令行参数可以从文件中读取，就可能用到。例如，如果fromfile_prefix_chars=’@’,命令行参数中有一个为”@args.txt”，args.txt的内容会作为命令行参数
6. add_help - 是否增加-h/-help选项 (default: True)，一般help信息都是必须的，所以不用设置。
7. parents - 类型是list，如果这个parser的一些选项跟其他某些parser的选项一样，可以用parents来实现继承，例如parents=[parent_parser]
8. 三个允许的值： # class argparse.RawDescriptionHelpFormatter 直接输出description和epilog的原始形式（不进行自动换行和消除空白的操作） # class argparse.RawTextHelpFormatter 直接输出description和epilog以及add_argument中的help字符串的原始形式（不进行自动换行和消除空白的操作） # class argparse.ArgumentDefaultsHelpFormatter 在每个选项的帮助信息后面输出他们对应的缺省值，如果有设置的话。这个最常用吧！
9. argument_default - (default: None)设置一个全局的选项的缺省值，一般每个选项单独设置，所以这个参数用得少，不细说
10. usage - (default: generated)如果你需要修改usage的信息（usage: PROG [-h] [–foo [FOO]] bar [bar …]），那么可以修改这个，一般不要修改。
11. conflict_handler - 不建议使用。这个在极端情况下才会用到，主要是定义两个add_argument中添加的选项的名字发生冲突时怎么处理，默认处理是抛出异常。

add_argument()方法参数

1. name or flags - 指定参数的形式，想写几个写几个，不过我们一般就写两个，一个短参数，一个长参数，例如”--r”, “--radius”
2. 可选的选项，位置不固定，想怎么写就怎么写，默认是可选的 # parser.add_argument(“-f”, “–file”, help=”test test test”)
3. 位置固定的选项，例如”prog i_am_bar”，这样子的话，i_am_bar就是bar选项的值啦，默认是必须有的 # parser.add_argument(“bar”, help=”test test test”)
4. nargs - 指定这个参数后面的value有多少个，例如，我们希望使用-n 1 2 3 4，来设置n的值为[1, 2, 3, 4] #parser.add_argument(“-n”, “–num”, nargs=”+”, type=int) # 这里nargs=”+”表示，如果你指定了-n选项，那么-n后面至少要跟一个参数，+表示至少一个,?表示一个或0个,0个或多个 。
5. default - 如果命令行没有出现这个选项，那么使用default指定的默认值 #parser.add_argument(“+g”, “++gold”, help=”test test test”,default=”test_gold”)#需要prefix_chars包含”+” 。
6. type - 如果希望传进来的参数是指定的类型（例如 float, int or file等可以从字符串转化过来的类型），可以使用 #parser.add_argument(“-x”, type=int) 。
7. choices - 设置参数值的范围，如果choices中的类型不是字符串，记得指定type哦 #parser.add_argument(“-y”, choices=[‘a’, ‘b’, ‘d’])
8. required - 如果required=True那么参数就是必须提供的了。默认为False.
9. metavar - 参数的名字，在显示帮助信息时才用到. # parser.add_argument(“-o”, metavar=”OOOOOO”)
10. help - 设置这个选项的帮助信息
11. dest - 设置这个选项的值就是解析出来后放到哪个属性中 #parser.add_argument(“-q”, dest=”world”)
12. args = parser.parse_args(args) # 如果你没有args参数，那么就使用sys.argv，也就是命令行参数啦。有这个参数，就方便我们调试啊 。# args.world就是-q的值啦
13. action - The basic type of action to be taken when this argument is encountered at the command line.
14. const - A constant value required by some action and nargs selections.

add_argument()中使用flags参数

对于上面实例中用到的带argparse包的程序， 我们复制如下：

import math
import argparse

parser = argparse.ArgumentParser(description='Calculate a volume of a cylinder')   
parser.add_argument('radius', type=int, help='Radius of Cylinder')   
parser.add_argument('height', type=int, help='Height of Cylinder')
args = parser.parse_args()   

def cylinder_volume(redius, height):
    vol = math.pi * (redius**2) * height
    return vol

if __name__ == '__main__':
    print(cylinder_volume(args.radius, args.height))

 命令行运行：

可以看到出来-h之外，其他的参数都是位置参数。

下面我们对程序的第5，6行以及最后一行进行修改：

import math
import argparse

parser = argparse.ArgumentParser(description='Calculate a volume of a cylinder')
parser.add_argument('--r', '--radius', type=int, help='Radius of Cylinder')
parser.add_argument('--H', '--height', type=int, help='Height of Cylinder')   # 不要用--h，因为--h已经被占用了
args = parser.parse_args()

def cylinder_volume(redius, height):
    vol = math.pi * (redius**2) * height
    return vol

if __name__ == '__main__':
    print(cylinder_volume(args.r, args.H))

命令行运行：

可以看到，参数都变为optional参数了。

命令行运行：

这时--H和--r的位置可以随意安排了。

互斥参数：mutually exclusive arguments

我们可以在程序中创建一个互斥组，argparse 将会确保互斥组中只有一个参数在命令行中可用。

import math
import argparse

parser = argparse.ArgumentParser(description='Calculate a volume of a cylinder')
parser.add_argument('--r', '--radius', type=int, help='Radius of Cylinder')
parser.add_argument('--H', '--height', type=int, help='Height of Cylinder')
group = parser.add_mutually_exclusive_group()   # 创建一个互斥组，argparse 将会确保互斥组中只有一个参数在命令行中可用
group.add_argument('--q', '--quiet', action='store_true', help='print quiet')   # action='store_true'意味着当我们在命令行给了该参数时，
                                                                                # 该参数但是为True，没给该参数时，它为False
group.add_argument('--v', '--verbose', action='store_true', help='print verbose')
args = parser.parse_args()

def cylinder_volume(redius, height):
    vol = math.pi * (redius**2) * height
    return vol

if __name__ == '__main__':
    volume = cylinder_volume(args.r, args.H)
    if args.q:
        print(volume)
    elif args.v:
        print('Volume of a Cylinder with radius {} and height {} is {:.3f}'.format(args.r, args.H, volume))
    else:
        print('Volume of Cylinder {}'.format(volume))

程序中，我们创建了一个互斥参数组，包含'--q'和'--v'，我们只需给其中一个，也可以一个都不给：

需注意的是，add_mutually_exclusive_group()方法也接受一个 required 参数，表示在互斥组中至少有一个参数是需要的，但互斥参数组目前不支持持 add_argument_group() 的 title 和 description 参数。

参考资料

[1] Python_argparse命令行参数解析包 哔哩哔哩视频

[2] python3中argparse模块详解