Python中的循环导入依赖

Question

假设我有以下目录结构：

a\
    __init__.py
    b\
        __init__.py
        c\
            __init__.py
            c_file.py
        d\
            __init__.py
            d_file.py

在a 包的__init__.py 中，导入了c 包。但是c_file.py 导入a.b.d。

程序失败，当c_file.py 尝试导入a.b.d 时，说b 不存在。 （而且它确实不存在，因为我们正在导入它。）

如何解决这个问题？

Answer 1

您可以推迟导入，例如在a/__init__.py：

def my_function():
    from a.b.c import Blah
    return Blah()

也就是说，将导入推迟到真正需要时。但是，我也会仔细查看我的包定义/使用，因为像所指出的那样的循环依赖可能表明存在设计问题。

Answer 2

如果a依赖c，c依赖a，那么它们实际上不是同一个单元吗？

您应该真正检查一下为什么将 a 和 c 拆分为两个包，因为要么您有一些代码应该拆分到另一个包中（使它们都依赖于该新包，但不依赖于彼此），或者您应该将它们合并到一个包中。

Answer 3

我曾多次想过这个问题（通常是在与需要相互了解的模型打交道时）。简单的解决方案就是导入整个模块，然后引用你需要的东西。

所以不要这样做

from models import Student

合而为一，

from models import Classroom

在另一个，只是做

import models

其中之一，然后在需要时致电models.Classroom。

Answer 4

类型提示导致的循环依赖

使用类型提示，创建循环导入的机会更多。幸运的是，有一个使用特殊常量的解决方案：typing.TYPE_CHECKING。

以下示例定义了一个Vertex 类和一个Edge 类。一条边由两个顶点定义，一个顶点维护一个它所属的相邻边的列表。

没有类型提示，没有错误

文件：vertex.py

class Vertex:
    def __init__(self, label):
        self.label = label
        self.adjacency_list = []

文件：edge.py

class Edge:
    def __init__(self, v1, v2):
        self.v1 = v1
        self.v2 = v2

类型提示导致 ImportError

ImportError：无法从部分初始化的模块“edge”导入名称“Edge”（很可能是由于循环导入）

文件：vertex.py

from typing import List
from edge import Edge


class Vertex:
    def __init__(self, label: str):
        self.label = label
        self.adjacency_list: List[Edge] = []

文件：edge.py

from vertex import Vertex


class Edge:
    def __init__(self, v1: Vertex, v2: Vertex):
        self.v1 = v1
        self.v2 = v2

使用 TYPE_CHECKING 的解决方案

文件：vertex.py

from typing import List, TYPE_CHECKING

if TYPE_CHECKING:
    from edge import Edge


class Vertex:
    def __init__(self, label: str):
        self.label = label
        self.adjacency_list: List['Edge'] = []

文件：edge.py

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from vertex import Vertex


class Edge:
    def __init__(self, v1: 'Vertex', v2: 'Vertex'):
        self.v1 = v1
        self.v2 = v2

带引号和不带引号的类型提示

在 3.10 之前的 Python 版本中，有条件导入的类型必须用引号括起来，使它们成为“前向引用”，从而对解释器运行时隐藏它们。

在 Python 3.7、3.8 和 3.9 中，一种解决方法是使用以下特殊导入。

from __future__ import annotations

这允许使用不带引号的类型提示和条件导入。

Python 3.10（见PEP 563 -- Postponed Evaluation of Annotations）

在 Python 3.10 中，函数和变量注释将不再是 在定义时进行评估。相反，将保留字符串形式 在各自的 annotations 字典中。静态类型检查器 将看到行为没有差异，而使用注释的工具 运行时将不得不执行延迟评估。

字符串形式是在编译阶段从AST中获取的， 这意味着字符串形式可能不会保留确切的 源的格式。注意：如果注释是字符串文字 已经，它仍然会被包裹在一个字符串中。

Answer 5

问题是当从一个目录运行时，默认情况下只有子目录的包作为候选导入可见，所以你不能导入 a.b.d。但是，您可以导入 b.d.因为 b 是 a 的子包。

如果你真的想在c/__init__.py 中导入a.b.d，你可以通过将系统路径更改为a 上方的一个目录并将a/__init__.py 中的导入更改为import a.b.c.

您的a/__init__.py 应如下所示：

import sys
import os
# set sytem path to be directory above so that a can be a 
# package namespace
DIRECTORY_SCRIPT = os.path.dirname(os.path.realpath(__file__)) 
sys.path.insert(0,DIRECTORY_SCRIPT+"/..")
import a.b.c

当您想将 c 中的模块作为脚本运行时，会出现另一个困难。这里包 a 和 b 不存在。您可以破解 c 目录中的 __int__.py 以将 sys.path 指向顶级目录，然后在 c 内的任何模块中导入 __init__ 以便能够使用完整路径导入 a.b.d。我怀疑导入 __init__.py 是一种好习惯，但它对我的用例有效。

Answer 6

我建议以下模式。使用它将允许自动完成和类型提示正常工作。

cyclic_import_a.py

import playground.cyclic_import_b

class A(object):
    def __init__(self):
        pass

    def print_a(self):
        print('a')

if __name__ == '__main__':
    a = A()
    a.print_a()

    b = playground.cyclic_import_b.B(a)
    b.print_b()

cyclic_import_b.py

import playground.cyclic_import_a

class B(object):
    def __init__(self, a):
        self.a: playground.cyclic_import_a.A = a

    def print_b(self):
        print('b1-----------------')
        self.a.print_a()
        print('b2-----------------')

---

您不能使用此语法导入 A 类和 B 类

from playgroud.cyclic_import_a import A
from playground.cyclic_import_b import B

---

你不能在 B 类的 __init __ 方法中声明参数 a 的类型，但是你可以这样“转换”它：

def __init__(self, a):
    self.a: playground.cyclic_import_a.A = a

Answer 7

另一种解决方案是为 d_file 使用代理。

例如，假设您想与 c_file 共享 blah 类。因此，d_file 包含：

class blah:
    def __init__(self):
        print("blah")

这是您在 c_file.py 中输入的内容：

# do not import the d_file ! 
# instead, use a place holder for the proxy of d_file
# it will be set by a's __init__.py after imports are done
d_file = None 

def c_blah(): # a function that calls d_file's blah
    d_file.blah()

并且在a的init.py中：

from b.c import c_file
from b.d import d_file

class Proxy(object): # module proxy
    pass
d_file_proxy = Proxy()
# now you need to explicitly list the class(es) exposed by d_file
d_file_proxy.blah = d_file.blah 
# finally, share the proxy with c_file
c_file.d_file = d_file_proxy

# c_file is now able to call d_file.blah
c_file.c_blah()