argparse自定义--version显示版本号方法

从现在开始，我们要努力学习啦！今天我给大家带来《使用 argparse 时，可以通过自定义 --version 参数来自动显示包的版本号。以下是实现方法：方法一：使用 argparse 的 version 参数（适用于 Python 3.4+）import argparse parser = argparse.ArgumentParser(description='我的程序描述', version='1.0.0') parser.add_argument('--version', action='version', help='显示版本信息')这样，当用户运行 --version 时，会自动输出 1.0.0。方法二：手动处理 --version 参数（更灵活）如果你需要从 __version__ 变量中获取版本号，可以这样做：import argparse __version__ = '1.0.0' parser = argparse.ArgumentParser(description='我的程序描述') parser.add_argument('--version', action='store_true', help='显示版本信息') args = parser.parse_args() if args.version: print(f'版本: {__version__}') exit()方法三：结合 argparse 和 pkg_resources 获取安装版本（适用于包发布）如果你的代码是作为 Python 包发布的，可以使用 pkg_resources 来获取实际安装的版本： import argparse import pkg_resources __version__ = pkg_resources.get_distribution('my_package').version parser = argparse.ArgumentParser(description='我的程序》，感兴趣的朋友请继续看下去吧！下文中的内容我们主要会涉及到等等知识点，如果在阅读本文过程中有遇到不清楚的地方，欢迎留言呀！我们一起讨论，一起学习！

argparse 的 --version 需手动传入版本号，推荐用 importlib.metadata.version('pkgname') 获取（Python 3.8+），并加 PackageNotFoundError 兜底；避免 pkg_resources 和硬编码 __version__，确保 pyproject.toml 中 [project].version 与安装一致。

argparse 怎么让 --version 显示当前包的版本号

默认情况下，argparse.ArgumentParser 的 add_argument('--version', action='version') 只能绑定一个固定字符串。要让它自动读取包的版本号（比如从 pyproject.toml 或 __version__），得手动把版本值传进去，不能靠 argparse 自动推导。

怎么获取并传入真实版本号

最稳妥的方式是提前从项目中读出版本号，再塞进 version 参数里。常见来源有：

• import mypackage; mypackage.__version__ —— 要求包已安装或在 PYTHONPATH 中可导入
• import importlib.metadata; importlib.metadata.version('mypackage') —— Python 3.8+，推荐，不依赖导入包本身
• importlib.metadata.version(__name__.split('.')[0]) —— 如果脚本在包内，慎用，__name__ 可能是 __main__

示例：

import argparse
from importlib.metadata import version

parser = argparse.ArgumentParser()
parser.add_argument(
    '--version',
    action='version',
    version=f'mytool {version("mytool")}'
)

为什么不用 pkg_resources

pkg_resources.get_distribution('mytool').version 虽然也能用，但：

• 属于 setuptools 内部 API，官方已标记为 deprecated
• 在 PEP 517 构建环境下可能返回错误版本（比如没安装就运行）
• importlib.metadata 是标准库替代方案，更轻、更可靠

打包时版本号没更新怎么办

常见坑：代码里写死 __version__ = '0.1.0'，但 pyproject.toml 里改了，importlib.metadata.version() 读的是安装后元数据，不是源码里的字符串 —— 所以必须确保构建/安装步骤同步版本。检查方法：

• 运行 pip install -e . 后再测试 --version
• 确认 pyproject.toml 的 [project].version 字段存在且正确
• 避免在 setup.py 中动态读取 __version__，容易导致元数据和源码不一致

如果项目还没发布，只是本地开发，importlib.metadata.version() 会抛 PackageNotFoundError，建议加一层兜底逻辑，比如 fallback 到 0.0.0+dev。

到这里，我们也就讲完了《argparse自定义--version显示版本号方法》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！