如何用setuptools实现Python包开发时测源码、安装后测已安装包
核心解决思路
放弃在测试代码里硬写sys.path插入逻辑,完全依托Python标准导入机制 + setuptools的安装特性,实现两种场景的自动适配,不需要写额外的环境判断分支。
第一步:清理现有测试代码的冗余逻辑
把tests/test_my_package.py里这两行硬编码路径操作的内容完全删掉:
import sys sys.path.insert(0, "../")
调整后的测试文件初始部分保留最基础的导入即可:
import unittest from MyPackage.my_module import my_function class TestMyModule(unittest.TestCase): def test_somehting(self): self.assertTrue(my_function())
- 注意:原来加这两行是因为之前在tests目录下直接跑测试时,Python默认找不到上一级目录的本地MyPackage包,硬插路径是最偷懒的解决方式,但恰恰是这个操作破坏了导入优先级,导致不管什么环境都强制优先加载本地源码。
第二步:开发阶段的源码测试适配
不需要在代码里做特殊处理,只需要在项目根目录(即和MyPackage、tests、setup.py平级的目录)执行可编辑安装命令:
pip install -e .
这个命令的作用是把本地源码目录注册到Python的包查找路径中,属于“虚拟安装”,不会把源码复制到系统的site-packages目录。此时不管你在哪个目录跑测试,解释器都会定位到你本地的开发源码,修改my_module.py的内容后不需要重新执行安装,跑测试就能直接覆盖修改后的逻辑,完全满足开发阶段的测试需求。
开发阶段跑测试时,不要进到tests文件夹内部执行脚本,直接在项目根目录用unittest的发现模式运行即可:
python -m unittest discover -s tests
此时Python的默认导入路径天然包含项目根目录,不需要任何路径修改就能直接找到本地源码。
第三步:让分发包支持安装后的测试
要让用户安装包后能跑测试,需要在打包配置里把tests目录纳入分发范围,否则用户安装后根本拿不到测试代码:
- 在项目根目录新建
MANIFEST.in文件,写入规则让打包时带上tests目录下的所有Python文件:recursive-include tests *.py - 在
setup.py的配置里加上include_package_data=True,让setuptools按照MANIFEST.in的规则打包文件。
等用户通过pip install 你的包名正常安装包后,安装程序会把MyPackage包、tests目录一起复制到Python的site-packages路径下。此时用户不管在哪个目录运行测试,解释器的包查找路径里已经没有你的本地开发目录,会自然加载site-packages下的已安装版本MyPackage,测试跑的就是真实分发后的代码,完全不会串到开发源码。
常见注意事项
- 绝对不要在测试代码里写任何动态修改
sys.path的逻辑,哪怕是适配本地开发的临时代码也要删掉,否则会强行把本地源码的优先级拉到最高,即使用户安装了正式发布的包,测试还是会错误加载残留的本地源码,导致测试结果失真。 - 开发阶段的可编辑安装和用户的正常安装不要混在同一个Python环境里测试,避免导入优先级干扰;验证分发效果时可以新建一个干净的虚拟环境,执行正式安装命令后跑测试,结果才和真实用户的使用场景一致。
内容的提问来源于stack exchange,提问作者Leonardo
相关产品推荐
相关产品推荐

