argparse
是一个用来解析命令行参数的 Python 库,它是 Python 标准库的一部分。argparse 模块使编写用户友好的命令行界面变得容易。程序定义了所需的参数,而 argparse 将找出如何从 sys.argv (命令行)中解析这些参数。argparse 模块还会自动生成帮助和使用消息,并在用户为程序提供无效参数时发出错误。
使用argparse
的主要步骤:
- 导入
argparse
包;- 创建
ArgumentParser()
参数对象;- 调用
add_argument()
方法往参数对象中添加参数;- 使用
parse_args()
解析添加参数的参数对象,获得解析对象;程序的其他部分需要使用命令行参数时,用解析对象.参数
获取。
import math
import argparse # 1、导入argpase包
def parse_args():
parse = argparse.ArgumentParser(description='Calculate cylinder volume') # 2、创建参数对象
parse.add_argument('radius', type=int, help='Radius of Cylinder') # 3、往参数对象添加参数
parse.add_argument('height', type=int, help='height of Cylinder')
args = parse.parse_args() # 4、解析参数对象获得解析对象
return args
# 计算圆柱体积
def cal_vol(radius, height):
vol = math.pi * pow(radius, 2) * height
return vol
if __name__ == '__main__':
args = parse_args()
print(cal_vol(args.radius, args.height)) # 5、使用解析对象.参数获取使用命令行参数
- 命令行参数输入默认按顺序赋值,顺序不同会造成结果不同;
- 默认命令
-h
可以获取添加参数时设置的帮助信息;
parse.add_argument('--radius', default=2, type=int, help='Radius of Cylinder')
通过在参数名前加
--
,设置为可选参数。如果未输入,则使用default
默认值(若未设置default
,则会默认赋值None
)。
parse.add_argument('-r', '--radius', default=2, type=int, help='Radius of Cylinder')
通过将可选参数设置引用名,可以缩短参数名
-r
,简化命令行参数输入。
parse.add_argument('-r', '--radius', default=2, type=int, metavar='', help='Radius of Cylinder')
metavar
在通过-h
显示usage
明中的参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写的参数名称。这里通过设置为空一律不显示。
parse.add_argument('-r', '--radius', default=2, type=int, metavar='', required=True, help='Radius of Cylinder')
当通过设置
required=True
后,无论参数是否是可选参数,都必须输入。
def parse_args():
parse = argparse.ArgumentParser(description='Calculate cylinder volume')
parse.add_argument('-n', '--num', type=int, nargs='+', metavar='', required=True, help='a string of nums')
args = parse.parse_args()
return args
# 1、在参数对象中添加互斥组
group = parse.add_mutually_exclusive_group()
# 2、在互斥组中添加参数(store_true默认当命令行未输入参数则为False,否则为True)
group.add_argument('-b', '--brief', action='store_true', help='print brief message')
group.add_argument('-v', '--verbose', action='store_true', help='print verbose message')
命令行中
b
和v
只能输入二者中的一个参数。
parse.set_defaults(height=4)
set_defaults()
可以设置一些参数的默认值。
【参考】