0

0

Python脚本参数化运行_argparse模块详解【教程】

冰川箭仙

冰川箭仙

发布时间:2025-12-25 22:03:21

|

505人浏览过

|

来源于php中文网

原创

argparse.ArgumentParser() 初始化时通常无需传 prog,但封装为命令行工具时应显式指定以修正 help 中的程序名;布尔参数优先用 'store_true',除非需三态;位置参数须置于可选参数之前;通过 type 和 default 配合 help 可显示类型与默认值。

python脚本参数化运行_argparse模块详解【教程】

argparse.ArgumentParser() 初始化时要不要传 prog

默认情况下,argparse.ArgumentParser() 会自动从 sys.argv[0] 推断程序名,多数时候够用。但如果你的脚本被封装成命令行工具(比如通过 entry_points 注册为 mytool),而实际执行的是某个内部模块,help 里却显示 python -m mypackage.cli,就容易误导用户。

这时显式传入 prog='mytool' 能让帮助信息更准确:

parser = argparse.ArgumentParser(prog='mytool', description='A fast file processor')

注意:它只影响 help 输出和错误提示中的程序名,不影响参数解析逻辑。

add_argument() 的 action 值选 'store_true' 还是 'store_const'

两者都用于布尔型开关,但行为不同:

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

  • 'store_true':遇到该参数就设为 True,没出现就是 False(默认值)
  • 'store_const':必须配合 const=... 使用,适合多开关共用一个变量,比如 --verbose--quiet 都写进同一个 verbosity 字段

常见误用:想实现「有参数就开,没参数就关」却用了 store_const 却忘了给 const,结果参数存在时值仍是 None

推荐优先用 store_true,除非你明确需要三态(如 0/1/2 日志级别):

parser.add_argument('--debug', action='store_true', help='Enable debug logging')

位置参数和可选参数混用时,为什么 parse_args() 报错说 “unrecognized arguments”?

典型原因是:位置参数写在了可选参数后面,而用户又漏写了某个必需的位置参数,导致后续看起来像参数的字符串被当成未知参数处理。

Python精要参考 pdf版
Python精要参考 pdf版

这本书给出了一份关于python这门优美语言的精要的参考。作者通过一个完整而清晰的入门指引将你带入python的乐园,随后在语法、类型和对象、运算符与表达式、控制流函数与函数编程、类及面向对象编程、模块和包、输入输出、执行环境等多方面给出了详尽的讲解。如果你想加入 python的世界,David M beazley的这本书可不要错过哦。 (封面是最新英文版的,中文版貌似只译到第二版)

下载

例如:

parser.add_argument('input_file')
parser.add_argument('--output', '-o')
# 用户运行:python script.py --output result.txt
# → 缺少 input_file,但 argparse 不会报 “missing required argument”,而是把 --output 当成位置参数、result.txt 当成下一个位置参数,最后发现 --output 已定义,却没匹配上,报 unrecognized

解决方法

  • 把所有位置参数放在 add_argument() 调用的最前面
  • 对必需参数,显式加 required=True(仅对可选参数有效)或用 nargs 控制数量
  • 调用 parse_args() 前先检查 len(sys.argv) ,提前提示用法

怎么让 --help 显示更清晰的类型提示和默认值?

默认 help 不显示类型和默认值,用户得看源码猜。加两个参数就能改善:

  • type=strtype=int:会在 help 里显示 [type: str]
  • default=...:配合 help='... (default: %(default)s)',自动填充默认值

注意:如果 defaultNone 或未设,默认值不会显示;空字符串 '' 会被正常渲染。

示例:

parser.add_argument('--port', type=int, default=8000,
                   help='Server port (default: %(default)s)')

输出 help 时会显示:--port PORT Server port (default: 8000)

argparse 的坑往往不在语法,而在“默认行为”和“用户直觉”的错位——比如位置参数顺序、help 文本里的默认值是否可见、布尔参数没出现时的初始状态。这些细节不报错,但会让脚本在真实协作中反复被问“为什么我加了 --xxx 没生效”。

相关专题

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

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

707

2023.06.15

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

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

625

2023.07.20

python能做什么
python能做什么

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

734

2023.07.25

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

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

616

2023.07.31

python教程
python教程

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

1234

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

573

2023.08.04

scratch和python区别
scratch和python区别

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

695

2023.08.11

笔记本电脑卡反应很慢处理方法汇总
笔记本电脑卡反应很慢处理方法汇总

本专题整合了笔记本电脑卡反应慢解决方法,阅读专题下面的文章了解更多详细内容。

1

2025.12.25

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

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

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