尝试避免 Python 循环依赖

Question

我有一个测试环境来尝试了解如何避免使用import x 语句导入模块，而不是使用from x import y：

test/
    __init__.py
        testing.py
    a/
        __init__.py
        m_a.py
    b/
        __init__.py
        m_b.py

文件有以下内容：

testing.py：

from a.m_a import A

m_a.py：

import b.m_b
print b.m_b
class A:
    pass

m_b.py：

import a.m_a
print a.m_a
class B:
    pass

有一种情况我看不懂：

如果我从模块 m_a.py 和 m_b.py 或仅从 m_b.py 中删除打印语句，这可以正常工作，但如果打印出现在 m_b.py，则会引发以下错误：

File "testing.py", line 1, in <module>
  from a.m_a import A
File "/home/enric/test/a/m_a.py", line 1, in <module>
  import b.m_b
File "/home/enric/test/b/m_b.py", line 3, in <module>
  print a.m_a
AttributeError: 'module' object has no attribute 'm_a'

你有什么想法吗？

Answer 1

它仅在删除 print 语句的情况下“起作用”，因为您实际上并没有做任何依赖于导入的事情。它仍然是一个损坏的循环导入。

要么在调试器中运行它，要么在每一行之后添加print 语句，你会看到会发生什么：

• testing.py:from a.m_a import A
• a.m_a：import b.m_b
• b.m_b：import a.m_a
• b.m_b：print a.m_a

它显然是在模块完成导入之前尝试访问a.m_a。 （事实上​​，您可以在回溯中看到堆栈中的 a.m_a 的其余部分。）

如果此时您转储 sys.modules，您会发现两个名为 a 和 a.m_a 的部分模块，但如果您使用 dir(a)，则还没有 m_a。

据我所知，在m_a.py 完成评估之前，m_a 不会被添加到 a，这一事实在 Python 2.7 文档的任何地方都没有记录。 （3.x 有一个更完整的导入过程规范——但它也是一个非常不同的导入过程。）所以，你不能依赖这个失败 或 成功。任何一个对于实施都是完全合法的。 （但它恰好在至少 CPython 和 PyPy 中失败了……）

---

更一般地说，使用import foo 代替from foo import bar 并不能神奇地解决所有循环导入问题。它只是解决了一类特定的循环导入问题（或者，更确切地说，使该类没有实际意义）。 （我意识到the FAQ 中有一些关于此的误导性文字。）

---

有多种技巧可以解决循环导入问题，同时仍然让您拥有循环顶级依赖项。但实际上，摆脱循环顶级依赖项几乎总是更简单。

在这个玩具案例中，a.m_a 完全没有理由依赖b.m_b。如果您需要一些打印出 a.m_a 的内容，有比从完全独立的包中获得更好的方法！

在实际代码中，m_a 中可能有一些 m_b 需要的东西，反之亦然。但通常，您可以将其分为两个级别：m_a 中需要m_b 的内容，以及m_a 中需要m_b 的内容。因此，只需将其拆分为两个模块。这实际上与一堆试图备份的模块的常见修复相同，import main：将utils 与main 分开。

如果m_b 确实需要来自m_a 的东西，那也需要m_b 怎么办？那么，在这种情况下，您可能必须插入一个间接级别。例如，也许您可​​以将 thing-from-m_b 传递给来自m_a 的函数/构造函数/whatever，因此它可以将其作为本地参数值而不是全局参数值来访问。 （如果没有更具体的问题，很难更具体。）

如果最坏的情况发生，并且您无法通过间接删除导入，则必须将导入移开。这可能再次意味着在函数调用中进行导入等（如常见问题解答中紧接在让您离开的段落之后所解释的那样），或者只是将一些代码移到导入之上，或各种其他可能性。但是，请考虑这些最后的解决方案，以解决无法干净设计的问题，而不是您的设计要遵循的路线图。