用户友好型模块argparse

1.简介

argparse 是 Python 的一个模块，用于编写用户友好的命令行接口。其主要作用是处理命令行参数。它使得开发者能够轻松地为 Python 脚本或程序定义、解析和使用命令行参数。
是Python 标准库的一部分，因此无需安装额外的包即可使用，它是编写需要命令行界面的 Python 程序时的有用工具。

argparse 中文文档

2.主要功能

参数解析：argparse 能够自动解析命令行参数，并将其转换为 Python 数据类型。
生成帮助信息：当用户在命令行中使用 -h 或 --help 选项时，argparse 能够显示自动生成的帮助信息。
生成使用手册：argparse 能够为程序生成使用手册，说明如何使用程序及其参数。
数据类型转换：argparse 允许你指定每个参数的数据类型，如整数、浮点数、字符串等。
默认值：可以为参数指定默认值，如果用户没有提供该参数，将使用默认值。
可选参数和位置参数：支持定义可选参数（如使用 --option 指定的参数）和位置参数（按特定顺序提供的参数）。
参数冲突检查：argparse 能够检查参数之间的冲突，并给出错误提示。
子命令处理：argparse 支持子命令（如 git commit 中的 commit）的处理。

3.示例用法

import argparse

# 创建 ArgumentParser 对象
parser = argparse.ArgumentParser()

# 添加参数
parse.add_argument('-i', '--image', required=True, help='path to input image')
parse.add_argument('-t', '--template', required=True, help='path to template ocr image')

# 解析命令行参数
args = vars(parse.parse_args())

# 使用参数
img = cv2.imread(args['template'])
img2 = cv2.imread(args['image'])
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

示例中，程序定义了一个必选参数 --i。用户可以执行类似 python script.py --i txt.png 的命令来运行程序。