Flit项目中的可选依赖项命名规范变更解析

在Python打包工具Flit的最新版本3.10中，引入了一个重要的变更：对可选依赖项(optional-dependencies)命名的规范化处理。这一变更源自PEP 685标准，要求所有可选依赖项名称在最终生成的元数据中必须使用连字符(hyphen)而非下划线(underscore)。

变更背景

Flit 3.10版本实现了PEP 685标准，该标准规定了Python包元数据中额外依赖项名称的规范化格式。在旧版本中，开发者可以在pyproject.toml文件中自由使用下划线或连字符来命名可选依赖项。但从3.10开始，Flit会在构建过程中将所有可选依赖项名称中的下划线自动转换为连字符。

影响范围

这一变更主要影响以下场景：

1. 当使用较旧版本的pip(23.3之前)安装带有可选依赖项的包时
2. 在命令行或requirements文件中指定可选依赖项时仍使用下划线的情况

具体表现为：如果开发者在pyproject.toml中定义了名为"model_diffs"的可选依赖项，但在安装时使用pip install .[model_diffs]命令，较旧版本的pip会报告"不提供额外的'model_diffs'"警告。

解决方案

针对这一问题，开发者有以下几种解决方案：

1. 升级pip工具：使用pip 23.3或更高版本，这些版本已经实现了对依赖项名称的自动规范化处理

2. 修改安装命令：在安装命令中使用连字符而非下划线，例如将pip install .[model_diffs]改为pip install .[model-diffs]

3. 限制flit_core版本：在pyproject.toml中明确指定使用flit_core 3.9或更早版本：

[build-system]
requires = ['flit_core>=3.2,<3.10']

技术细节

值得注意的是，这一规范化处理仅适用于可选依赖项名称。在pyproject.toml文件的其他部分，如常规依赖项声明或构建系统要求中，仍然可以使用下划线。例如flit_core>=3.2这样的写法是完全有效的。

这种差异化的处理是因为PEP 685标准特别针对的是额外依赖项(extras)的命名规范，而不是包元数据中的所有名称。核心元数据规范2.3版本明确规定了这一要求，旨在统一Python生态系统中的命名惯例。

最佳实践

为避免潜在问题，建议开发者：

1. 在pyproject.toml中定义可选依赖项时，优先使用连字符
2. 保持构建工具(pip等)更新到最新版本
3. 在文档和示例中统一使用连字符格式

对于维护大型项目或需要支持多种环境的开发者，可以考虑在项目文档中明确说明这一要求，或在CI/CD流程中加入版本检查，确保构建环境符合要求。

这一变更虽然带来了一些短期的适配工作，但从长远来看有助于统一Python打包生态系统的规范，减少因命名差异导致的兼容性问题。