一、基本概念
argparse是Python用于解析命令行参数和选项的标准模块,用于代替过时的optparse模块。argparse模块的作用是用于解析命令行参数。
二、基本使用
import argparse
parser = argparse.ArgumentParser()
parser.add_argument()
parser.parse_args()
首先导入模块;然后创建一个解析对象;再向该对象中添加你要关注的命令行参数和选项,每一个add_argument()方法对应一个你要关注的参数或选项;最后调用parse_args()方法进行解析
方法ArgumentParser
ArgumentParser(prog=None, usage=None,description=None, epilog=None, parents=
[],formatter_class=argparse.HelpFormatter, prefix_chars='-',fromfile_prefix_chars=None,
argument_default=None,conflict_handler='error', add_help=True)
这些参数都有默认值,当调用parser.print_help()或者运行程序时由于参数不正确(此时python解释器其实也是调用了print_help()方法)时,会打印这些描述信息,一般只需要传递description参数
方法add_argument
add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][,
help][, metavar][, dest])
其中:
- name or flags:命令行参数名或者选项,如上面的address或者-p,–port.其中命令行参数如果没给定,且没有设置defualt,则出错。但是如果是选项的话,则设置为None
- nargs:命令行参数的个数,一般使用通配符表示,其中,’?’表示只用一个,’*’表示0到多个,’+’表示至少一个
- default:默认值
- type:参数的类型,默认是字符串string类型,还有float、int等类型
- help:和ArgumentParser方法中的参数作用相似,出现的场合也一致
示例演示
#-*-coding: UTF-8 -*-
import argparse
import sys
def ParseArgs():
parser = argparse.ArgumentParser(description = "Test argparse")
parser.add_argument('-r', "--filepath", type = unicode)
args = parser.parse_args()
return args
if __name__ == "__main__":
print sys.argv
args = ParseArgs()
print "The filepath is:", args.filepath
在cmd中 输入 Python TestargParse.py -r C:\test.txt
运行结果如下:
通过sys.argv获得所输入的内容,包括参数;然后通过argparse去解析,得到对应参数的值。