0

0

动态版本号在 PyPI 依赖声明中的实现方案

花韻仙語

花韻仙語

发布时间:2026-01-10 12:54:42

|

912人浏览过

|

来源于php中文网

原创

动态版本号在 PyPI 依赖声明中的实现方案

pypi 包的 pyproject.toml 不支持原生动态填充 dependencies 或 optional-dependencies 中的版本号,但可通过 setup.py 协同实现——将版本号从统一 version 文件读取,并在构建时注入依赖声明。

在现代 Python 打包实践中,pyproject.toml 是推荐的配置入口,但其 dynamic 字段目前(截至 setuptools 69.1.1 及 PEP 621 规范)仅支持 version、description、readme、requires-python、dependencies 和 optional-dependencies 等字段的动态声明——前提是这些字段被显式列入 project.dynamic 列表,且其实际值由外部逻辑(如 setup.py)提供。

要实现你所需的“跨子包统一版本依赖”,例如让 aabbcc-aws 声明 aabbcc-core==1.2.3(而非硬编码或无版本),关键在于:
✅ 将 dependencies 和 optional-dependencies 设为动态字段;
✅ 使用 setup.py 在构建时读取 VERSION 并生成带版本约束的依赖列表;
✅ 确保构建过程自包含(即 sdist 中包含 VERSION 和 setup.py,避免路径越界)。

✅ 正确配置示例

pyproject.toml(aabbcc-aws 子包)

[build-system]
requires = ["setuptools>=64.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "aabbcc-aws"
dynamic = ["version", "dependencies", "optional-dependencies"]
requires-python = ">=3.12"

[tool.setuptools.dynamic]
version = {file = "VERSION"}  # 注意:使用相对路径 "VERSION",非 "../VERSION"
⚠️ 重要:VERSION 文件必须位于当前包根目录下(如 aabbcc-aws/VERSION),或通过 sdist 显式包含。../VERSION 在源码分发(python -m build --sdist)中不可靠,因为 sdist 仅打包当前项目内文件。

setup.py(与 pyproject.toml 同级)

from setuptools import setup
from pathlib import Path

# 安全读取版本(UTF-8 编码,去除首尾空白)
VERSION = Path("VERSION").read_text(encoding="utf-8").strip()

# 构建带版本的依赖项
dependencies = [
    "boto3",
    f"aabbcc-core=={VERSION}",
]

# 若主包需声明 aws 可选依赖(如 aabbcc-core 的 pyproject.toml)
# 可在此处定义 extras_require,或由主包单独处理
optional_dependencies = {
    "aws": [f"aabbcc-aws=={VERSION}"],
}

setup(
    install_requires=dependencies,
    extras_require=optional_dependencies,
)

? 补充说明与最佳实践

  • setup.py 未被弃用:PEP 621 明确指出,setup.py 作为 构建后端钩子(hooking into setuptools)完全合法,仅“作为 CLI 入口直接调用”(如 python setup.py sdist)已被弃用。现代 build 工具(如 pip build, build)会自动调用 setup.py 中的 setup() 函数。

    Programming Helper
    Programming Helper

    AI代码自动生成器,在AI的帮助下更快地编程

    下载
  • 版本同步保障:所有子包共享同一份 VERSION 文件(建议置于仓库根目录),并通过 CI/CD 流程统一更新(如 bump2version 或自定义脚本),确保 aabbcc-core==x.y.z 与 aabbcc-aws==x.y.z 始终严格对齐。

  • 替代方案考量:若希望完全避免 setup.py,可考虑:

    • 使用 setuptools-scm(基于 Git 标签动态推导版本),但依赖关系仍需静态声明(如 aabbcc-core>=1.2.3,<2.0.0);
    • 在 CI 中预生成 pyproject.toml(如用 jinja2 模板 + VERSION 渲染),但会增加发布复杂度。

✅ 总结

动态注入依赖版本虽非 pyproject.toml 原生能力,但通过 dynamic = ["dependencies"] + setup.py 的组合,既能保持配置现代化,又能精准控制跨包版本耦合。核心原则是:静态配置交由 pyproject.toml,动态逻辑交由 setup.py,版本源头唯一可信(VERSION 文件),构建过程自包含可重现

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

373

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

437

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

803

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

371

2025.07.23

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

979

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

581

2023.07.06

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

275

2023.07.24

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

568

2024.04.09

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

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