不知道大家有没有发现,最近给大家分享的Python项目的使用文档,使用了Python自带的argparse模块。今天给大家分享一下这个模块的使用。在使用命令时,通常使用-h查看命令帮助文档。例如:使用rm-h查看如何删除文件rm-h再比如使用pip-h查看如何安装Python包pip-h可以发现这两个命令的帮助文档在格式上有些相似,这表明命令行的帮助文档都遵循一定的模式。只要有例程,就一定有相应的模块供我们使用。这里所说的模块就是文章开头提到的argparse。下面分享一下argparse的使用方法,并为程序添加专业文档。首先,我们模仿pip命令,创建一个命令parse_args()ifargs.command=='install':print('installpythonpackage')上面代码只有一个必带参数命令,使用-h查看帮助文档pythonmy_pip.py-hmodule会自动帮助我们生成帮助文档。在上面的代码中,我们只实现了install命令,我们可以执行一下看看效果pythonmy_pip.pyinstall除了必须的参数外,我们还可以在解析器中添加可选参数。importargparseif__name__=='__main__':parser=argparse.ArgumentParser()parser.add_argument('command',help='executedcommand,install,uninstall')parser.add_argument('-i',default='https://pypi.org/simple',help='安装包镜像')parser.add_argument('--timeout',default='60',help='设置超时时间')parser.add_argument('-V','--version',action='version',help='查看版本',version='1.2.1')??args=parser.parse_args()ifargs.command=='install':print('安装pythonpackage')print(args.i)print(args.timeout)可选参数以-或--开头。如果add_argument函数中同时有-parameters和--parameters,说明它们是等价的,比如:-V和--version是用来查看版本的。使用-h参数看帮助文档pythonmy_pip.py-h执行看效果pythonmy_pip.pyinstall-ixxx.com--timeout3执行安装命令,加入两个可选参数-i和--version,用于指定安装包地址和网络超时时间。这两个参数有默认值。如果在执行命令时不添加该参数,则使用默认值。pythonmy_pip.pyinstall最后用-V和--version查看当前程序的版本,在add_argument中指定action参数,表示使用该参数后执行的动作是查看版本。参数version=1.2.1是要返回的版本值。pythonmy_pip.py--version或pythonmy_pip.py-Vaction除了version之外还有其他值,含义也比较简单。您可以在官方网站上查看。add_argument函数还有一个比较常用的参数类型,用来指定参数的数据类型。argparse模块可以帮助我们快速创建程序帮助文档,使用起来非常简单,以后写程序的时候可以直接使用。以上就是本次分享的全部内容。觉得文章还不错的话,请关注公众号:Python编程学习圈,每日干货分享,发送“J”还能领取大量学习资料。或者去编程学习网了解更多编程技术知识。
