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

如何在Python中编写符合PEP 517标准的包构建后端?

夜辰大大_2771

夜辰大大_2771

发布时间:2026-08-06 09:11:52

|

858人浏览过

|

来源于php中文网

原创

PEP 517构建后端是通过pyproject.toml指定的可导入Python模块,提供build_wheel等四个标准函数,取代直接执行setup.py;后者是命令式脚本易产生副作用,前者为声明式、隔离化接口。

如何在python中编写符合pep 517标准的包构建后端?

什么是PEP 517构建后端,它和setup.py有什么区别?

PEP 517定义了一套与构建工具解耦的接口规范,要求包必须通过一个明确的、可导入的Python模块(即“构建后端”)来提供构建逻辑,而不是依赖全局可执行的setup.py脚本。这意味着:setup.py不再被直接执行,而是由构建前端(如pip、build)调用后端模块里的函数。

关键区别在于控制权转移:

  • setup.py是命令式脚本,容易产生副作用(比如修改sys.path、意外执行install逻辑)
  • PEP 517后端是声明式、纯函数式接口,只暴露四个标准函数:build_wheel、build_sdist、get_requires_for_build_wheel、get_requires_for_build_sdist

如果你还在用python setup.py bdist_wheel,那就不符合PEP 517;pip >=21.3默认强制启用PEP 517,老式setup.py会被忽略或报错。

如何写一个最小可行的PEP 517构建后端?

最简实现只需一个pyproject.toml + 一个Python模块(比如build.py),不依赖任何第三方构建库:

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

# pyproject.toml
[build-system]
requires = ["wheel"]
build-backend = "build:build_backend"
# build.py
from wheel.wheel import Wheel
from pathlib import Path
import tarfile
import zipfile
<p>def get_requires_for_build_wheel(config_settings=None):
return ["wheel"]</p><p>def build_wheel(wheel_directory, config_settings=None, metadata_directory=None):</p><div class="aritcle_card flexRow">
                                                        <div class="artcardd flexRow">
                                                                <a class="aritcle_card_img" href="/xiazai/skill8393" title="Forge — Python Developer"><img
                                                                                src="https://img.php.cn/upload/skill/000/000/081/179203503734063.jpg" alt="Forge — Python Developer"  onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
                                                                <div class="aritcle_card_info flexColumn">
                                                                        <a href="/xiazai/skill8393" title="Forge — Python Developer">Forge — Python Developer</a>
                                                                        <p>Python开发助手 — 自动化脚本、API封装、命令行工具、数据管道、网页爬虫。经过测试的代码,包含错误处理和文档。当你需要...</p>
                                                                </div>
                                                                <a href="/xiazai/skill8393" title="Forge — Python Developer" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span> </a>
                                                        </div>
                                                </div><h1>构建一个空wheel(仅示意结构)</h1><pre class='brush:python;toolbar:false;'>wheel_path = Path(wheel_directory) / "mypkg-0.1-py3-none-any.whl"
with zipfile.ZipFile(wheel_path, "w") as w:
    w.writestr("mypkg/__init__.py", "")
    w.writestr("mypkg-0.1.dist-info/METADATA", "Name: mypkg\nVersion: 0.1\n")
return wheel_path.name

def get_requires_for_build_sdist(config_settings=None): return []

def build_sdist(sdist_directory, config_settings=None): sdist_path = Path(sdist_directory) / "mypkg-0.1.tar.gz" with tarfile.open(sdist_path, "w:gz") as t: t.add("pyproject.toml", "mypkg-0.1/pyproject.toml") return sdist_path.name

注意点:

  • build-backend值格式为"module:object",module必须可导入(即路径在Python path里)
  • 所有函数必须接受config_settings参数(即使不用),否则pip会报TypeError
  • 返回值必须是字符串(文件名),不能是Path对象或绝对路径
  • build_wheel必须返回wheel文件名,且该文件必须已写入wheel_directory

为什么用setuptools.build_meta而不是自己手写后端?

除非你有特殊需求(比如定制元数据生成、规避setuptools依赖、嵌入式场景精简),否则不要从零手写后端。原因很实际:

  • setuptools.build_meta已稳定支持PEP 517,并兼容pyproject.toml配置
  • 它自动处理动态版本、入口点、data_files、C扩展等复杂逻辑
  • pip和build工具对它的路径解析、缓存、隔离环境支持最完善

正确做法是:

# pyproject.toml
[build-system]
requires = ["setuptools>=45", "wheel"]
build-backend = "setuptools.build_meta"

然后把原来setup.py里的逻辑迁移到pyproject.toml的[project]和[project.optional-dependencies]等段落中。
如果仍需部分逻辑(如动态读取VERSION),可用dynamic字段配合setup.py——但此时setup.py只作为数据源,不参与构建执行。

常见错误:pip install . 报错“ModuleNotFoundError: No module named 'build'”

这个错误不是因为你没装build,而是因为:

  • pyproject.toml里build-backend指向了一个未安装/不可导入的模块
  • 比如写成"build"但当前目录没build.py,或模块名拼错
  • 或者build.py里抛了异常(比如导入wheel失败,而requires没声明)

排查步骤:

  • 运行python -c "import build; print(build.<strong>file</strong>)"确认模块能导入
  • 检查pyproject.toml中build-backend是否匹配实际文件名和函数名(大小写、下划线)
  • 确保requires列表包含所有后端运行时依赖(如用了tomllib,Python<3.11需额外加tomli)
  • 不要在build.py里做耗时操作(如网络请求),构建过程可能被多次调用且无缓存

真正的难点不在写函数,而在让整个构建上下文干净隔离——尤其是当你的包本身又依赖其他包时,get_requires_for<em>build</em>*返回的依赖必须精确,少一个就ImportError,多一个就拖慢构建。

热门AI工具

更多
讯飞智作

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

WorkBuddy

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

DeepSeek

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

火山引擎

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

豆包大模型

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

更多
python是前端还是后端
python是前端还是后端

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

2463

2023.08.11

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

6330

2024.03.19

后端的主要工作内容介绍
后端的主要工作内容介绍

后端是应用程序的服务端部分,负责核心任务,如数据库交互、业务逻辑处理和响应客户端请求。想了解更多后端的相关内容,可以阅读本专题下面的文章。

5726

2024.03.19

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

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

1731

2023.07.20

python能做什么
python能做什么

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

4404

2023.07.25

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

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

1709

2023.07.31

python教程
python教程

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

25837

2023.08.03

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

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

3147

2023.08.04

剧云AI短剧创作教程合集
剧云AI短剧创作教程合集

本专题聚焦剧云AI短剧创作,讲解从短剧灵感、梗概、全局大纲到分集、分场和正文的完整流程及节奏设计方法。

0

2026.10.14

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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