python中argparse的妙用
使用 Python 的 argparse 模块解析命令行参数
目录
简介
在编写 Python 脚本时，我们经常需要从命令行接收用户输入。Python 的 argparse 模块是一个强大的工具，可以帮助我们轻松解析命令行参数，并生成友好的帮助信息。
本文将详细介绍 argparse 的使用方法，并通过示例演示如何定义和解析命令行参数。
为什么要使用 argparse？
- 自动化参数解析：
argparse可以自动处理命令行参数的解析，无需手动解析sys.argv。 - 类型检查：支持参数类型转换（如整数、字符串等）。
- 默认值和取值范围：可以为参数设置默认值，并限制其取值范围。
- 生成帮助信息：自动生成帮助信息，方便用户了解脚本的使用方法。
基本用法
创建 ArgumentParser 对象
首先，我们需要创建一个 ArgumentParser 对象，它是 argparse 的核心类。
import argparse
parser = argparse.ArgumentParser(description="这是一个示例脚本")
description：脚本的描述信息，会显示在帮助信息中。
添加参数
使用 add_argument() 方法为解析器添加参数。
parser.add_argument('--dataset', '-ds', type=int, default=0, choices=[0, 1, 2], help="选择数据集")
--dataset：长参数名。-ds：短参数名（缩写）。type=int：参数类型为整数。default=0：默认值为0。choices=[0, 1, 2]：参数的取值范围。help：参数的帮助信息。
解析参数
使用 parse_args() 方法解析命令行参数，并将结果存储在 args 对象中。
args = parser.parse_args()
print(args.dataset)
参数详解
位置参数与可选参数
-
位置参数：必须提供的参数，例如：
parser.add_argument('input_file', type=str, help="输入文件路径")用户必须提供
input_file参数。 -
可选参数：以
-或--开头的参数，例如：parser.add_argument('--output', '-o', type=str, default='./output', help="输出目录")用户可以选择是否提供
--output参数。
参数类型 (type)
type 参数用于指定用户输入的类型。常见的类型包括：
int：整数。str：字符串。float：浮点数。
示例：
parser.add_argument('--epochs', type=int, default=10, help="训练轮数")
默认值 (default)
如果用户没有提供某个参数，则使用默认值。
示例：
parser.add_argument('--batch_size', type=int, default=32, help="批量大小")
参数取值范围 (choices)
choices 参数用于限制用户输入的取值范围。
示例：
parser.add_argument('--model', type=str, choices=['resnet', 'vgg', 'mobilenet'], help="选择模型")
帮助信息 (help)
help 参数用于为参数添加描述信息，这些信息会显示在帮助信息中。
示例：
parser.add_argument('--learning_rate', type=float, default=0.001, help="学习率")
完整示例
以下是一个完整的示例脚本，演示了如何使用 argparse 解析命令行参数。
import argparse
# 创建 ArgumentParser 对象
parser = argparse.ArgumentParser(description="这是一个示例脚本")
# 添加参数
parser.add_argument('--dataset', '-ds', type=int, default=0, choices=[0, 1, 2], help="选择数据集")
parser.add_argument('--method', '-m', type=int, default=0, choices=[0, 1, 2], help="选择方法")
parser.add_argument('--output', type=str, default='./output', help="输出目录")
parser.add_argument('--backbone', '-b', type=int, default=0, choices=[0, 1, 2], help="选择骨干网络")
# 解析参数
args = parser.parse_args()
# 打印参数值
print(f"数据集: {args.dataset}")
print(f"方法: {args.method}")
print(f"输出目录: {args.output}")
print(f"骨干网络: {args.backbone}")
运行示例
假设脚本名为 script.py，用户可以这样运行：
python script.py --dataset 1 --method 2 --output ./results --backbone 0
输出结果：
数据集: 1
方法: 2
输出目录: ./results
骨干网络: 0
总结
argparse 是 Python 中处理命令行参数的强大工具。通过本文的介绍，你应该已经掌握了以下知识点：
- 如何创建
ArgumentParser对象。 - 如何添加和解析命令行参数。
- 如何使用
type、default、choices和help等参数。
希望这篇博客对你有所帮助！如果你有任何问题或建议，欢迎在评论区留言。
Happy Coding! 🚀
原文地址：https://blog.csdn.net/wniuniu_/article/details/145168035
免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！