python模块交叉引用的错误案例

网络上有一则关于python模块交叉引用的错误案例说明，很经典。先给出链接：https://wiki.woodpecker.org.cn/moin/MiscItems/2008-11-25。

我还是需要先对这个问题做一个说明，有如下两个python文件，代码如下：

$ cat a.py
from b import d
class c: pass
$ cat b.py
from a import c
class d: pass

执行a.py或b.py，会出现如下错误：

$ python3 a.py
Traceback (most recent call last):
  File "a.py", line 1, in 
    from b import d
  File "/home/xinlin/test/b.py", line 1, in <module>
    from a import c
  File "/home/xinlin/test/a.py", line 1, in <module>
    from b import d
ImportError: cannot import name 'd' from 'b' (/home/xinlin/test/b.py)
$ python3 b.py
Traceback (most recent call last):
  File "b.py", line 1, in 
    from a import c
  File "/home/xinlin/test/a.py", line 1, in <module>
    from b import d
  File "/home/xinlin/test/b.py", line 1, in <module>
    from a import c
ImportError: cannot import name 'c' from 'a' (/home/xinlin/test/a.py)

出现ImportError错误！这就是模块交叉引用造成的错误。如何这个错误，就要深入python的from ... import ...机制。

这段解释很详细，括号中的为我自己加的内容：

1、执行A.py中的from B import D
    由于是执行的python A.py，所以在sys.modules中并没有<module B>存在，
    首先为B.py创建一个module对象(<module B>)，
      注意，这时创建的这个module对象是空的，里边啥也没有，（sys.modules是一个dict对象，module B为空，表示这个dict的module B这个key也不存在）
    在Python内部创建了这个module对象之后，就会解析执行B.py，其目的是填充<module B>这个dict。

2、执行B.py中的from A import C
    在执行B.py的过程中，会碰到这一句，
    首先检查sys.modules这个module缓存中是否已经存在<module A>了，
    由于这时缓存还没有缓存<module A>，
    所以类似的，Python内部会为A.py创建一个module对象(<module A>)，
    然后，同样地，执行A.py中的语句

3、再次执行A.py中的from B import D
    这时，由于在第1步时，创建的<module B>对象已经缓存在了sys.modules中，
    所以直接就得到了<module B>，
    但是，注意，从整个过程来看，我们知道，这时<module B>还是一个空的对象，里面啥也没有，
    所以从这个module中获得符号"D"的操作就会抛出异常。
    如果这里只是import B，由于"B"这个符号在sys.modules中已经存在，所以是不会抛出异常的。

修正错误的方法，就是不要使用from ... import ...这个语句，直接import即可！

我始终觉着这是个设计问题，python a.py的时候，就不应该在其它模块中 import a！交叉引用本来就是个设计问题，层次不明。

下面的case，用来说明交叉引用不是好的设计：

$ cat a.py
import b
aa = 123
print(aa)
$ cat b.py
import a
bb = 234
$ python3 a.py
123
123

在执行python3 a.py的时候，模块中的print语句被执行了两次！因为通过b.py的import a执行了第1次，然后由于a.py是在__main__中运行，其代码必然会被继续执行。

下面这种场景，就不会出现多次执行的情况：

$ cat a.py
import b
import c
$ cat b.py
import d
$ cat c.py
import d
$ cat d.py
print('asd')
$ python3 a.py
asd

d.py中的print语句只执行了一次。

-- EOF --

相关文章