Azure DevOps构建Python wheel时如何实现包help()方法读取运行时安装版本
Azure DevOps流水线发布Python Wheel包的适配工作流方案
前置问题根因定位
之前将deploymentversion文件随wheel打包后安装读取失败,本质是两个开发者常踩的坑:
- Python wheel构建流程默认仅收录源码目录下的
.py文件,未通过配置显式声明的非代码类文件,构建阶段根本不会被打进包,很容易出现“以为文件已打包、实际包内容里不存在”的情况 - 就算文件被正确打入包内,若代码通过相对路径定位目标文件,安装后包文件会被散放到当前Python环境的
site-packages固定路径下,相对路径匹配逻辑会直接失效,无法正常读取
固定链路下的最优落地方案
完全不改动原有Azure DevOps流水线的核心执行逻辑,仅做最小增量调整即可满足所有需求:
构建阶段将版本值内置为Python代码常量
抛弃“运行时读取独立deploymentversion文件”的思路,在流水线现有写deploymentversion的步骤完成后,追加一步轻量脚本执行操作即可:
- 读取
deploymentversion中存储的版本号,直接在包源码目录下生成_version.py文件,文件内容固定为一行版本常量:__CURRENT_PACKAGE_VERSION__ = "读取到的版本号值" - 由于该文件是纯Python代码,wheel构建流程会自动将其收录到包内容中,完全不需要额外修改打包配置,从根源上避免路径找不到的问题
- 修改
myWhlPackage包的入口逻辑,直接从_version.py导入版本常量实现help()方法:方法内输出固定提示文本,拼接内置的版本值即可。无论用户将包装在虚拟环境、全局环境还是自定义路径下,只要能正常导入包,就能拿到准确的版本值
流水线的零侵入调整点
适配原有固定部署链路,不需要重构流程:
- 原有写入
deploymentversion、通过该文件读取版本配置setup.py的逻辑完全保留,仅在setup.py执行构建wheel的任务前,插入一步生成_version.py的脚本任务即可 - 之前为了把
deploymentversion打进包内容,在MANIFEST.in、pyproject.toml中添加的非代码文件打包规则可以直接删除,减少无意义的包体积开销 deploymentversion文件本身仅作为构建阶段的版本传递媒介,不需要打入最终的wheel包
版本迭代的兼容能力设计
满足“基于已安装版本迭代升级”的需求:
- 用户本地安装完wheel包后,执行
import myWhlPackage即可直接获取内置的版本值,不需要额外查找site-packages目录下的零散文件 - 后续发版时,可在流水线中拉取Azure Artifacts上留存的历史版本列表,和当前待发版的版本号做自动校验,确保版本号满足递增规则,避免出现版本倒退的问题
行业通用实践:这种在构建阶段把版本值写入包内Python常量的方案,是Python开源包生态的标准版本读取实现方式,兼容性远好于运行时读取独立元数据文件的方案,跨Python版本、跨操作系统都不会出现路径读取失败的问题
内容的提问来源于stack exchange,提问作者Thorsten Steparsch
相关产品推荐
相关产品推荐

