Django运行单元测试出现api模块循环导入ImportError,求排查方案
顺着报错栈的执行顺序,完整的死循环流程是这样的:
- 单元测试框架触发
api.serializers模块导入,Python开始执行api/serializers/__init__.py的第一行代码,从同目录default.py批量导入所有Serializer类 - Python切换执行
api/serializers/default.py的顶层导入逻辑,走到from api import views这行时,会暂停当前serializers模块的加载,转而开始加载api.views模块 - Python执行
api/views/__init__.py的导入逻辑,第一行就触发从同目录base.py导入权限类、工具方法 - Python切换执行
api/views/base.py的顶层导入逻辑,走到from api.serializers import ConfigSerializer这行时,会暂停当前views模块的加载,回头去找api.serializers里的ConfigSerializer - 此时
api.serializers模块还卡在加载default.py的阶段,根本没有执行到ConfigSerializer的定义、也没完成__init__.py的导出流程,Python找不到对应的类,直接抛出循环导入错误。
简单说就是两个模块卡在互相等待对方“先把自己需要的资源加载完”的死锁状态,谁都不肯先跑完加载流程。
- 沿着报错栈的调用顺序梳理双向导入链路,定位两个模块互相等待的死循环节点:这次的死循环节点就是
serializers/default.py顶层导入views资源、views/base.py顶层导入serializers资源的双向依赖 - 逐行检查跨模块导入的必要性:确认导入的资源是模块初始化阶段就必须用到,还是函数/方法运行时才会用到
- 检查代码的职责边界:有没有把本该属于某一层的代码硬塞到另一层的导出列表里,制造不必要的依赖
调整导入时机:将顶层导入移至函数内部
如果serializers/default.py里导入的api.views资源,只是Serializer的某个校验、保存方法里才会用到,就把这行从文件顶层删掉,挪到实际使用的方法内部:# 移除文件顶层的 from api import views def validate_some_field(self, value): # 实际用到时再导入,此时所有模块已经完成加载 from api import views # 后续调用views里的逻辑这种方式不会触发加载阶段的死锁,因为函数内部的导入是代码运行到对应位置才执行,此时所有模块早已完成初始化。
抽离公共依赖,切断循环链路
把views/base.py需要的ConfigSerializer从现有serializers/default.py中拆出来,放到一个没有任何上层依赖的独立文件里(比如新建api/serializers/config.py,单独存放这个类的实现):# api/serializers/config.py from rest_framework import serializers from api.models import Config class ConfigSerializer(serializers.ModelSerializer): class Meta: model = Config fields = "__all__"改完之后,
views/base.py直接从这个独立文件导入ConfigSerializer,不需要等整个serializers包加载完成,自然就不会和default.py里导入views的逻辑形成冲突。清理越界的导出内容
检查api/serializers/__init__.py的导出列表,里面混入了CustomTokenObtainPairView、IconSerializerView这类属于视图层的类,这类代码本来就不该放在serializers目录下导出。把这些类从serializers的导出列表中移除,放回对应的views文件中管理,从根源上删掉serializers/default.py必须导入views包的不合理依赖。
内容的提问来源于stack exchange,提问作者W.H.N.A.

