argparse模块简单使用

概述

argparse 是 Python 标准库中用于解析命令行参数的模块，它提供了一个简单而灵活的方式来处理命令行输入。使用 argparse 可以轻松地定义命令行参数，自动生成帮助文档，并且处理用户输入的参数。

使用步骤

当我们使用 argparse 模块时，我们通常会按照以下步骤进行：

1. 导入 argparse 模块。
2. 创建一个 ArgumentParser 对象。
3. 使用 add_argument 方法添加命令行参数。
4. 调用 parse_args() 方法解析命令行参数。
5. 使用解析得到的参数值进行后续操作。

让我们使用你提供的代码作为示例来详细解释每一步：

import argparse

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

# 2. 添加命令行参数
# 添加 --image 参数，短格式为 -i，类型为字符串，默认值为 'path/to/your/image.jpg'，帮助信息为 'Path to the input image.'
parser.add_argument('--image', '-i', type=str, default='path/to/your/image.jpg', help='Path to the input image.')

# 添加 --video 参数，短格式为 -v，类型为字符串，默认值为 'path/to/your/video.mp4'，帮助信息为 'Path to the input video.'
parser.add_argument('--video', '-v', type=str, default='path/to/your/video.mp4', help='Path to the input video.')

# 3. 解析命令行参数
args = parser.parse_args()

# 4. 使用解析得到的参数值进行后续操作
# 获取 image 参数的值
image_path = args.image

# 获取 video 参数的值
video_path = args.video

# 在这里可以继续使用 image_path 和 video_path 来进行后续操作，比如加载图像或视频等等。

这段代码通过 argparse 定义了两个命令行参数 --image 和 --video，并指定了它们的长短格式、类型、默认值和帮助信息。然后，通过 parse_args() 方法解析用户输入的命令行参数，并将结果存储在 args 对象中。最后，我们可以通过 args.image 和 args.video 来访问用户提供的参数值，从而进行后续操作。

命令行运行方式

在命令提示符中运行，你可以使用以下格式：

python your_script.py your_input_file

这里 your_script.py 是你的 Python 脚本文件名，your_input_file 是你要处理的输入文件的路径。假设你的脚本接受一个必需的位置参数，像这样：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('input_file', type=str, help='Path to the input file.')
args = parser.parse_args()

# 在这里使用 args.input_file 来获取输入文件路径

如果你的脚本还接受可选的选项参数，例如 --verbose，那么你可以这样在命令行中使用：

python your_script.py your_input_file --verbose

这会打开 verbose 模式，打印更详细的输出。

add_argument方法参数

add_argument() 方法是 argparse 模块中用于添加命令行参数的主要方法。它有很多参数，让我们一一介绍其中常用的参数以及如何使用它们：

1. name or flags: 位置参数或选项参数的名称。例如，'--image' 或 '-i'。

   # 1、位置参数
   parser.add_argument('image')
   # 2、选项参数--长格式
   parser.add_argument('--image')
   # 3、选项参数--短格式
   parser.add_argument( '-i')
   # 4、选项参数--同时指定长、短格式
   parser.add_argument('--image', '-i')
   

   • 位置参数：在命令行中，位置参数是按照顺序出现的参数，用户必须按照指定的顺序提供它们。如果没有提供位置参数的值，程序可能会因为参数不足而报错，除非你在参数定义中指定了默认值或者使用了 default='?' 来表示位置参数是可选的。
   • 选项参数：选项参数通常以 - 或 -- 开头，用户可以根据需要在命令行中提供它们。如果用户不提供选项参数，程序会使用默认值（如果指定了的话），否则参数值为 None。

   在命令行中，用户可以使用长格式或短格式来指定参数。

   • 长格式通常用两个连字符开头，例如 '--image'。
   • 短格式通常用一个连字符开头，例如 '-i'。

   例如：

   python script.py --image image.jpg
   

   或者：

   python script.py -i image.jpg
   

   这两种方式都可以正确地指定参数 image。在代码中，解析器将长格式和短格式都识别为同一个参数，并将其作为一个整体进行处理。

2. type: 参数的类型。例如，str、int、float 等。

3. default: 参数的默认值。

4. help: 参数的帮助信息。

5. metavar: 在帮助信息中参数名称的显示方式。

以下是一个例子，演示了如何使用 add_argument() 方法来添加一个命令行参数：

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, help='an integer for the accumulator')
parser.add_argument('--sum', default=11,help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

在这个例子中，add_argument() 方法用来添加了两个参数：一个位置参数 integers 和一个可选参数 --sum。metavar 参数指定了在帮助文档中显示的参数名，type 参数指定了参数的类型，help 参数指定了参数的帮助信息。