Python中argparse模块用法命令行参数解析库argparse的完整指南-Python教程-PHP中文网

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

冰火之心

发布： 2025-06-08 21:21:03

原创

718人浏览过

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")

登录后复制

这样调用的时候：

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

常见用法包括：

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

分组管理参数与子命令

当你的脚本功能变多之后，可能需要对参数进行分组，或者支持多个子命令（比如git里的git commit、git 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='停止服务')

登录后复制

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