如何在Python中使用pyproject.toml替代传统setup.py

星杰同学_1685

星杰同学_1685

2026-09-16

201人浏览

原创

pyproject.toml 可完全替代 setup.py,但需显式声明 [build-system] 段指定 build-backend 和 requires,并将元数据移至 [project] 段;动态版本用 dynamic.version 配置,-e 安装依赖后端支持,旧脚本须改为 python -m build。

如何在python中使用pyproject.toml替代传统setup.py

pyproject.toml 可以完全替代 setup.py,但不是简单“删掉再写个 toml”就完事——它改变了构建流程的控制权归属,必须明确指定构建后端(build backend)并适配其要求。

pyproject.toml 必须声明 build-backend 才能生效

Python 3.11+ 默认启用 PEP 517 构建协议,一旦存在 pyproject.toml,setup.py 就被忽略(即使它还存在)。但若 pyproject.toml 中没有 [build-system] 段,pip install 或 python -m build 会直接报错:

ERROR: No build backend specified in pyproject.toml

正确写法是显式指定后端,最常用的是 setuptools(兼容旧习惯)或 hatchling(更轻量):

[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"
  • requires 列出构建时依赖,不能写成 setuptools 简写,需带版本约束(避免因 setuptools 太老导致元数据解析失败)
  • 若用 hatchling,则写 build-backend = "hatchling.build",且 requires 改为 ["hatchling"]
  • 不要混用:比如 requires 写 setuptools 却把 build-backend 设为 hatchling.build,会触发 ImportError

metadata 和 dependencies 要挪到 [project] 下,不是 [tool.setuptools]

很多人误以为 [tool.setuptools] 是新 setup.py 的平替,其实不然。PEP 621 规定标准元数据必须放在 [project] 段,否则 setuptools 构建时不会读取(除非你主动关掉 PEP 621 支持)。

典型迁移对比:

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载
# ❌ 错误:只写在 tool.setuptools 里,会被忽略
[tool.setuptools]
name = "mylib"
version = "0.1.0"
dependencies = ["requests"]
# ✅ 正确:写在 project 下
[project]
name = "mylib"
version = "0.1.0"
dependencies = ["requests>=2.25.0"]
  • dependencies 是列表,每个项是 PEP 508 兼容字符串,支持版本约束、环境标记(如 "pytest; extra == 'test'")
  • 可选依赖用 [project.optional-dependencies],不是 extras_require
  • readme 推荐写成 readme = "README.md",而非 long_description_file

动态 version 或复杂逻辑仍需 setup.py?不,用 pyproject.toml + 钩子

有人卡在“我的版本号从 git tag 读,setup.py 里写了 get_version() 函数,pyproject.toml 怎么办?”——答案是:不用删函数,但要换位置。

setuptools 支持在 [project] 中通过 dynamic.version 委托给 Python 模块:

[project]
name = "mylib"
dynamic = ["version"]
# 其他字段照常写
[project.dynamic.version]
attr = "mylib.__version__"
  • 这要求 mylib/__init__.py 中定义了 __version__(可从 git 获取,例如用 importlib.metadata.version 或 setuptools_scm)
  • 若用 setuptools_scm,需在 requires 加 "setuptools-scm[toml]>=6.2",并在 [tool.setuptools_scm] 配置(注意:这是工具配置,不影响构建逻辑)
  • 别试图在 toml 里写 Python 表达式——它不是模板引擎,所有动态行为必须由构建后端支持并实现

本地开发安装时,-e 模式行为有细微差别

执行 pip install -e . 时,传统 setup.py 直接运行 setup.py develop;而 pyproject.toml 下,pip 会调用构建后端的 build_editable 接口。这意味着:

  • 如果后端不支持 editable 安装(如某些精简后端),-e 会失败,提示 Editable installation is not supported
  • setuptools 默认支持,但需确保 pyproject.toml 中 build-backend 是 setuptools.build_meta(不是 setuptools.build_meta:__legacy__)
  • 部分 IDE(如 PyCharm)旧版本可能未识别 pyproject.toml 的 editable 安装路径,需手动刷新解释器路径或升级

真正容易被忽略的是:当你删掉 setup.py 后,有些 CI 脚本或 Makefile 还在调用 python setup.py sdist,这些命令会直接报错“No module named setup”——必须统一改为 python -m build --sdist 或 pipx run build --sdist。

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

相关专题

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

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

2023.07.20

1791

4

python能做什么
python能做什么

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

2023.07.25

4664

7

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

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

2023.07.31

1749

3

python教程
python教程

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

2023.08.03

27637

23

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

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

2023.08.04

3327

5

python eval
python eval

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

2023.08.04

3347

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2583

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习