讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在Python项目中配置pyproject.toml以替代传统的setup.py?

酷磊同学_8681

酷磊同学_8681

发布时间:2026-08-30 08:47:07

|

1011人浏览过

|

来源于php中文网

原创

pyproject.toml 可完全替代 setup.py,但必须在 [build-system] 中明确指定 build-backend 和 requires,否则 pip install . 会因缺失构建工具而失败;推荐 build-backend = "setuptools.build_meta" 并声明对应依赖。

如何在python项目中配置pyproject.toml以替代传统的setup.py?

pyproject.toml 可以完全替代 setup.py,但必须明确指定构建后端(build-backend),否则 pip install . 会直接失败。

pyproject.toml 必须包含 build-backend 配置

很多项目迁移时只写 [project] 段就以为够了,结果运行 pip install . 报错:ModuleNotFoundError: No module named 'setuptools' 或更模糊的 Failed to build wheel。这是因为 Python 默认找不到构建工具。

  • 最常用且兼容性最好的选择是 setuptools:在 [build-system] 下写 build-backend = "setuptools.build_meta"
  • 若用 hatchling(Hatch 官方构建器),则写 build-backend = "hatchling.build",需确保已安装 hatchling
  • flit_core.buildapi 适用于纯模块、无 C 扩展的项目,但不支持 setup.py 风格的 cmdclass
  • 不要省略 requires 字段——它声明构建时依赖,例如:requires = ["setuptools>=45", "wheel"]

project.name 和 project.version 怎么填才不踩坑

project.name 是 PyPI 上的包名,project.version 是发布版本号,二者都影响安装行为和依赖解析。

  • project.name 必须符合 PEP 508 规范:只能含 ASCII 字母、数字、-、_、.,且不能以 - 或 . 开头;推荐全小写 + 连字符(如 my-awesome-lib)
  • project.version 不建议硬编码字符串(如 "0.1.0"),尤其在 CI/CD 中容易不同步;推荐用 dynamic = ["version"] + [[project.dynamic]] 块配合外部读取(如从 __init__.py 或 VERSION 文件)
  • 如果用 setuptools-scm,需额外在 [tool.setuptools_scm] 下配置,且 requires 中加入 "setuptools-scm[toml]>=6.2"

entry-points 和 dependencies 的写法差异

相比 setup.py 的 entry_points 字典或字符串,pyproject.toml 使用表结构,语法更严格,缩进错误会导致解析失败。

Python Testing
Python Testing

Python 测试速查:运行 pytest、使用 mock/patch、参数化、fixtures、异步、覆盖率测试。

下载

立即学习“Python免费学习笔记(深入)”;

  • [project.entry-points."console_scripts"] 是标准写法,注意引号包裹键名;值是 "name = 'module:attr' 格式,比如:"mycmd = 'mypkg.cli:main'
  • dependencies 是列表,每项是 PEP 508 兼容的依赖字符串,如 "requests>=2.28.0";不支持 install_requires 那种元组写法
  • 可选依赖(extras)写在 [project.optional-dependencies] 下,键为 extra 名(如 "dev"),值为依赖列表;安装时用 pip install ".[dev]"
  • 不要把 python 版本约束写进 dependencies——应使用 requires-python = ">=3.8" 独立字段

如何验证 pyproject.toml 是否生效

光靠 pip install . 成功不代表配置完整,有些字段(如 dynamic 版本、entry-points)只在构建 wheel 或安装后才暴露问题。

  • 先运行 python -m build --wheel(需安装 build),检查是否生成合法 .whl 文件;再用 tar -tzf dist/*.whl | grep -E "(METADATA|entry_points.txt)" 查看元数据是否包含预期字段
  • 安装后测试命令行入口:pip install --force-reinstall --no-deps --no-cache-dir .,然后直接运行 mycmd(前提是 shell 已刷新 PATH)
  • 用 pip show mypkg 检查 Version、Requires、Required-by 是否准确;若 Version 显示 UNKNOWN,说明 project.version 未被正确解析

真正麻烦的是动态版本和构建后端组合——比如 setuptools-scm + hatchling 不兼容,必须统一构建链路。动手前先确认你用的构建后端是否支持你要的功能,比后期调试快得多。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

相关专题

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

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

1591

2023.07.20

python能做什么
python能做什么

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

3824

2023.07.25

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

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

1609

2023.07.31

python教程
python教程

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

22077

2023.08.03

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

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

2707

2023.08.04

python eval
python eval

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

2767

2023.08.04

scratch和python区别
scratch和python区别

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

1103

2023.08.11

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

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

596

2023.08.10

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

120

2026.09.23

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn