Python里的argparse模块浅析

背景：计算一个圆柱体的体积

一、不使用argparse模块实现，在命令行运行程序

import math

def calculate_volume(radius, height):
    vol = (math.pi) * (radius ** 2) * height
    return vol

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

输出结果如下：

二、使用argparse来通过命令行输入参数

import math
import argparse

# 根据argparse工具包里的ArgumentParser类创造一个解析对象，创造的这个对象就是一个用来装载参数的容器
parser = argparse.ArgumentParser(description='Calculate volume of Cylinder')

# 调用这个对象里的add_argument方法，给这个解析对象添加几个命令行参数
'''
    1、要修改这个参数的数据类型为int，因为他的默认参数类型是str
    2、在没有指定required的参数的时候，若有一个值没有指定参数，它会默认被赋予None
'''
parser.add_argument('-r', '--radius', type=int, metavar='', help='Radius of Cylinder')
parser.add_argument('-H', '--height', type=int, metavar='', help='Height of Cylinder')

# 把parser中设置的所有"add_argument"给返回到args子类实例当中
# 那么parser中增加的属性内容都会在args实例中，使用即可。（添加的参数都是作为这个对象的属性可以被使用）
args = parser.parse_args()

def calculate_volume(radius, height):
    vol = (math.pi) * (radius ** 2) * height
    return vol

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

程序的输出结果如下，此时可以在命令行通过参数来指定输入数据：

Note: 未加入required选项的时候只输入一个参数会报错，如下图所示

• 因为未指定required参数的时候，少输入了一个参数的情况下，python会默认给缺省的参数赋值为None，而带入圆柱体的体积计算结果是不正确的，因此报错，所以我们要在添加参数的时候指定required=True，来确保命令行输入参数的时候一定需要完整的输入两个参数。如下所示：

parser.add_argument('-r', '--radius', type=int, required=True, metavar='', help='Radius of Cylinder')
parser.add_argument('-H', '--height', type=int, required=True, metavar='', help='Height of Cylinder')

此时若缺省一个参数，会报错：

三、parse_known_args()与parse_args()的区别

上面的情形使用的是parse_args()：

平时也会见到下面这种：

那么他们之间的区别是什么呢：

parse_known_args()与parse_args()的区别就在于，有时候一个脚本只需要解析所有命令行参数中的一小部分，剩下的命令行参数给另一个脚本或者程序。在这种情况下，parse_known_args()就很有用。它很像parse_args()，但是它在接受到多余的命令行参数时不报错。相反的，返回一个tuple类型的命名空间和一个保存着余下的命令行字符的list。

举例如下：

import math
import argparse

# 创建一个解析器
parser = argparse.ArgumentParser(description='Calculate volume of Cylinder')
parser.add_argument('-r', '--radius', type=int, required=True, metavar='', help='Radius of Cylinder')
parser.add_argument('-H', '--height', type=int, required=True, metavar='', help='Height of Cylinder')
args, unparsed = parser.parse_known_args()

def calculate_volume(radius, height):
    vol = (math.pi) * (radius ** 2) * height
    return vol

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

程序运行结果如下：

可以见得，输入到该程序的有用的参数直接被调用，未在此程序使用的参数则通过列表的形式被保存起来了，可能在调用的别的程序里会被用到。

参考文章：

关于参数里的action可以参考这个