Python相互導入的問題解決

Posted on by

前言

Hi! 這是隨筆專欄的第一篇文章。好的開始等於成功瞭一半。在之後的日子裡，除瞭不定期分享實戰中可總結出的小項目外，還會經常與大分享開發時遇到的問題。今天，是一個曾困擾瞭我許久的關於 Python 兩個文件間互相 import 的問題。

問題→解決

問題描述

兩個文件間相互導入時產生瞭一系列錯誤，比如 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相互導入內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：