Poetry项目中的include与exclude规则变更解析

背景介绍

Python打包工具Poetry在2.0版本中对文件包含/排除规则进行了重要变更，这一变更影响了项目构建时文件的打包行为。本文将深入分析这一变更的技术细节、影响范围以及应对策略。

问题本质

在Poetry 1.x版本中，include规则优先级高于exclude规则。这意味着如果一个文件同时匹配include和exclude模式，它最终会被包含在构建结果中。然而在Poetry 2.0+版本中，这一行为发生了改变。

变更细节

Poetry 2.0引入的关键变更包括：

1. 优先级规则变更：exclude现在会覆盖include的匹配结果
2. 格式限定支持：新增了format字段，允许开发者指定包含规则适用的构建格式（sdist或wheel）

实际影响

这一变更导致以下场景出现问题：

• 动态生成的文件（如版本文件）可能被意外排除
• 显式包含的文件如果也匹配排除模式，将不会被包含
• 构建wheel包时，默认不包含仅指定了sdist格式的文件

解决方案

针对这一变更，开发者可以采取以下应对策略：

方法一：明确指定格式

[tool.poetry]
include = [
    { path = "src/project/version.py", format = ["wheel"] }
]

方法二：调整排除规则

确保排除规则不会意外覆盖需要包含的文件：

[tool.poetry]
exclude = [
    "**/__pycache__",
    "**/*.py[cod]"
]

方法三：降级Poetry-core（临时方案）

[build-system]
requires = ["poetry-core>=1.0.0,<2.0.0"]

最佳实践建议

1. 显式优于隐式：总是明确指定文件的包含格式
2. 测试验证：构建后检查文件是否按预期包含
3. 文档更新：在项目文档中记录文件包含策略
4. 版本控制：在pyproject.toml中锁定Poetry-core版本

技术原理

Poetry的文件选择器现在采用两阶段处理：

1. 首先应用所有包含规则
2. 然后应用排除规则过滤结果
3. 最后根据格式规范进行最终筛选

这种变更使构建行为更加明确，但也要求开发者更加精确地定义文件包含策略。

总结

Poetry 2.0的文件包含规则变更虽然带来了短期适配成本，但从长远看提高了构建过程的确定性和可控性。理解这些变更并采取适当的应对措施，将帮助开发者更有效地管理项目构建过程。