【记录】Python3｜Python出现循环引用模块怎么办？（又称循环依赖）

前言

在Python开发过程中，尤其是在大型项目中，我们经常会遇到模块间相互依赖的情况。这种相互依赖，即所谓的“循环引用”，往往会导致代码难以维护，并可能引发各种运行时问题。在这篇博客中，我们将探讨Python中循环引用的问题，并提供一些有效的解决方案。

问题

循环引用通常发生在两个或多个模块互相导入对方的情况下。例如，模块A导入模块B，同时模块B也导入模块A。这种情况下，如果不妥善处理，可能会导致程序在运行时遇到导入错误或者初始化失败的问题。

解决办法

1. 局部导入：
   最简单且常用的方法是将导入语句放在函数或方法内部。这种做法可以延迟导入的过程，直到函数被调用时才进行，从而避免初始化时的循环依赖。

   说实在话，我是真没想到解决办法竟然如此简单！！！请让我们谢谢ChatGPT！

   # 在module1.py
   def func1():
       from module2 import func2
       # 使用 func2
   
   # 在module2.py
   def func2():
       from module1 import func1
       # 使用 func1
   

2. 重构代码结构：
   通过重新组织代码，将相互依赖的部分放入同一个模块中，或者创建一个新的模块来存放共享的代码部分。

3. 延迟类型注解（Python 3.7+）：
   对于类型注解中的循环依赖，使用 from __future__ import annotations 可以延迟类型注解的评估。

4. 使用接口或抽象类：
   定义接口或抽象基类，并在一个模块中实现这些接口，而在另一个模块中引用，可以减少直接的模块依赖。

5. 依赖注入：
   将需要的对象或函数作为参数传递给函数或类，而非直接在模块层面导入。

结束语

循环引用是Python项目中常见的一个问题，但通过上述方法，我们可以有效地解决或绕过这一难题。值得注意的是，虽然局部导入是一个快速解决问题的办法，但从长远来看，重构代码以消除循环依赖通常是更健康和可持续的解决方案。希望这篇博客能帮助你在Python项目中更好地处理模块间的依赖关系！

ps: 我最初采用了局部导入的方式，但是发现还是有解决不了的问题（比如局部导入后该导入又被其他文件在其他地方引用，总之就是极其复杂）。最后小小地重新整理了一下代码。我的做法是这样的：

1. 对于多个文件需要共享的内容，使用全局变量globs.py。
2. 然后将处理全局变量的函数抽出来作为一个文件utils.py。
3. 其他文件调用utils.py文件，而utils.py只调用全局变量globs.py。这样就不会出现循环依赖的问题。