Python中循环引用（import）失败的解决方法

Posted 2021-01-11 lnlvinso

　　原文链接：http://blog.ihuxu.com/the-solution-to-the-problem-of-circular-import-in-python/

　　我是采用方案三 "将引用放到函数内部"解决了这个问题。下面为原文。

 

　　前言

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

Traceback (most recent call last):
  File "./main.py", line 8, in <module>
    from hestiarpi.library.server import server
  File "/home/pi/server/hestiarpi/library/server/server.py", line 4, in <module>
    from hestiarpi.library.brain import handler
  File "/home/pi/server/hestiarpi/library/brain/handler.py", line 5, in <module>
    from hestiarpi.library.brain import monitor
  File "/home/pi/server/hestiarpi/library/brain/monitor.py", line 6, in <module>
    from hestiarpi.library.server import server
ImportError: cannot import name server

　　原理

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

 

　　解决方案

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

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

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

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

　　修改前

# 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

　　方案三 将引用放到函数内部

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

　　修改前

# 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