如何在Python项目中通过pyproject.toml替代setup.py

风明酱_1504

风明酱_1504

2026-10-02

307人浏览

原创

pyproject.toml 可完全替代 setup.py,但须满足:使用现代构建后端(如 setuptools≥61.0 或 hatchling)且全部元数据与逻辑迁移至 pyproject.toml;若 setup.py 存在(含空文件),仍会优先执行导致迁移失效。

如何在python项目中通过pyproject.toml替代setup.py

可以完全替代,但必须同时满足两个条件:项目使用现代构建后端(如 setuptools ≥61.0 或 hatchling),且所有元数据和构建逻辑都迁移到 pyproject.toml 中——setup.py 一旦存在,多数工具仍会优先执行它,导致迁移失效。

pyproject.toml 的必备结构:[build-system] 和 [project]

这是最小可行配置,缺一不可。旧版 setup.py 中的 name、version、install_requires 等字段,现在统一归入 [project] 表。

常见错误是只写 [project] 却漏掉 [build-system],结果 pip install . 报错 ModuleNotFoundError: No module named 'setuptools',因为 pip 不知道该用哪个构建器。

  • [build-system] 必须声明 requires(构建依赖)和 build-backend(如 "setuptools.build_meta")
  • [project] 中 dependencies 替代 install_requires,requires-python = ">=3.8" 替代 python_requires
  • 动态版本号(如从 __version__.py 读取)需额外配置:setuptools ≥61.0 支持 dynamic.version + [[project.dynamic]],否则得用 hatchling 或硬编码

setup.py 还在?那 pyproject.toml 可能被忽略

很多项目删了 setup.py 文件,却保留了一个空文件或仅含 pass 的脚本,这依然会触发传统构建流程,导致 pyproject.toml 中的 [project] 不生效。

python-code-analyz
python-code-analyz

专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。

下载

验证方法:运行 pip show your-package-name,看输出的 Version 和 Requires 是否来自 pyproject.toml;若仍是旧值,大概率 setup.py 被读取了。

  • 彻底删除 setup.py(包括 setup.cfg)
  • 检查是否意外引入了 pyproject.toml 多个表(如同时有 [tool.setuptools] 和 [project]),部分字段会覆盖冲突
  • 某些 CI 脚本或 Makefile 显式调用 python setup.py sdist,需同步改为 python -m build

可选但实用的扩展:[project.optional-dependencies] 和 [tool.*]

[project.optional-dependencies] 是替代 extras_require 的标准方式,语法更直观;而 [tool.*] 段用于构建后端或开发工具专属配置,比如 [tool.black]、[tool.ruff],它们不影响包分发,但和 [project] 共存于同一文件,减少配置碎片。

注意 [tool.setuptools] 和 [project] 的职责边界:前者控制构建行为(如 packages.find、include-package-data),后者只管元数据和依赖。混用时优先级以构建后端文档为准,setuptools 默认以 [project] 为主,[tool.setuptools] 为辅。

  • optional-dependencies 示例:dev = ["pytest", "ruff"] → 安装时用 pip install ".[dev]"
  • [tool.setuptools.packages.find] 中 where = ["src"] 对应旧版 package_dir={"": "src"}
  • 若用 hatchling,[project] 已支持 scripts 和 gui-scripts,无需再配 [project.entry-points."console_scripts"]

真正麻烦的不是迁移语法,而是那些藏在 setup.py 里的自定义逻辑:编译 C 扩展、生成协议缓冲区代码、动态写入版本……这些无法用静态 TOML 表达,必须转成构建后端支持的钩子(如 setuptools 的 cmdclass 或 hatch 的插件),或者干脆抽成预构建步骤。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4024

7

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

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

2023.07.31

1629

3

python教程
python教程

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

2023.08.03

23257

23

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

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

2023.08.04

2847

5

python eval
python eval

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

2023.08.04

2887

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2243

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程