0

0

Python pyproject.toml 的完整字段说明

舞夢輝影

舞夢輝影

发布时间:2026-02-19 15:26:03

|

491人浏览过

|

来源于php中文网

原创

pip install 仅读取 [build-system] 和 [project] 两个顶层表;前者需指定 requires 构建依赖,后者必填 name 和 version,其他字段如 [tool.*] 或 optional-dependencies 不影响安装行为。

python pyproject.toml 的完整字段说明

pyproject.toml 里哪些字段是 pip install 时真正读的

pip install(包括从源码构建)只认 [build-system][project] 这两个顶层表。其他字段比如 [tool.black][project.optional-dependencies] 不影响安装行为,只是工具约定。

常见错误:把 requires-python 写在 [tool.poetry] 下,结果 pip 完全无视——它只看 [project].requires-python

  • [build-system.requires] 必须包含构建依赖,例如 ["setuptools>=45", "wheel"];缺了可能导致 ModuleNotFoundError: No module named 'setuptools.build_meta'
  • [project]nameversion 是必填项,否则 pip 构建失败并报错 Invalid pyproject.toml config: 'project.name' is required
  • [project.version] 推荐用动态方式(如 dynamic = ["version"] + [tool.setuptools.dynamic.version]),硬编码易遗漏发布前更新

setuptools、flit、poetry 对 [project] 字段的支持差异

不是所有字段在所有构建后端里都生效。比如 [project.urls] 在 setuptools 和 flit 中生成 wheel 的 METADATA 正确,但 poetry 2.0+ 默认忽略它,除非显式启用 include = ["pyproject.toml"]

使用场景:你想让 pip show mypkg 显示项目主页和文档链接,就得确认当前构建后端是否导出 [project.urls] 到元数据。

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

空心菜的米库
空心菜的米库

1,对界面进行了美化2,对文件里边相同代码进行了综合3,增加了点击次数统计,并对3次点击以上的域名增加热门字样4,对本站出售和个人出售进行了划分5,增加钻石状态说明6,增加了完整的后台界面7,增加对资料修改功能8,增加回收站,可以任意删除域名、恢复删除域名和永久删除数据9,还有其他的细节大家自己看~10.增加域名证书显示11.域名到期时间采用日历控件形式12.后台登陆添加了验证码功能13.还有很多

下载
  • [project.dependencies] 所有后端都支持,但格式必须是 PEP 508 字符串列表,不能写成嵌套 TOML 表
  • [project.optional-dependencies] 全支持,但注意 poetry 会把 key 名自动转为小写并去空格,"Django Support" 变成 django-support
  • [project.entry-points."console_scripts"] setuptools/flit 没问题;poetry 需要额外配置 [tool.poetry.plugins."console_scripts"] 才能注册

动态 version 怎么写才不被 pip build 忽略

直接写 version = "1.2.3" 看似简单,但版本号一变就要手动改,CI/CD 容易出错。动态方案得让构建后端“看得见、算得对”。

最容易踩的坑:用 Python 文件读取 __version__.py,但没在 [build-system] 中声明该文件为构建依赖,导致在干净环境中构建失败。

  • 推荐做法:用 [project.version] 设为 dynamic = ["version"],再配 [tool.setuptools.dynamic.version] + attr = "mymodule.__version__"
  • 路径必须可 import:如果模块不在 src/ 下,得同步设 [tool.setuptools.package-dir],否则构建时报 ModuleNotFoundError
  • 避免用 file 方式读取版本文件——TOML 解析器不执行 Python,file = "VERSION" 仅在 setuptools 61.0+ 支持,且要求文件纯文本不含任何逻辑

Windows 上 pyproject.toml 路径或换行符引发的构建失败

不是语法问题,而是环境细节:CRLF 换行、BOM 头、路径含中文或空格,都会让某些构建后端(尤其是旧版 setuptools)静默失败或报奇怪错误。

典型现象:pip wheel . 卡住几秒后退出,无报错;或提示 Invalid value for 'project.name': must be non-empty,其实 name 明明写了。

  • 保存为 UTF-8 无 BOM(Notepad++ / VS Code 都可设),BOM 会导致 TOML 解析器跳过首行
  • 避免在 [project.readme] 中写相对路径如 readme = "README.md",如果项目根目录路径含空格,部分后端解析失败;改用 readme = {file = "README.md"} 更稳
  • Windows 用户若用 Git Bash,确保 core.autocrlf 设为 true,否则 CRLF 可能被误判为非法字符
事情说清了就结束。字段再多,最终起作用的也就那几个表;工具再花哨,pip 只信 [project][build-system]。其他全是锦上添花,别当真。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python Web 框架 Django 深度开发
Python Web 框架 Django 深度开发

本专题系统讲解 Python Django 框架的核心功能与进阶开发技巧,包括 Django 项目结构、数据库模型与迁移、视图与模板渲染、表单与认证管理、RESTful API 开发、Django 中间件与缓存优化、部署与性能调优。通过实战案例,帮助学习者掌握 使用 Django 快速构建功能全面的 Web 应用与全栈开发能力。

94

2026.02.04

pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

349

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

426

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

786

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

359

2025.07.23

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

573

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

216

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1553

2023.10.24

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

660

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.6万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号