包内导入并不总是有效

Question

我有一个结构如下的 Django 项目：

appname/
   models/
      __init__.py
      a.py
      base.py
      c.py

... 其中 appname/models/__init__.py 仅包含如下语句：

from appname.models.base import Base
from appname.models.a import A
from appname.models.c import C

... 以及 appname/models/base.py 包含的位置：

import django.db.models


class Base(django.db.models.Model):
   ...

appname/models/a.py 包含在哪里：

import appname.models as models


class A(models.Base):
   ....

...对于 appname/models/c.py 等也是如此。

我对我的代码的这种结构非常满意，但它当然不起作用，因为循环导入。

当 appname/__init__.py 运行时，appname/models/a.py 会运行，但该模块导入“appname.models”，它还没有完成执行。经典循环导入。

所以这应该表明我的代码结构很差，需要重新设计以避免循环依赖。

有哪些方法可以做到这一点？

我能想到的一些解决方案以及为什么我不想使用它们：

1. 将我所有的模型代码合并到一个文件中：在我看来，在同一个文件中包含 20 多个类比我尝试做的（使用单独的文件）要糟糕得多。
2. 将“Base”模型类移动到“appname/models”之外的另一个包中：这意味着我最终会在我的项目中使用包含基类/父类的包，理想情况下，这些类应该被拆分到它们所在的包中子/子类位于。除了避免循环导入之外，为什么我应该在同一个包中而不是在它们自己的包中（子类/子类所在的位置）中包含模型、表单、视图等的基类/父类？

所以我的问题不仅仅是如何避免循环导入，而是以一种与我尝试实施的方式一样干净（如果不是更干净）的方式来做到这一点。

谁有更好的办法？

Answer 1

编辑

我对此进行了更彻底的研究，并得出结论，这是核心 Python 或 Python 文档中的错误。更多信息请访问at this question and answer。

Python 的 PEP 8 表明绝对优先于相对导入。这个问题有一个涉及相对导入的解决方法，并且在导入机制中有一个可能的解决方法。

我在下面的原始答案给出了示例和解决方法。

原答案

正如您正确推断的那样，问题是循环依赖。在某些情况下，Python 可以很好地处理这些问题，但如果嵌套导入过多，就会出现问题。

例如，如果你只有一个包级别，实际上很难打破它（没有相互导入），但是一旦你嵌套包，它就更像是相互导入，它开始变成很难让它工作。这是一个引发错误的示例：

level1/__init__.py

    from level1.level2 import Base

level1/level2/__init__.py

    from level1.level2.base import Base
    from level1.level2.a import A

level1/level2/a.py

    import level1.level2.base
    class A(level1.level2.base.Base): pass

level1/level2/base

    class Base: pass

错误可以通过几种不同的方式“修复”（对于这个小案例），但许多潜在的修复是脆弱的。例如，如果您不需要在 level2 __init__ 文件中导入 A，删除该导入将解决问题（并且您的程序可以稍后执行 import level1.level2.a.A），但是如果您的包变得更复杂，你会看到错误再次出现。

Python 有时可以很好地完成这些复杂的导入工作，但关于它们何时会起作用和何时不会起作用的规则根本不直观。一个普遍的规则是from xxx.yyy import zzz 可以比import xxx.yyy 更宽容，然后xxx.yyy.zzz。在后一种情况下，解释器必须完成将yyy绑定到xxx命名空间时才能检索xxx.yyy.zzz，但在前一种情况下，解释器可以遍历包中的模块级别包命名空间已完全建立。

所以对于这个例子，真正的问题是在a.py 中的裸导入这很容易解决：

    from level1.level2.base import Base
    class A(Base): pass

始终使用相对导入是强制使用 from ... import 的好方法，原因很简单，如果没有 from'. To use relative imports with the example above,level1/level2/a.py` 应该包含以下内容，相对导入将不起作用：

from .base import Base
class A(Base): pass

这打破了有问题的导入周期，其他一切正常。如果导入的名称（例如 Base）在没有以源模块名称为前缀的情况下过于通用，您可以在导入时轻松重命名：

from .base import Base as BaseModel
class A(BaseModel): pass

虽然这解决了当前的问题，但如果包结构变得更复杂，您可能需要考虑更普遍地使用相对导入。例如，level1/level2/__init__.py 可以是：

from .base import Base
from .a import A