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还支持可选参数(也就是带--或者-前缀的参数),并且可以设置默认值。

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

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

这样调用的时候:

简单听记
简单听记

百度网盘推出的一款AI语音转文字工具

下载
  • 如果加上--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,你就拥有了构建专业命令行工具的基础能力。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

715

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

625

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

739

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1235

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

575

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

698

2023.08.11

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

0

2025.12.31

热门下载

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

精品课程

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

共15课时 | 1.2万人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.3万人学习

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

共16课时 | 0.9万人学习

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

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