argparse
:用于使用python构建工具时,让可执行python文件可以获取外部参数,形如:
$ command.py [-h|--help]
$ command.py [位置参数] [-可选参数前缀 [可选参数]]
ArgumentParser()
类,包括:帮助参数、位置参数、可选参数。其中:
- 帮助参数无需指定,可以可以直接调用,该命令会显示出你定义过的所有参数的输入要求和帮助信息(
help="xxx"
); - 位置参数按顺序储存,调用时使用位置参数变量名进行调用;
- 可选参数可以用于:从外部接收值;转换选项状态(
action="store_true"
);使用短命令(add_argument('-l', '--long', ...)
);数该参数出现了多少次(action="count"
) - 可选参数和位置参数顺序交叉无关紧要,只需要位置参数们的相对位置正确即可;
- 接受值的参数如果需要限定合法范围,可以使用
choices=[x, y, z, ...]
; - 接受值的参数如果需要指定缺省值(默认是
None
),可以使用default=...
; - 使用
add_mutually_exclusive_group()
为参数添加(一组)互斥的选项,即该组中的可选参数不能同时出现,否则会报错。
import argparse
parser = argparse.ArgumentParser(description="calculate X to the power of Y")
# group = parser.add_mutually_exclusive_group()
# group.add_argument("-v", "--verbose", action="store_true")
# group.add_argument("-q", "--quiet", action="store_true")
# -v --> args.quiet = False
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
# parser.add_argument("-v", "--verbose", action="store_true", help="increase output verbosity")
# -v/--verbose --> args.verbosity = True
# parser.add_argument("-v", "--verbose", action="count", default=0, help="increase output verbosity")
# -v/--verbose --> args.verbosity = 1
# -vv/--verbose --verbose --> args.verbose = 2
# ...
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2], help="increase output verbosity")
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity == 2:
print("Running '{}'".format(__file__))
if args.verbosity == 1:
print("{}^{} == ".format(args.x, args.y), end="")
print(answer)