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

如何在 pyproject.toml 中正确声明含连字符或下划线的可选依赖项

夏雪吖_8329

夏雪吖_8329

发布时间:2026-03-11 18:19:17

|

676人浏览过

|

来源于php中文网

原创

如何在 pyproject.toml 中正确声明含连字符或下划线的可选依赖项

本文详解 pep 685 规范下可选依赖(extras)的命名规范与兼容性实践,解决因连字符/下划线导致的 pip 安装警告、setuptools 解析失败等问题,并提供符合标准的配置方案与验证步骤。

本文详解 pep 685 规范下可选依赖(extras)的命名规范与兼容性实践,解决因连字符/下划线导致的 pip 安装警告、setuptools 解析失败等问题,并提供符合标准的配置方案与验证步骤。

在 Python 包开发中,通过 pyproject.toml 声明可选依赖(extras)是常见需求。但当 extra 名称包含连字符(-)或下划线(_)时,开发者常遇到如下典型问题:

  • 在 [tool.setuptools.dynamic.optional-dependencies] 中使用 some-extra 作为键名 → 报错:Key must be a valid Python identifier(TOML 键不支持 -);
  • 改用 some_extra 声明后,执行 pip install -e ".[some_extra]" → 却收到警告:WARNING: package X.X.X does not provide the extra 'some-extra';
  • 实际安装看似成功,但 extras 的元数据未被正确识别,影响依赖解析、工具链(如 pip show、pipdeptree)及 CI/CD 行为。

这并非配置错误,而是源于 PEP 685 —— Python Extras Normalization 的标准化要求:所有 extras 名称在分发与安装时必须进行标准化归一化(normalization),即统一转换为小写、替换 - 和 _ 为 -(实际等效于全部转为 - 分隔),并去除首尾空格。例如:

声明名称(TOML 键) 标准化后名称(pip 识别名)
some_extra some-extra
SomeExtra someextra
my-plugin-v2 my-plugin-v2

因此,some_extra 是合法的 TOML 键(符合 Python identifier 规则),且会被 setuptools 自动归一化为 some-extra;而你在命令行中应始终使用归一化后的形式调用:

# ✅ 正确:使用归一化名称(连字符形式)
pip install -e ".[some-extra]"

# ❌ 错误:使用原始键名(下划线形式)
pip install -e ".[some_extra]"

? 验证技巧:运行 pip show your-package-name,查看 Requires-Dist 字段中是否包含类似 your-package @ file:///...; extra == "some-extra" 的条目——这是归一化生效的关键证据。

✅ 推荐配置方式(兼容当前主流工具链)

确保你使用的是较新版本的构建后端(setuptools >= 69.0.0 已初步支持 PEP 685 归一化):

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

[project]
name = "your-package"
version = "0.1.0"
# 其他字段...

[project.optional-dependencies]
# ✅ 使用下划线命名(合法 identifier),由 setuptools 自动归一化
some_extra = ["requests>=2.28", "pydantic>=2.0"]
dev_tools = ["black>=23.0", "mypy>=1.0"]

[tool.setuptools.dynamic.optional-dependencies]
# ✅ 若需从文件动态加载,同样使用下划线键名
test_deps = {file = ["requirements-test.txt"]}

然后安装时严格使用归一化名称:

# 安装 some_extra → 实际解析为 some-extra
pip install -e ".[some-extra]"

# 安装多个 extras(逗号分隔,无需空格)
pip install -e ".[some-extra,dev-tools,test-deps]"

⚠️ 注意事项与常见陷阱

  • 不要手动修改 pyproject.toml 中的键名为 some-extra:TOML 不允许 - 作为标识符,会导致解析失败。
  • pip 的警告通常意味着 setuptools 归一化未生效:检查 setuptools 版本(python -m pip show setuptools),升级至 ≥69.0.0 并清理构建缓存(rm -rf build/ dist/ *.egg-info/)后重试。
  • 避免混用风格:同一项目中不要同时存在 some_extra 和 some-extra(后者非法),保持键名全为 snake_case 是最安全的选择。
  • CI/CD 中需显式指定 pip 版本:某些旧版 pip(

✅ 总结

可选依赖的名称在 pyproject.toml 中必须使用合法 Python identifier(推荐 snake_case),其语义等价于 PEP 685 定义的归一化名称;pip 安装时必须使用归一化形式(全小写、- 分隔)。这一机制保障了跨工具链(pip/setuptools/poetry/hatch)的行为一致性。只要确保构建依赖版本足够新,并严格区分“声明名”与“使用名”,即可无缝支持含分隔符的 extras 场景。

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

热门AI工具

更多
DeepSeek

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

SkildArt
SkildArt Hot

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

豆包大模型

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

Loomy
Loomy Hot

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

UpDream
UpDream Hot

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

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

WorkBuddy

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

相关专题

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

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

1891

2023.07.20

python能做什么
python能做什么

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

5184

2023.07.25

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

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

1829

2023.07.31

python教程
python教程

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

31337

2023.08.03

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

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

3707

2023.08.04

python eval
python eval

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

3727

2023.08.04

scratch和python区别
scratch和python区别

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

1243

2023.08.11

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

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

616

2023.08.10

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

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

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