argparse 是 Python 内置的一个用于命令项选项与参数解析的模块,通过在程序中定义好我们需要的参数,argparse 将会从 sys.argv 中解析出这些参数,并自动生成帮助和使用信息。
主要有三个步骤
创建 ArgumentParser()
调用 add_argument() 方法添加参数
使用 parse_args() 解析添加的
*实现:
import argpars//导入命令行解析的库文件
parser = argparse.ArgumentParser()//创建一个解析对象
parser.add_argument('integer', type=int, help='display an integer')//向该对象中添加你要关注的命令行参数和选项,说明integer是一个必须的参数,
args = parser.parse_args() //进行解析
print args.integer
add_argument() 方法
add_argument() 方法定义如何解析命令行参数:
ArgumentParser.add_argument(name or flags…[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
每个参数解释如下:
name or flags - 选项字符串的名字或者列表,例如 foo 或者 -f, --foo。
action :命令行遇到参数时的动作,默认值是 store。
append:将遇到的值存储成列表,也就是如果参数重复则会保存多个值;
count:存储遇到的次数;此外,也可以继承 argparse.Action 自定义参数解析;
nargs:应该读取的命令行参数个数,可以是具体的数字,或者是?号,当不指定值时对于 Positional argument 使用 default,对于 Optional argument 使用 const;或者是 * 号,表示 0 或多个参数;或者是 + 号表示 1 或多个参数。
default :不指定参数时的默认值。
type :命令行参数应该被转换成的类型。(指定参数类型)
choices :参数可允许的值的一个容器。设置参数的范围,如果choice中的类型不是字符串,要指定type::表示该参数能接受的值只能来自某几个值候选值中,除此之外会报错,用choice参数即可
required : 可选参数是否可以省略 (仅针对可选参数)。必需参数,通常-f这样的选项是可选的,但是如果required=True那么就是必须的了
help :参数的帮助信息,当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
metavar :在 usage 说明中的参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写的参数名称.
dest :解析后的参数名称,默认情况下,对于可选参数选取最长的名称,中划线转换为下划线.
action :表示值赋予键的方式,这里用到的是bool类型,action意思是当读取的参数中出现指定参数的时候的行为