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

如何在Python项目中通过pyproject.toml定义构建系统?

冬敏姑娘_7613

冬敏姑娘_7613

发布时间:2026-08-14 10:23:36

|

903人浏览过

|

来源于php中文网

原创

必须正确配置pyproject.toml中的[build-system]段,否则pip install .或构建wheel会失败或回退旧逻辑;需明确声明requires(构建依赖)和build-backend(构建后端),二者缺一不可。

如何在python项目中通过pyproject.toml定义构建系统?

Python项目用 pyproject.toml 定义构建系统,核心是写对 [build-system] 段,否则 pip install . 或构建 wheel 会失败或退回到旧式逻辑。

必须声明 requires 和 build-backend

这是最常被漏掉的两行。没有它们,现代构建工具(如 pip、build)无法知道该用什么依赖和哪个后端来执行构建:

[build-system]
requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"
  • requires 列出构建时需要的包(不是运行时依赖),版本要足够新以支持 PEP 517;太老的 setuptools<45 不识别 pyproject.toml 配置
  • build-backend 必须是可导入的字符串,常见值有:"setuptools.build_meta"、"flit_core.buildapi"、"poetry.core.masonry.api";选错会导致 ImportError: cannot import name 'build_wheel'
  • 如果项目用了 pyproject.toml 但没写 [build-system],pip 会回退到 setup.py(若存在),或报错 No module named 'setuptools'

不要在 [build-system] 里写项目元数据

项目名、版本、作者这些信息不属于构建系统配置,硬塞进去会被忽略——它们该放在 [project] 段(PEP 621):

Python Testing
Python Testing

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

下载
[project]
name = "mylib"
version = "0.1.0"
description = "A small example package"
authors = [{name = "Alice", email = "alice@example.com"}]
<p>[build-system]
requires = ["setuptools>=45", "wheel"]
build-backend = "setuptools.build_meta"
  • [build-system] 只管“怎么构建”,不管“构建什么”;混写会导致工具行为不一致(比如 build 命令能读 [project],但旧版 pip 可能完全无视)
  • 若你还在用 setup.py,现在应逐步迁移到 [project]:它支持 dependencies、optional-dependencies、entry-points 等,且无需执行任意 Python 代码
  • 注意:某些 backend(如 flit)要求 [project] 是必需的;而 setuptools 当前仍兼容空 [project],但不推荐

避免 backend-path 引发的本地路径陷阱

除非你真在开发自定义构建后端,否则不要设 backend-path。它指定本地 Python 模块路径,极易因路径错误或环境隔离导致构建失败:

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

[build-system]
requires = ["setuptools>=45"]
build-backend = "my_custom_backend"
backend-path = ["./src"]  # ⚠️ 大部分人不需要这行
  • 设了 backend-path 后,构建工具会在该路径下找模块,而不是从 sys.path 或已安装包中导入;CI 环境或 venv 中很可能找不到
  • 错误现象包括:ModuleNotFoundError: No module named 'my_custom_backend',即使模块明明在 src/ 下
  • 绝大多数项目只需标准 backend(setuptools / flit / poetry-core),删掉 backend-path 就能解决 95% 的构建失败

真正容易被忽略的是:不同 Python 版本下,setuptools 对 pyproject.toml 的支持程度不同——3.8+ 更稳,3.7 需手动升级 setuptools 到 45+,否则会静默跳过配置。别只测本地环境,CI 里跑一遍 python -m build --wheel 才算落地。

热门AI工具

更多
Seko
Seko Hot

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

火山引擎

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

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

WorkBuddy

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

VibeKnow
VibeKnow Hot

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

DeepSeek

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

相关专题

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

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

1631

2023.07.20

python能做什么
python能做什么

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

3944

2023.07.25

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

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

1629

2023.07.31

python教程
python教程

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

22717

2023.08.03

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

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

2787

2023.08.04

python eval
python eval

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

2827

2023.08.04

scratch和python区别
scratch和python区别

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

1123

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

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

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