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

如何通过pyproject.toml定义Python项目的构建系统和环境?

胖枫同学_4558

胖枫同学_4558

发布时间:2026-07-18 08:18:29

|

680人浏览过

|

来源于php中文网

原创

pyproject.toml 中 [build-system] 段必须包含 requires 和 build-backend:requires 列构建依赖(如 ["setuptools>=45", "wheel"]),build-backend 指定后端(如 "setuptools.build_meta"),缺一则 pip 或 build 会报错或降级失败。

如何通过pyproject.toml定义python项目的构建系统和环境?

pyproject.toml 里 build-system 必须写什么?

不写 build-system 段,现代 Python 构建工具(如 pip、build)会直接报错或降级到旧式隐式构建逻辑,导致依赖不一致或安装失败。

最小合法配置必须包含 requires 和 build-backend:

[build-system]
requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"
  • requires 列的是构建时依赖(不是运行时依赖),必须是 PEP 517 兼容的包;setuptools 版本太低会导致 pyproject.toml 中的某些字段(如 dynamic)被忽略
  • build-backend 值必须对应已安装的 backend 模块入口点,常见值有:"setuptools.build_meta"、"hatchling.build"、"poetry.core.masonry.api";拼错或未安装对应包会触发 ModuleNotFoundError
  • 不要把 pip 或 python 放进 requires —— 它们是构建环境前提,不是构建依赖

如何用 tool.setuptools 替代 setup.py?

setup.py 已被标记为 deprecated,所有配置应迁移到 pyproject.toml 的 tool.setuptools 段。迁移不是简单复制粘贴,字段语义和默认行为有差异。

例如定义包名、版本、入口点:

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

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载
[project]
name = "mylib"
version = "0.1.0"
dependencies = ["requests>=2.25.0"]
<p>[project.entry-points."console_scripts"]
mycmd = "mylib.cli:main"</p><p>[tool.setuptools]</p><h1>启用自动发现包(替代 find_packages())</h1><p>py-modules = []
packages = {find = {where = ["src"], include = ["mylib*"]}}</p><h1>动态版本(替代 setup.py 中的 scm 版本生成)</h1><p>dynamic = ["version"]</p><p>[tool.setuptools.dynamic.version]
attr = "mylib.<strong>version</strong>"
  • packages 和 py-modules 互斥;用 find 时注意 where 路径是相对于项目根目录,不是 pyproject.toml 所在路径
  • dynamic.version 需配合 setuptools_scm 使用,且要求 Git 仓库存在有效 tag;否则构建会失败并提示 Version scheme 'guess-next-dev' did not generate a version
  • project.dependencies 是 PEP 621 标准字段,优先级高于 tool.setuptools.install_requires;两者共存时后者会被忽略

为什么 tool.poetry 不能和 tool.setuptools 混用?

Poetry 不是 PEP 517 构建后端,它只读取自己的 tool.poetry 段,并忽略 tool.setuptools 或 project。混用会导致构建行为不可预测:比如 pip install . 走 setuptools,poetry build 走 Poetry,产出的 wheel 元数据可能不一致。

  • 若用 Poetry 管理依赖和发布,build-backend 应设为 "poetry.core.masonry.api",且 requires 必须含 "poetry-core>=1.0.0"
  • Poetry 不支持 project.dependencies 字段,必须用 tool.poetry.dependencies;但该段不参与 PEP 517 构建,仅用于 poetry install 或 poetry export
  • 想兼顾 pip install . 和 poetry add?别这么做。选一个构建系统,统一维护。Poetry 用户应禁用 setup.py 和 tool.setuptools,避免干扰

虚拟环境里 pip install . 为什么还是装错依赖?

根本原因常是 build-system.requires 与 project.dependencies 混淆,或构建缓存未清理。

  • build-system.requires 只影响构建过程本身(如生成 wheel),不影响最终安装的包依赖;真正决定用户 pip install 后获得哪些依赖的是 project.dependencies(PEP 621)或 tool.setuptools.install_requires(旧式)
  • 执行 pip install . 时,pip 会先调用构建后端生成 wheel,再安装 wheel —— 如果之前构建过且 wheel 缓存未失效,pip 可能复用旧 wheel,导致新改的 dependencies 不生效。解决方法是加 --force-reinstall --no-deps 或删掉 ./dist/ 目录再试
  • 检查最终安装结果是否正确:运行 pip show mylib,看 Requires: 行是否匹配 project.dependencies 内容;不匹配说明构建阶段没读取到最新配置

最易被忽略的是:pyproject.toml 的语法错误(比如多了一个逗号、引号不闭合)不会在编辑时报警,而是在构建时静默失败回退到旧逻辑,建议用 tomllib(Python 3.11+)或 tomli 手动验证文件格式。

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

DeepSeek

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

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

相关专题

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

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

1751

2023.07.20

python能做什么
python能做什么

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

4524

2023.07.25

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

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

1729

2023.07.31

python教程
python教程

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

26597

2023.08.03

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

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

3227

2023.08.04

python eval
python eval

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

3247

2023.08.04

scratch和python区别
scratch和python区别

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

1183

2023.08.11

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

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

596

2023.08.10

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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