0

0

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

碧海醫心

碧海醫心

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

|

616人浏览过

|

来源于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" 的条目——这是归一化生效的关键证据。

银河易创
银河易创

一站式AIGC创作平台,集成GPT-3.5、GPT-4、文心一言等对话模型、Midjourney、DallE等绘画工具、AI音乐、AI视频和AI PPT等功能!

下载

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

确保你使用的是较新版本的构建后端(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助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
pip安装使用方法
pip安装使用方法

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

373

2023.10.09

更新pip版本
更新pip版本

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

436

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、保存并关闭文件即可。

802

2024.12.23

python升级pip
python升级pip

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

370

2025.07.23

mysql标识符无效错误怎么解决
mysql标识符无效错误怎么解决

mysql标识符无效错误的解决办法:1、检查标识符是否被其他表或数据库使用;2、检查标识符是否包含特殊字符;3、使用引号包裹标识符;4、使用反引号包裹标识符;5、检查MySQL的配置文件等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

209

2023.12.04

Python标识符有哪些
Python标识符有哪些

Python标识符有变量标识符、函数标识符、类标识符、模块标识符、下划线开头的标识符、双下划线开头、双下划线结尾的标识符、整型标识符、浮点型标识符等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

322

2024.02.23

java标识符合集
java标识符合集

本专题整合了java标识符相关内容,想了解更多详细内容,请阅读下面的文章。

292

2025.06.11

c++标识符介绍
c++标识符介绍

本专题整合了c++标识符相关内容,阅读专题下面的文章了解更多详细内容。

177

2025.08.07

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

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

精品课程

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

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