两大类参数(类型)
- 位置参数:不带 -x和–x,前面不带短杠,必须传递值,给初始值
- 可选参数:变量名带杠,例如 -x or–x,不用传递值,不用给初始值。
一横的是字符形式,两横的是单词形式。
add_argument()函数的参数关键字详解
ArgumentParser.add_argument(name or flags[, action][, nargs][, const][, default][, type][,choices][, required][, help][, metavar ][, dest])
- name or flags:Either a name or a list option strings,e.g. foo or -f,–foo.可以是一个参数有几种名字:
parser.add_argument('-f', '--foo')
,则两个名字都是指这个参数变量。 - action:命令行有此参数的时候 应该采取的操作
- nargs:指定命令行参数的可接受数值的数量,N表示一个整数。:
有几种匹配原则,如?,*,+等几种数值的匹配规则。 - const:操作和标记选择所需要的常量。
- default:如果空缺参数时产生的值。
- type:命令行值应该转换的类型。
- choices:参数允许值的容器。从一组提供的值里选择某个值。
- required:是否可以省略参数。
- help:对参数的简短的描述,当用户请求帮助(使用 -h or --help在命令行),每一个参数的信息将会被显示出来。
- metavar:关键字在help上下文中的替代名字。如果没有设置metavar,则关键字的名字就是在add_argument()函数中的名字。例子如下:
- dest:添加到parse_args()返回的对象中的属性的名称。对于位置参数,dest通常为第一个关键字参数的值,然后作为parse_args对象的属性变量名。对于可选参数,将parse_args的属性变量名设置为dest指定的名字,可以用
args = paser.parse_args() ; answer = args.dest**2
来引用对象属性。
action
ArgumentParser对象会将一个命令行的参数与一个动作绑定。这些动作可以做任何事情,尽管大多数的动作只是向parse_args()返回的对象添加一个属性。
提供的参数如下:
-
store
存储参数的变量值,这个是默认的动作,比如:
-
store_const
存储由const指定的关键字。
-
store_true & store_false
存储bool类型的值:True 或者 False,初始化关键字的值
parser = argparse.ArgumentParser() parser.add_argument('--foo', action='store_true')
parser.add_argument('--bar', action='store_false')
parser.add_argument('--baz', action='store_false')
parser.parse_args('--foo --bar'.split())
Namespace(foo=True, bar=False, baz=True)
- append
将针对一个变量输入的参数,转化为一个列表。
- append_const:存储一个列表,并将const关键字参数指定的值追加到列表中。
- count:计算一个关键字参数出现的次数。然后将值赋值给关键字。
- help:这将为当前解析器中的所有选项打印完整的帮助消息,然后退出。默认情况下,解析器会自动添加到解析器中。
- version:这需要一个 version= keyword 的参数变量在add_argument()函数中,然后输出版本信息。