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 还能够自动生成用户友好的帮助信息,使得命令行工具更易于使用。

相关推荐
吴佳浩5 小时前
我把 HAMi 摆回一台双卡机器上跑了一遍:GPU 编排的性能账,到底记在谁头上
人工智能·gpu
岁月宁静8 小时前
五、《从零手撸 Agent》 — 什么是 Agent:从“会聊天”到“会做事”,差的就是一个循环
python·agent
梯度下降者8 小时前
Python - 函数
python·高阶函数·可调用对象·functools·嵌套作用域
forest_099 小时前
《AI 编程 Harness 实战手册》04|审批这道门:点了一百次“允许”,还剩多少作用?
人工智能·算法·prompt·agi
火山引擎开发者社区10 小时前
当 RPA 遇上 Agent:MUA 混合执行 Workflow 深度拆解
人工智能
严肃小白兔10 小时前
第 10/24 期:深度神经网络的自动求导机制与梯度验证
人工智能·神经网络·dnn
火山引擎开发者社区10 小时前
定档12.16-12.18!FORCE原动力大会上海见!
人工智能
starzy199010 小时前
深入理解Scala隐式参数:上下文流转
开发语言·python·scala
努力的MM12311 小时前
CAIE 二级和阿里云大模型 ACP 怎么选?企业 AI 工程与云平台开发能力对比
人工智能