Snakemake项目构建体系现代化改造：从传统setup.py迁移至pyproject.toml

在Python生态系统中，项目构建和打包方式正在经历重大变革。作为知名的生物信息学工作流管理系统，Snakemake近期完成了其构建体系的现代化改造，将原本基于setuptools、versioneer和setup.cfg的传统构建方式，全面迁移到了符合PEP 517/518标准的pyproject.toml配置体系。

传统构建方式的局限性

在改造前，Snakemake采用Python生态中常见的传统构建方案：

• 使用setup.py作为构建入口
• 通过versioneer工具管理版本号
• 依赖setup.cfg进行静态配置

这种组合虽然在过去被广泛使用，但存在多个痛点：

1. 构建逻辑分散在多个文件中，维护成本高
2. versioneer作为独立工具增加了复杂性
3. 不符合现代Python打包标准(PEP 517/518)
4. 难以与新兴构建工具(如uv、pixi等)良好集成

现代化改造方案

项目团队决定采用pyproject.toml作为唯一的构建配置文件，这一改变带来了显著优势：

统一配置入口

所有构建配置集中到单个pyproject.toml文件中，包括：

• 项目元数据(名称、版本、作者等)
• 构建系统要求
• 依赖声明
• 开发工具配置

版本管理简化

移除了versioneer依赖，改为直接在pyproject.toml中管理版本，或通过构建时动态获取版本号的方式。

构建工具兼容性

新的配置方式完全符合PEP 517/518标准，可以：

• 与pip最新版本无缝协作
• 支持新兴构建工具如uv、pixi等
• 保持与setuptools的向后兼容

技术实现要点

迁移过程中涉及几个关键技术决策：

1. 构建后端选择：虽然可以继续使用setuptools作为后端，但更推荐使用现代替代方案如hatchling或pdm-backend

2. 动态版本处理：对于需要从git tag获取版本号的情况，可以通过构建钩子实现，而不再依赖versioneer

3. 多项目统一：不仅主Snakemake包完成迁移，所有相关插件和接口包也同步更新了构建方式

4. 开发环境标准化：结合pyproject.toml，可以使用现代开发环境管理工具如uv或pixi，确保开发与生产环境一致

迁移带来的收益

这一架构改造为Snakemake项目带来了多方面改进：

1. 更简单的贡献流程：新贡献者不再需要理解复杂的多文件构建系统

2. 更快的构建速度：现代构建工具通常具有更好的性能

3. 更好的工具集成：与CI/CD系统、IDE和新兴Python工具的集成更顺畅

4. 面向未来的基础：为后续采用更多Python打包新特性奠定了基础

经验总结

对于考虑类似迁移的项目，Snakemake的经验表明：

1. 迁移过程虽然需要一定工作量，但长期收益显著

2. 建议分阶段进行，先确保pyproject.toml与原有系统共存，再逐步移除旧配置

3. 需要全面测试各种安装场景(源码安装、wheel安装、开发模式等)

4. 文档更新要与代码变更同步，特别是贡献指南部分

这一改造使Snakemake保持了在生物信息学工具链中的技术领先地位，也为其他科学计算项目的现代化提供了参考范例。