=61.0"])和build-backend(如"setuptools.build_meta"),后者必填name和version;缺一则导致python-mbuild或pipinstall-e.失败。" /> =61.0"])和build-backend(如"setuptools.build_meta"),后者必填name和version;缺一则导致python-mbuild或pipinstall-e.失败。">

如何搭建一个符合PEP 517标准的Python包分发和测试环境?

陌强君_2462

陌强君_2462

2026-06-23

151人浏览

原创

pyproject.toml 必须存在且包含 [build-system] 和 [project] 两个核心段:前者需声明 requires(如 ["setuptools>=61.0"])和 build-backend(如 "setuptools.build_meta"),后者必填 name 和 version;缺一则导致 python -m build 或 pip install -e . 失败。

如何搭建一个符合pep 517标准的python包分发和测试环境?

pyproject.toml 必须存在且结构正确

没有 pyproject.toml,python -m build 会回退到旧模式或直接报错,生成的 wheel 可能不被 pip 正确识别。它不是可选配置,而是 PEP 517 的强制入口。

必须包含两个核心段:[build-system] 和 [project]。前者声明构建依赖和后端,后者定义包名、版本、作者等元数据。漏掉任意一个,pip install -e . 或 python -m build 都可能失败。

  • [build-system] 中 requires 至少要含一个构建后端,比如 ["setuptools>=61.0"] 或 ["hatchling"];build-backend 必须匹配,如 "setuptools.build_meta"
  • [project] 中 name 和 version 是必填项;requires-python 建议明确(如 ">=3.8"),否则 CI 上可能因 Python 版本模糊而构建失败
  • 如果用 src/ 布局,[project] 里不用写 packages 字段——现代构建后端(setuptools 61+、hatchling、flit)会自动发现 src/<name></name> 目录

src/ 布局比 flat layout 更可靠

把代码放在 src/my_package/ 而不是项目根目录下,能彻底避免 pip install -e . 导致的 import 冲突。常见现象是:本地运行 python -c "import my_package" 成功,但测试时却报 ModuleNotFoundError——大概率是因为当前目录被加进了 sys.path,Python 优先导入了未打包的源码副本,而非安装后的包。

Claw Code Suite (Python-Only Edition)
Claw Code Suite (Python-Only Edition)

仅使用 Python 将 Claw Code 虚拟化框架与 OpenClaw 集成,提供 184 种工具和 200 多条命令,用于安全分析和代码质量...

下载
  • Cookiecutter 模板(如 audreyr/cookiecutter-pypackage)启用 use_src_layout [y] 后,自动生成 src/my_package/__init__.py 和 pyproject.toml 适配结构
  • 手动建 src/ 时,确保 project.name(在 pyproject.toml 中)与 src/ 下的子目录名完全一致,大小写、连字符都不能错
  • 运行 pip install -e . 后,检查 site-packages 是否有 my_package-0.1.0-py3.x.egg-link 文件,内容应指向你的项目根目录——这是 editable 安装生效的标志

tox + pytest 组合必须隔离 Python 环境

Tox 不是“高级可选工具”,而是验证 PEP 517 包是否真正可复现的关键环节。它强制你在干净虚拟环境中执行 pip install . 和 pytest,暴露那些只在你本机环境里才跑得通的问题。

  • tox.ini 中 [testenv] 的 deps = pytest 要写在 deps 下,而不是 commands 里——否则 pytest 可能用的是系统全局版本,而非 tox 创建的隔离环境里的版本
  • 常见错误:tox -e py39 报 No module named 'my_package',90% 是因为 pyproject.toml 缺少 [project] 段,或 name 和实际目录名不一致
  • 建议在 tox.ini 的 commands 中加入 python -c "import my_package; print(my_package.__file__)",确认导入的是安装后的包路径,而非源码路径

build 工具比 setup.py 更安全也更可控

python -m build 在临时隔离环境中执行构建,不会污染你当前的 Python 环境,也不执行任意代码——这直接规避了 python setup.py sdist 的安全风险和依赖冲突问题。

  • 运行前确认已安装 build:执行 pip install build(无需全局升级 pip,build 本身不依赖新版 pip)
  • 构建命令就是 python -m build,默认同时产出 .tar.gz(sdist)和 .whl(wheel);加 --wheel 或 --sdist 可单独指定
  • 生成的 .whl 文件名格式为 {name}-{version}-py{X.Y}-{platform}.whl,其中 py39 表示仅兼容 Python 3.9——若需多版本兼容,确保 requires-python 设置合理(如 ">=3.8"),且代码无版本专有语法
实际搭建时最易被忽略的点是:pyproject.toml 的 [project] 段缺失或字段拼写错误(比如写成 project-name 而非 name),会导致整个构建链路静默失效——既不报错,又生成无效 wheel。务必在 python -m build 后用 pip install --find-links dist/ --no-index my_package 验证安装是否真能成功导入。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python包 python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1751

4

python能做什么
python能做什么

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

2023.07.25

4484

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

26417

23

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

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

2023.08.04

3207

5

python eval
python eval

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

2023.08.04

3227

5

scratch和python区别
scratch和python区别

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

2023.08.11

1183

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2503

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习