setuptools项目中的sdist打包问题:.tox目录被意外包含
2025-06-29 18:07:51作者:龚格成
在Python项目的打包过程中,源代码分发(sdist)是一个关键环节。近期在setuptools项目中发现了一个值得注意的问题:构建的sdist包中意外包含了.tox目录及其内容。这个问题虽然看似简单,但涉及到Python打包机制的核心原理,值得深入探讨。
问题本质
.tox目录是tox测试工具的工作目录,通常包含测试环境、依赖项和临时文件。按照Python打包的最佳实践,这类与开发测试相关的目录不应该被包含在最终的分发包中。然而在setuptools 73.0.1版本中,.tox/release/lib/下的所有文件都被错误地打包进了sdist。
影响分析
这种问题会导致几个潜在影响:
- 包体积膨胀:
.tox目录通常包含大量测试依赖,会显著增加包的大小 - 潜在安全风险:可能意外包含敏感信息或测试配置
- 安装干扰:虽然这些文件通常不会影响安装,但可能造成混淆
技术背景
在Python打包过程中,MANIFEST.in文件用于精确控制哪些文件应该被包含在sdist中。默认情况下,setuptools会包含项目目录下的所有Python文件和一些标准文件,但应该排除开发工具生成的目录。
解决方案
针对这个问题,有两种可行的解决方案:
- 显式排除:在
MANIFEST.in中添加prune .tox指令,明确排除整个tox目录 - 修改默认行为:改进setuptools的
sdist命令,使其默认排除常见的开发目录如.tox
第一种方案简单直接,第二种方案更具普适性,可以惠及所有使用setuptools的项目。
最佳实践建议
对于Python项目维护者,建议:
- 定期检查项目的sdist内容
- 在
MANIFEST.in中明确包含和排除规则 - 使用
check-manifest工具验证打包内容 - 在CI流程中加入打包内容检查
这个问题的发现提醒我们,即使是成熟的工具链如setuptools,也需要持续关注其打包行为,确保符合预期。对于Python打包生态而言,这类问题的讨论有助于推动工具链的进一步完善。
登录后查看全文
热门项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5-w4a8GLM-5-w4a8基于混合专家架构,专为复杂系统工程与长周期智能体任务设计。支持单/多节点部署,适配Atlas 800T A3,采用w4a8量化技术,结合vLLM推理优化,高效平衡性能与精度,助力智能应用开发Jinja00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
MiniMax-M2.5MiniMax-M2.5开源模型,经数十万复杂环境强化训练,在代码生成、工具调用、办公自动化等经济价值任务中表现卓越。SWE-Bench Verified得分80.2%,Multi-SWE-Bench达51.3%,BrowseComp获76.3%。推理速度比M2.1快37%,与Claude Opus 4.6相当,每小时仅需0.3-1美元,成本仅为同类模型1/10-1/20,为智能应用开发提供高效经济选择。【此简介由AI生成】Python00
ruoyi-plus-soybeanRuoYi-Plus-Soybean 是一个现代化的企业级多租户管理系统,它结合了 RuoYi-Vue-Plus 的强大后端功能和 Soybean Admin 的现代化前端特性,为开发者提供了完整的企业管理解决方案。Vue06- RRing-2.5-1TRing-2.5-1T:全球首个基于混合线性注意力架构的开源万亿参数思考模型。Python00
Qwen3.5Qwen3.5 昇腾 vLLM 部署教程。Qwen3.5 是 Qwen 系列最新的旗舰多模态模型,采用 MoE(混合专家)架构,在保持强大模型能力的同时显著降低了推理成本。00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
570
3.85 K
Ascend Extension for PyTorch
Python
383
457
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
894
680
暂无简介
Dart
804
198
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
353
210
昇腾LLM分布式训练框架
Python
119
146
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
68
20
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.37 K
781