Python 标准库argparse模块介绍

argparse 是 Python 标准库中的一个模块,用于解析命令行参数和选项。它帮助开发者轻松编写用户友好的命令行接口,让程序可以通过命令行接受参数,而无需手动解析 sys.argvargparse 能自动生成帮助信息,并且处理各种复杂的命令行语法。

1. argparse 的核心概念

  • 命令行参数 :用户在命令行中传递给程序的参数,如 python script.py arg1 arg2 中的 arg1arg2
  • 位置参数:必须以特定顺序提供的参数。
  • 可选参数 :通常以 --- 开头的参数,可以不按顺序提供,且可能有默认值。

2. 使用 argparse 的基本步骤

  1. 创建一个 ArgumentParser 对象。
  2. 使用 add_argument() 方法定义程序需要的参数。
  3. 使用 parse_args() 解析命令行参数,并生成一个包含参数值的命名空间对象。

3. 示例代码

以下是一个使用 argparse 的简单示例:

复制代码
import argparse

# 创建 ArgumentParser 对象
parser = argparse.ArgumentParser(description="This is a simple argparse example.")

# 添加位置参数
parser.add_argument('filename', type=str, help='The name of the file to process.')

# 添加可选参数
parser.add_argument('--verbose', action='store_true', help='Increase output verbosity.')

# 添加带默认值的可选参数
parser.add_argument('--mode', type=str, choices=['train', 'test'], default='train', help='Mode of operation.')

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

# 使用解析后的参数
print(f"Filename: {args.filename}")
print(f"Mode: {args.mode}")

if args.verbose:
    print("Verbose mode is enabled.")

4. ArgumentParser 参数介绍

  • description:描述该解析器的作用,会在帮助信息中显示。
  • add_argument 方法参数
    • type :指定参数的数据类型,例如 intfloatstr
    • help:对参数的描述,用于生成帮助信息。
    • default:为可选参数指定默认值。
    • choices:限制参数的取值范围,用户输入的值必须在此范围内。

5. 生成帮助信息

如果用户在命令行中使用 -h--help 选项,argparse 会自动生成并显示帮助信息。

6. 总结

argparse 是一个强大且灵活的工具,适用于解析命令行参数。通过定义位置参数和可选参数,开发者可以方便地处理用户输入,并根据这些输入控制程序的行为。argparse 还能够自动生成用户友好的帮助信息,使得命令行工具更易于使用。

相关推荐
北京软秦科技有限公司9 小时前
资料验收报告审核再升级,IACheck与AI报告审核共同开创新标准
人工智能
Zzj_tju9 小时前
视觉语言模型技术指南:图像是怎么“接入”语言模型的?视觉编码器、投影层与对齐机制详解
人工智能·语言模型·自然语言处理
Fullde福德负载箱厂家9 小时前
负载箱的日常运维与故障处置:用户应知的设备保养与异常应对
人工智能·制造
.5489 小时前
## Sorting(排序算法)
python·算法·排序算法
ydmy9 小时前
注意力机制(个人理解)
pytorch·python·深度学习
jinanwuhuaguo9 小时前
OpenClaw工程解剖——RAG、向量织构与“记忆宫殿”的索引拓扑学(第十三篇)
android·开发语言·人工智能·kotlin·拓扑学·openclaw
大龄程序员狗哥9 小时前
第44篇:命名实体识别(NER)实战——从文本中提取关键信息(项目实战)
人工智能
lpfasd1239 小时前
2026年第17周GitHub趋势周报:AI代理工程化与端侧智能加速落地
人工智能·github
nervermore9909 小时前
2.人工智能学习-环境搭建
人工智能
Flying pigs~~10 小时前
LoRA 面试完全指南:低秩分解原理 + Transformer 应用
人工智能·深度学习·lora·大模型·微调·transformer