Python相互导入的问题解决

前言

大家好，这是随笔专栏的开篇之作。良好的开端是成功的一半，未来除了不定期分享实战中总结的小型项目外，还将持续分享开发过程中遇到的各类问题。今天讨论的是曾让我困扰许久的Python模块间相互导入问题。

问题与解决

问题描述

当两个文件相互导入时，通常会引发一系列错误，例如ImportError或NameError。本文将通过简单的代码示例复现这些问题，并逐步展示解决过程。

问题复现

在此，我们创建两个位于同一目录下的Python文件：mutualImportA和mutualImportB，并编写相应代码。

# mutualImportA.py  
  
from mutualImportB import b
  
a = 1  
  
  
def pA():  
    print(b)  
  
  
pA()

# mutualImportB.py  
  
from mutualImportA import a  
  
b = 1  
  
  
def pB():  
    print(a)  
  
  
pB()

创建完毕后，任意运行 A 或 B 都会报错：
ImportError: cannot import name 'b' from partially initialized module 'mutualImportB' (most likely due to a circular import)
当然有些人习惯于用 import 的导入而非 from import 的导入方式，这时候的报错就会变成：
AttributeError: partially initialized module 'mutualImportB' has no attribute 'b' (most likely due to a circular import)

上述两个报错相对友好。由于代码中明确指出了导入的内容，解释器能够识别出这是循环导入（most likely due to a circular import）。然而，有时出现的NameError才真正令人头疼。

我们调整代码，保留from import语句，但将import后的变量名改为通配符*。此时的报错信息如下： NameError: name 'b' is not defined

这显得颇为奇怪。在使用IDE时，IDE通常不会检出相互导入引发的循环导入问题。前两种情况在报错中即可看出，而这种情况从报错中很难发现b为何未声明。这类专为复现设计的小文件有助于理清思路、找到问题，但在大型项目中往往无从下手。

那么，出现这种情况的原因是什么？我们需要梳理整个程序的运行流程。

问题复现完毕，接下来探讨如何解决问题。

解决问题

此前，我在许多平台看到过相关文章，但绝大部分内容完全重复（尤其在CSDN上），明显是互相“转载”。遗憾的是，转载文章并不能真正解决问题。在这篇原创内容中，我将分享自己摸索出的经验。下面进入正题。

循环导入的根本原因是什么？为什么会发生循环导入？ 其实，我们可以联想到递归引发的栈溢出问题。

def a(b):
    return a(b)

这，是一个明显错误的函数。一旦我们调用了函数，函数内部就会不加判断地再次调用此函数。
而当我们加入了判断时：

def a(b):
	if b == 1:
		return 1
	else:
		return a(b - 1)

这样的话，该函数就转变为一个健康的函数了。

将同样的思路应用于相互导入。我们是否必须在文件初始化时就导入某个模块？通常并非如此。我们应当将导入语句放在它真正被需要的函数内部。例如，对问题复现中的a、b进行修改：

# mutualImportA.py  
  
a = 1  
  
  
def pA():  
	from mutualImportB import b
    print(b)  
  
  
pA()

# mutualImportB.py  
  
  
b = 1  
  
  
def pB():  
	from mutualImportA import a  
    print(a)  
  
  
pB()

这样的话，就没有上面的循环导入的问题了。这次再划分下流程：

OK，至此问题已解决。

当然，基于此问题也衍生出了一些代码规范建议： 在开发中，若文件较小，最好避免将需要相互使用的函数或类拆分到两个文件中。这样可以避免不少问题。

总结

顺便提一下，上一篇博客《利用深度优先搜索等算法实现围棋棋盘控制》中有一处笔误，应为GitHub而非Github，在此更正。

那么今天关于Python开发中遇到问题的分享就到此为止，再见！

到此这篇关于Python相互导入的问题解决的文章就介绍到这了，更多相关Python相互导入内容请搜索本站以前的文章或继续浏览下面的相关文章，希望大家以后多多支持本站！