Python脚本argparse使用(内附python教程分享)
Python的脚本可以自然而然写成可运行脚本,在文件头加入
#!/usr/bin/env python
或者
#!/usr/bin/python
即可。当然也可以通过执行python target.py来运行脚本。实际编写Python脚本的时候,需要考虑编写参数,当可选参数比较多的时候,通过sys.argv是非常麻烦的。幸好Python自带argparse工具帮助我们快速实现各种参数,而且自动生成帮助文档,这里介绍其基本使用方法。
最基本配置
如果一个脚本没有参数,只有帮助文档,Python脚本可以写作
#!/usr/bin/env python import argparse parser = argparse.ArgumentParser() # 生成参数分析器 parser.parse_args()
此时,该脚本为无参数脚本,一系列运行结果为
./prog_base.py -h usage: prog_base.py [-h] optional arguments: -h, --help show this help message and exit
如果添加错误的参数信息,会自动输出错误提示,例如我们添加可选参数--verbose
> ./prog_base.py --verbose usage: prog_base.py [-h] prog_base.py: error: unrecognized arguments: --verbose
会自动告诉用户未识别该参数。
添加位置参数
位置参数一般是命令的主要参数,一般在命令最尾端,例如我们希望编写一个简单的脚本,将一个位置参数的值输出,Python代码写作
import argparse parser = argparse.ArgumentParser() # 生成参数分析器 parser.add_argument("echo") # 添加位置参数 args = parser.parse_args() print args.echo
此时,python脚本会将参数值输出
> python prog_pos.py haha haha
如果没有添加参数则会报错
> python prog_pos.py usage: prog_pos.py [-h] echo prog_pos.py: error: too few arguments
并且可以使用-h或者--help参数查看脚本帮助文档
> python prog_pos.py haha -h usage: prog_pos.py [-h] echo positional arguments: echo optional arguments: -h, --help show this help message and exit
可以发现现在echo没有任何帮助说明,要启用非常简单,在添加这个参数的时候加入help可选参数即可,如
parser.add_argument("echo", help = "echo the string you use here")
同时Python的 argparse可以给定输入类型,比如我们想写一个计算输入平方数的程序,假定调用方法为
prog_square.py [-h] number
我们可以这样编写脚本
import argparse parser = argparse.ArgumentParser() parser.add_argument("number", help="display a square of a given number", type=int) args = parser.parse_args() print args.square**2
在add_argument的时候指定其可选参数type为int类型,则在分析输入命令的时候会自动解析为整数型,此时调用结果为
> python prog_square.py 4 16
可以发现使用Python的argparse非常方便易用。
可选参数添加
比如我们想给一个脚本添加一个打印详细程度的指标,当verbose开启的时候会打印出相应的信息。
import argparse parser = argparse.ArgumentParser() parser.add_argument("--verbose", help="increase output verbosity") args = parser.parse_args() if args.verbose: print "verbosity turned on"
当直接运行脚本的时候没有任何输出,当加入verbose之后会打印出多出来的内容
> python prog_verbose.py > python prog_verbose.py --verbose verbosity turned on
小结
有了这些基本功能,可以使用Python写出功能很强的执行脚本,个人觉得比bash好用一些。
最后,想学习Python的小伙伴们!
请关注+私信回复:“学习”就可以拿到一份我为大家准备的Python学习资料!
pytyhon学习资料
python学习资料