[Python]导入循环问题

一、导入循环
在大型的Python工程中，由于架构设计不当，可能会出现模块间相互引用的情况。
这时候需要通过一些方法来解决这个问题.
（1）重新设计架构，解除相互引用的关系。
（2）把import语句放置在模块的最后
（3）把import语句放置在函数中
1、重新设计架构，解除相互引用
-------- 后续补充 ---------
2、把import语句放置在模块最后
-------- 后续补充 ---------

3、把import语句放置在函数中

例子：一个系统由两部分组成，包括control主模块和submodule模块。

其中control模块包含ctlCommon()和control()，submodule模块包含submodule()，并且在submodule()中会用到ctlCommon()。

# control.py
from submodule import submodule
def ctlCommon():
    print("enter ctlCommon")

def control():
    print("-------Enter control-------")
    submodule()
    print("++++++++Exit control+++++++")

control()

# submodule.py
import control
def submodule():
    print("enter submodule calling ctlCommon")
    control.ctlCommon()

分析1：执行control.py
从Traceback看， 两个模块互相导入，造成导入循环错误。

$ python control.py    # 执行control.py
Traceback (most recent call last):
  File "D:\SelfStudy\PythonStudy\grammar\basic usage\module\control.py", line 2, in <module>
    from submodule import submodule
  File "D:\SelfStudy\PythonStudy\grammar\basic usage\module\submodule.py", line 2, in <module>
    import control
  File "D:\SelfStudy\PythonStudy\grammar\basic usage\module\control.py", line 2, in <module>
    from submodule import submodule
ImportError: cannot import name 'submodule'

方案：把submodule.py中的导入模块语句放在函数中

# submodule.py
def submodule():
    import control
    print("enter submodule calling ctlCommon")
    control.ctlCommon()

结果分析：为了更好的理解执行过程，我们把submodule()在control()函数中展开。

执行control.py，会去执行control()函数。control()函数的执行步骤：

step1、执行(a)

step2、import control，由于是第一次导入(import)，会加载(load)该模块。

该模块的导入代码会被执行，因此执行一次control()函数。结果中黑色加粗的部分。

step3、顺序执行(b), (c), (d)

def control():
    print("-------Enter control-------")         # (a)
    #submodule()    # 把submodule()函数展开
    import control
    print("enter submodule calling ctlCommon")   # (b)
    control.ctlCommon()                          # (c)
    print("++++++++Exit control+++++++")         # (d)

$ python control.py    # 执行control.py
-------Enter control-------                     #（a）
-------Enter control-------
enter submodule calling ctlCommon
enter ctlCommon
++++++++Exit control+++++++
enter submodule calling ctlCommon               # (b)
enter ctlCommon                                 # (c)
++++++++Exit control+++++++                     # (d)

分析2：执行submodule.py

$ python submodule.py
-------Enter control-------                     # (a)
enter submodule calling ctlCommon
enter ctlCommon
++++++++Exit control+++++++                     # (d)

结果分析：

执行submodule模块，首先去导入和加载control模块

#import control   # 第一次导入会去执行顶层目录代码，也就是说会去执行control()
control()         # control中会先执行打印(a), 然后调用submodule(), 最后执行打印(d)
def submodule():
    print("enter submodule calling ctlCommon")
    control.ctlCommon()