argparse库的作用及其用法详解

一、背景

当一个项目的输入参数较多,且要进行修改和调试时,经常涉及到参数的格式和路径问题。如果一行一行去进行修改代码,会非常繁琐且错误率很高。argparse模块就是为了解决这个问题。

二、作用

argparse 是python自带的命令行参数解析包,也就是传入参数的库,可以用来方便地读取命令行参数。该模块统一从命令行中调用需要使用的参数或文件路径,可以一次性完成输入参数读取工作,且更改起来比较方便,对于用户更加友好。

三、步骤和用法

3.1 导入argparse库

import argparse

3.2 创建一个解析对象

ape = argparse.ArgumentParser(description= '命令行中传入参数')

ArgumentParser 对象包含将命令行解析成 python 数据类型所需的全部信息。其中description中字符串是该解析端口的自定义解释说明。

用法:ArgumentParser对象

class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)
  • prog :程序的名称(默认:sys.argv[0])
  • usage :描述程序用途的字符串(默认值:从添加到解析器的参数生成)
  • description :在参数帮助文档之前显示的文本(默认值:无)
  • epilog :在帮助文档之后显示的文本(默认值:无)
  • parents :一个ArgumentParser对象的列表,它们的参数也应包含在内
  • formatter_class :用于自定义帮助文档输出格式的类
  • prefix_chars :可选参数的前缀字符集合(默认值:'-‘)
  • fromfile_prefix_chars :当需要从文件中读取其他参数时,用于标识文件名的前缀字符集合(默认值:None)
  • argument_default :参数的全局默认值(默认值:None)
  • conflict_handler :解决冲突选项的策略(通常是不必要的)
  • add_help :为解析器添加一个 -h/-help 选项(默认值:True)
  • allow_abbrev :如果缩写是无歧义的,则允许缩写长选项(默认值:True)

3.3 通过add_argument方法添加参数

ape.add_argument("-i ", "--image", required=True, help="path to input image")
ape.add_argument("-t", "--template", required=True, help="path to template OCR-A image")

向该对象中添加了命令行参数和选项,每一个add_argument方法对应一个参数或选项。

用法:add_argument方法

ape.add_argument(name...[, action][, nargs][, default][, type][, choices][, required][, help])

在这里插入图片描述

3.4 调用parse_args()方法解析参数

args = vars(ape.parse_args())

该语句表示对参数进行解析,输入的参数储存到args中。

四、调试方式

例子:通过Pycharm将项目一些图片输入,且在调试过程中,完成图片的更换。

import argparse

ap = argparse.ArgumentParser()#创造一个解析器对象
ap.add_argument("-i ", "--image", required=True, help="path to input image")#添加image的
ap.add_argument("-t", "--template", required=True, help="path to template OCR-A image")#添加template的
args = vars(ap.parse_args())

首次运行项目,需要在Configuration的Parameters中按照如下格式添加:(注意空格)

-i 路径加image文件名称 -t 路径加template文件名称

如下图
在这里插入图片描述
若要更换同路径的其他文件,直接修改名称即可。
在这里插入图片描述

参考:argparse官方文档argparse库教程argparse.ArgumentParser()用法解析

猜你喜欢

转载自blog.csdn.net/weixin_43555555/article/details/129143847