如何在Python库模块中获取当前包版本？最优方案探讨

完全可行，Python有多种成熟的方式实现这个需求，以下是不同场景下的最优方案：

1. 直接定义__version__属性（简单高效） #

这是最基础且通用的方式，适合小型库或快速原型开发：

• 在库的根__init__.py中手动定义版本号：

  # mylibrary/__init__.py
  __version__ = "1.0.0"
  

• 其他模块中直接导入使用：

  # mylibrary/core.py
  from mylibrary import __version__
  
  def some_business_logic():
      if __version__.startswith("1."):
          # 1.x版本的业务逻辑
          pass
      else:
          # 更高版本的逻辑
          pass
  

• 优点：零依赖，实现简单；缺点：版本号需手动维护，发布时容易遗漏更新。

2. 使用标准库importlib.metadata（Python 3.8+） #

适合已安装或发布的库，无需手动维护__version__：

• 直接从标准库获取已安装库的版本：

  import importlib.metadata
  
  try:
      version = importlib.metadata.version("mylibrary")
  except importlib.metadata.PackageNotFoundError:
      # 处理库未安装的情况（比如开发环境下未安装）
      version = "0.0.0-dev"
  

• 开发模式下（pip install -e .）同样能正确获取版本，无需额外配置。

3. 自动版本管理工具（推荐长期维护的库） #

对于依赖Git进行版本控制的库，推荐用setuptools_scm自动从Git标签生成版本号，避免手动维护的错误：

• 配置pyproject.toml（现代Python项目标准）：

  [build-system]
  requires = ["setuptools>=61.0", "setuptools_scm"]
  build-backend = "setuptools.build_meta"
  
  [project]
  dynamic = ["version"]
  
  [tool.setuptools_scm]
  

• 代码中依然可以通过导入__version__获取（工具会自动生成该属性），或者用importlib.metadata获取。
• 优点：版本号与Git标签完全同步，发布时只需打标签即可，无需手动修改代码。

版本比较的正确姿势 #

直接用字符串比较版本号容易出错（比如"1.10"会被认为小于"1.2"），推荐使用packaging库的Version类：

from packaging.version import Version
from mylibrary import __version__

current_version = Version(__version__)
if current_version >= Version("2.0.0"):
    run_new_feature()
else:
    run_legacy_compatibility()

packaging是setuptools的依赖，通常已随库安装，若未安装可通过pip install packaging添加。

总结选择 #

• 小型/快速迭代库：直接定义__version__
• 已发布/需兼容多种环境的库：用importlib.metadata
• 长期维护、基于Git的库：用setuptools_scm自动管理版本

内容的提问来源于stack exchange，提问作者TJoubert