0

0

Python中argparse模块用法 命令行参数解析库argparse的完整指南

冰火之心

冰火之心

发布时间:2025-06-08 21:21:03

|

964人浏览过

|

来源于php中文网

原创

argparse是python中用于解析命令行参数的工具,其基础用法包括:1. 创建argumentparser对象;2. 使用add_argument()定义参数;3. 调用parse_args()解析输入。它支持位置参数、可选参数、默认值及类型校验,例如通过action="store_true"设置开关参数,type=int强制整数输入,choices限制取值范围。此外,可通过add_argument_group()对参数分组,提升帮助信息可读性;使用subparsers支持子命令结构,实现多命令管理。实用技巧包括清晰命名参数、编写详细help说明、利用内置功能避免手动判断、使用dest重命名属性名以及设置互斥参数组。掌握这些要点,能有效提升脚本的专业性和易用性。

在写Python脚本的时候,如果希望从命令行传入参数,argparse是一个非常实用的工具。它不仅能帮你解析参数,还能自动生成帮助文档、校验输入类型,甚至处理默认值和可选参数。用好了argparse,你的脚本会更专业、也更容易被别人使用。


如何开始使用argparse?

最基础的用法是创建一个ArgumentParser对象,然后添加参数,最后解析命令行输入。比如你想写一个脚本,接受一个名字作为输入,打印欢迎信息:

import argparse

parser = argparse.ArgumentParser(description="欢迎某个用户")
parser.add_argument("name", help="用户的名称")
args = parser.parse_args()

print(f"你好, {args.name}")

运行时输入:

python script.py 张三

就会输出:

立即学习Python免费学习笔记(深入)”;

你好, 张三

这里的关键点在于:

  • add_argument()用来定义参数
  • parse_args()真正去解析命令行输入
  • 参数名会被自动转成变量名(比如上面的name

支持可选参数和默认值

除了必须的位置参数,argparse还支持可选参数(也就是带--或者-前缀的参数),并且可以设置默认值。

举个例子,你可能想让脚本支持静默模式(不打印额外信息):

人民网AIGC-X
人民网AIGC-X

国内科研机构联合推出的AI生成内容检测工具

下载
parser.add_argument("--verbose", help="是否输出详细信息", action="store_true")
parser.add_argument("-l", "--log", help="日志文件路径", default="default.log")

这样调用的时候:

  • 如果加上--verboseargs.verbose就是True
  • 如果不指定--log,就使用默认的default.log

常见用法包括:

  • action="store_true":开关型参数,出现即为True
  • type=int:强制转换为整数
  • choices=[1, 2, 3]:限定取值范围

分组管理参数与子命令

当你的脚本功能变多之后,可能需要对参数进行分组,或者支持多个子命令(比如git里的git commitgit push这种结构)。

参数分组示例:

group = parser.add_argument_group('数据库配置')
group.add_argument('--host', default='localhost')
group.add_argument('--port', type=int, default=5432)

这样在帮助信息中,这些参数会被归到“数据库配置”下,看起来更清晰。

子命令示例:

subparsers = parser.add_subparsers(dest='command')

parser_a = subparsers.add_parser('start', help='启动服务')
parser_b = subparsers.add_parser('stop', help='停止服务')

运行时就可以像这样使用:

python script.py start

通过这种方式,你可以把一个脚本拆成多个“小命令”,便于管理和扩展。


实用技巧和注意事项

有几个细节容易被忽略,但特别有用:

  • 参数命名要清晰:比如用--output-file而不是-o,除非这个缩写很常见。
  • 描述信息别太简略:help内容尽量说明白用途,方便别人理解。
  • 避免重复逻辑判断:能用typechoices限制的,不要自己再判断。
  • dest参数可以重命名属性名:如果你不想让参数名直接变成变量名,可以用dest="my_name"来改。
  • 互斥参数:可以用parser.add_mutually_exclusive_group()来设定不能同时出现的选项。

基本上就这些。掌握好argparse,你就拥有了构建专业命令行工具的基础能力。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1010

2023.08.02

int占多少字节
int占多少字节

int占4个字节,意味着一个int变量可以存储范围在-2,147,483,648到2,147,483,647之间的整数值,在某些情况下也可能是2个字节或8个字节,int是一种常用的数据类型,用于表示整数,需要根据具体情况选择合适的数据类型,以确保程序的正确性和性能。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

611

2024.08.29

c++怎么把double转成int
c++怎么把double转成int

本专题整合了 c++ double相关教程,阅读专题下面的文章了解更多详细内容。

334

2025.08.29

C++中int的含义
C++中int的含义

本专题整合了C++中int相关内容,阅读专题下面的文章了解更多详细内容。

235

2025.08.29

default gateway怎么配置
default gateway怎么配置

配置default gateway的步骤:1、了解网络环境;2、获取路由器IP地址;3、登录路由器管理界面;4、找到并配置WAN口设置;5、配置默认网关;6、保存设置并退出;7、检查网络连接是否正常。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

236

2023.12.07

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

979

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

581

2023.07.06

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

275

2023.07.24

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
微信小程序开发之API篇
微信小程序开发之API篇

共15课时 | 1.3万人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.4万人学习

Swoft2.x速学之http api篇课程
Swoft2.x速学之http api篇课程

共16课时 | 1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号