Python 标准库argparse模块介绍

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

1. argparse 的核心概念

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

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 :指定参数的数据类型,例如 int、float、str。
    • help:对参数的描述,用于生成帮助信息。
    • default:为可选参数指定默认值。
    • choices:限制参数的取值范围,用户输入的值必须在此范围内。

5. 生成帮助信息

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

6. 总结

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

相关推荐
泯泷4 分钟前
像项目经理一样指挥 AI 团队:管理者模式
人工智能·llm·agent
京东云开发者13 分钟前
双11囤Token火了:京东搜索量暴涨7倍,AI生产力成新刚需
人工智能
ahccqw30 分钟前
OpenCV 车辆数量统计
人工智能·opencv·计算机视觉
人工智能AI技术1 小时前
LangGraph 本地 build 频频翻车,最终在服务器跑通流式对话
人工智能
Flynn Liang1 小时前
同一需求三套写法:用 Spring AI、LangChain4j、AgentScope Java 各实现一个带工具调用的 RAG 助手(实战对比)
java·人工智能·大模型·架构设计·spring ai·langchain4j·agentscope
汤姆宝库1 小时前
构建一个能用的RAG系统:切块、嵌入、混合检索与融合排序
人工智能
Dawson Zhu1 小时前
【LLM推理与Serving⑪】MoE推理与MLA:DeepSeek-V3架构下的显存与通信权衡
人工智能·语言模型·架构·aigc·agi
github_is_geeksKai2 小时前
50 个 AI 与开源工具怎么选:从实际用途到实现边界
人工智能
IT_陈寒2 小时前
Vite的HMR把我整不会了:一个生产环境的热更新坑
前端·人工智能·后端
github_is_geeksKai2 小时前
浏览器 AI 小工具怎么选?40 个项目与 5 类商业任务的参考指南
人工智能