python中遇到循环import即circular import的问题原理剖析及解决方案

在python中常常会遇到循环import即circular import的问题，今天主要给大家介绍了关于Python中循环引用（import）失败的解决方法，文中通过示例代码介绍的非常详细，需要的朋友可以参考借鉴。

一、前言

最近在开发智能家居项目项目中，由于代码结构层级划分不合理，导致了循环引用（import）module失败的问题，错误如下：

  File "./design_app/views.py", line 7, in <module>
    import alg.auto_design.evaluate as evaluate
  File "./alg/auto_design/evaluate.py", line 5, in <module>
    from alg.auto_design.helpers.json_io import json2fp
  File "./alg/auto_design/helpers/__init__.py", line 2, in <module>
    from alg.auto_design.helpers import json_io
  File "./alg/auto_design/helpers/json_io.py", line 14, in <module>
    from alg.auto_design.room_type.dingroom.base import DiningRoom
  File "./alg/auto_design/room_type/dingroom/base.py", line 13, in <module>
    from alg.auto_design_easyhome.utility import get_opposite_bounds
  File "./alg/auto_design_easyhome/utility.py", line 8, in <module>
    from alg.auto_design_easyhome.room_type.master_bedroom import \
  File "./alg/auto_design_easyhome/room_type/master_bedroom/__init__.py", line 3, in <module>
    from alg.auto_design_easyhome.room_type.master_bedroom.base import MainBedroom
  File "./alg/auto_design_easyhome/room_type/master_bedroom/base.py", line 6, in <module>
    from alg.auto_design_easyhome.helpers import extract_rec
  File "./alg/auto_design_easyhome/helpers/__init__.py", line 2, in <module>
    from alg.auto_design_easyhome.helpers import json_io
  File "./alg/auto_design_easyhome/helpers/json_io.py", line 14, in <module>
    from alg.auto_design_easyhome.room_type.dingroom.base import DiningRoom
  File "./alg/auto_design_easyhome/room_type/dingroom/base.py", line 13, in <module>
    from alg.auto_design_easyhome.utility import get_opposite_bounds
ImportError: cannot import name 'get_opposite_bounds' from partially initialized module 'alg.auto_design_easyhome.utility' (most likely due to a circular import) (./alg/auto_design_easyhome/utility.py)

二、import执行过程

当我们import一个文件时，python会首先去查找这个文件之前是否被import过，如果这个文件之前有被import过，就不会重新再import一次。所以如果A模块
代码里import了B模块，并且B模块里又import了A模块，python的执行顺序会变成这样：

• 开始执行模块A
• 当A执行到import B的地方，则停止执行A模块后面的代码，转而开始执行B模块的代码
• 当B模块从头执行到import A的地方时，python此时并不会回过头去接着执行A剩余的代码，而且将A模块在中断前已经初始化的属性全加载到B模块中

三、原理

这个时候就有一个问题，当前脚本Main第一次执行，需要执行from A import ，发现没有A，就新建一个A在内存中，然后填充A模块的信息，就会去执行A，此时，A里面要 from Main import D，那么因为Main已被执行，就直接从内存的map中取得Main的信息，不过此时Main的信息还没有填充完，因为之前就是为了填充才转到A的，这时从已有的空的Main中拿不到D，就会报错，ImportError。

四、解决方案

1、方案一 合理划分项目代码层级

循环引用最大的本质问题是代码层级结构划分的不合理，所以最根本的、最合理的解决方案就是重新划分好代码的层级结构，使其合理化，自然就规避了循环引用的麻烦。

2、方案二 只引用当前的包，不引用具体的模块

如果你的代码是这样，那么这种方式是会奏效的。

案例一：修改前

# a.py

from B import b

def a():

 pass

# some codes

# b.py

from A import a

def b():

 a.a()

#some codes

案例一：修改后

# a.py

from B import b

def a():

 pass

# some codes

# b.py

import A

def b():

 A.a.a()

#some codes

2、方案二 将引用放到函数内部

如果你的代码是这样，那么这种方式是会奏效的。

案例二：修改前

# a.py

from B import b

def a():

 pass

# some codes

# b.py

from A import a

def b():

 a.a()

#some codes

案例二：修改后

# a.py

from B import b

def a():

 pass

# some codes

# b.py

def b():

 from A import a

 a.a()

#some codes

五、总结

只有理解了python在import时的工作原理，这种cicular import的问题才会很好的分析和解决。