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

相关推荐
古城小栈3 分钟前
为啥说:训练用BF16,推理用FP16
人工智能·算法·机器学习
KaMeidebaby6 分钟前
卡梅德生物技术快报|蛋白 N 端测序在重组贻贝融合蛋白表征中的应用,解决原核表达序列偏移工艺难题
前端·人工智能·物联网·算法·百度
TMT星球10 分钟前
从像素复刻到行动控制:具身世界模型的底层逻辑探索
人工智能·深度学习·机器学习
ccimao631611 分钟前
散户做财报整理、研报阅读、复盘记录,各类AI工具适配环节梳理
大数据·人工智能
派叔14 分钟前
老字号营销服务商技术解构:三类方案的架构逻辑与选型评估
大数据·人工智能·搜索引擎·架构·产品运营·流量运营
Byron__20 分钟前
AI学习_06_短期记忆与长期记忆
人工智能·python·学习
万悉科技32 分钟前
实战:如何通过GEO原生内容结构化,让LLM稳定推荐你的品牌网站
大数据·人工智能·重构
董厂长37 分钟前
从 Claude Code 放弃 RAG 说起:实际项目中如何合理创建知识库
人工智能·llm
元岳数字人小元1 小时前
如何依托数字人源码做好私有化部署选型
人工智能·开源·人机交互·交互
Turbo正则1 小时前
群论在AI中的应用概述
人工智能·算法·抽象代数