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() 函数。

    播记
    播记

    播客shownotes生成器 | 为播客创作者而生

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

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

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

✅ 总结

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

相关专题

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

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

745

2023.06.15

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

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

634

2023.07.20

python能做什么
python能做什么

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

757

2023.07.25

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

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

617

2023.07.31

python教程
python教程

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

1259

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

577

2023.08.04

scratch和python区别
scratch和python区别

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

705

2023.08.11

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

25

2026.01.09

热门下载

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

精品课程

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

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 3万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.1万人学习

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

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