工作中经常需要写一写python的脚本, 脚本的功能是可以完成, 但是过了一段时间以后不使用就会忘记脚本的使用方法, 总不能经常去看脚本的代码吧, 这个时候就需要写一份漂亮的脚本帮助信息了, 这里主要说一下标准库里自带的模块argparse
.
import argparse
parser = argparse.ArgumentParser(description="简单的发邮件脚本!")
parser.add_argument("-n", "--name", dest="mingzi", type=str, default="rocky", metavar="姓名", nargs="*", help="输入用户的姓名")
parser.add_argument("-a", "--age", dest="age", type=int, default=27, metavar="年龄", help="请输入年龄", required=True)
parser.add_argument('--move', choices=['rock', 'paper', 'scissors'])
args = parser.parse_args()
print(args.mingzi)
print(args.age)
print(args.move)
执行后的效果如下:
(pyenv3) rocky@homemac ~/tmp python test.py --help
usage: test.py [-h] [-n [姓名 [姓名 ...]]] -a 年龄 [--move {rock,paper,scissors}]
简单的发邮件脚本!
optional arguments:
-h, --help show this help message and exit
-n [姓名 [姓名 ...]], --name [姓名 [姓名 ...]]
输入用户的姓名
-a 年龄, --age 年龄 请输入年龄
--move {rock,paper,scissors}
(pyenv3) rocky@homemac ~/tmp python test.py --move rock -a 12 -n abc def
['abc', 'def']
12
rock