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打包生态而言,这类问题的讨论有助于推动工具链的进一步完善。
登录后查看全文
热门项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C093
baihu-dataset异构数据集“白虎”正式开源——首批开放10w+条真实机器人动作数据,构建具身智能标准化训练基座。00
mindquantumMindQuantum is a general software library supporting the development of applications for quantum computation.Python058
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
AgentCPM-Explore没有万亿参数的算力堆砌,没有百万级数据的暴力灌入,清华大学自然语言处理实验室、中国人民大学、面壁智能与 OpenBMB 开源社区联合研发的 AgentCPM-Explore 智能体模型基于仅 4B 参数的模型,在深度探索类任务上取得同尺寸模型 SOTA、越级赶上甚至超越 8B 级 SOTA 模型、比肩部分 30B 级以上和闭源大模型的效果,真正让大模型的长程任务处理能力有望部署于端侧。Jinja00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
474
3.54 K
React Native鸿蒙化仓库
JavaScript
287
339
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
224
92
Ascend Extension for PyTorch
Python
283
316
暂无简介
Dart
723
175
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
849
441
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.27 K
701
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
65
19