前言

Hi! 這是隨筆專(zhuān)欄的第一篇文章。好的開(kāi)始等于成功了一半。在之后的日子里，除了不定期分享實(shí)戰(zhàn)中可總結(jié)出的小項(xiàng)目外，還會(huì)經(jīng)常與大分享開(kāi)發(fā)時(shí)遇到的問(wèn)題。今天，是一個(gè)曾困擾了我許久的關(guān)于 Python 兩個(gè)文件間互相 import 的問(wèn)題。

問(wèn)題→解決

問(wèn)題描述

兩個(gè)文件間相互導(dǎo)入時(shí)產(chǎn)生了一系列錯(cuò)誤，比如 ImportError, NameError 等等。這次，我用簡(jiǎn)單的代碼示例復(fù)現(xiàn)一下這些問(wèn)題，并一步一步解決。

問(wèn)題復(fù)現(xiàn)

這里，我創(chuàng)建兩個(gè)同目錄下的 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()

創(chuàng)建完畢后，任意運(yùn)行 A 或 B 都會(huì)報(bào)錯(cuò)：
ImportError: cannot import name 'b' from partially initialized module 'mutualImportB' (most likely due to a circular import)
當(dāng)然有些人習(xí)慣于用 import 的導(dǎo)入而非 from import 的導(dǎo)入方式，這時(shí)候的報(bào)錯(cuò)就會(huì)變成：
AttributeError: partially initialized module 'mutualImportB' has no attribute 'b' (most likely due to a circular import)

好的，這兩個(gè)報(bào)錯(cuò)還算友好。這種導(dǎo)入的方式都在程序出指明了導(dǎo)入的內(nèi)容，所以解釋器可以發(fā)現(xiàn)這里是循環(huán)導(dǎo)入（most likely due to a circular import）。但有時(shí)出現(xiàn)的 NameError 才真正讓人頭疼。

我們將代碼改一下，保留 from import 語(yǔ)句，但將其 import 后面的變量名改為通配符 * 。這次的報(bào)錯(cuò)：
NameError: name 'b' is not defined

這就很奇怪了。我們?cè)谑褂?IDE 時(shí)， IDE 不會(huì)檢出相互導(dǎo)入時(shí)引發(fā)的循環(huán)導(dǎo)入問(wèn)題。不過(guò)前兩種在報(bào)錯(cuò)中即可看出，而這時(shí)，從報(bào)錯(cuò)中很難發(fā)現(xiàn)為何 b 沒(méi)有聲明。這種專(zhuān)為復(fù)現(xiàn)而出現(xiàn)的小文件中問(wèn)題可以捋清思路、找到問(wèn)題，在較大的項(xiàng)目中就往往無(wú)從下手了。

那么為什么會(huì)出現(xiàn)這樣的情況呢？我們想一下整個(gè)程序的運(yùn)行流程。

問(wèn)題復(fù)現(xiàn)完畢，下面探討如何解決問(wèn)題。

解決問(wèn)題

此前，我曾在許多平臺(tái)看到過(guò)文章，但其中絕大部分都是完全重復(fù)的（尤其在 CSDN 上），明顯互相“轉(zhuǎn)載”來(lái)“轉(zhuǎn)載”去?？上?，轉(zhuǎn)載的文章并不能真正解決問(wèn)題。在這篇原創(chuàng)的文章中，我將自己摸索的經(jīng)驗(yàn)分享了出來(lái)。下面轉(zhuǎn)入正題。

循環(huán)導(dǎo)入的根本原因是什么？為什么會(huì)循環(huán)導(dǎo)入？
其實(shí)由循環(huán)導(dǎo)入，我們可以想到遞歸而引發(fā)的棧溢出。

def a(b):
    return a(b)

這，是一個(gè)明顯錯(cuò)誤的函數(shù)。一旦我們調(diào)用了函數(shù)，函數(shù)內(nèi)部就會(huì)不加判斷地再次調(diào)用此函數(shù)。
而當(dāng)我們加入了判斷時(shí)：

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

這樣的話(huà)，該函數(shù)就轉(zhuǎn)變?yōu)橐粋€(gè)健康的函數(shù)了。

將同樣的思路運(yùn)用到相互導(dǎo)入的方式上。我們必須在整個(gè)文件初就要導(dǎo)入某個(gè)模塊嗎？一般來(lái)說(shuō)不是的。我們應(yīng)當(dāng)將導(dǎo)入放在它真正被需要的函數(shù)里。比如，問(wèn)題復(fù)現(xiàn)中的 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()

這樣的話(huà)，就沒(méi)有上面的循環(huán)導(dǎo)入的問(wèn)題了。這次再劃分下流程：

OK，那么問(wèn)題到此為止就解決完畢了。

當(dāng)然，據(jù)此問(wèn)題也衍生出了一些代碼的規(guī)范問(wèn)題：
開(kāi)發(fā)中，若文件較小，還是最好不要將需要相互使用的兩個(gè)函數(shù)或類(lèi)分到兩個(gè)文件中。這樣，可以避免不少的問(wèn)題。

總結(jié)

說(shuō)個(gè)事情，上一篇博客《利用深度優(yōu)先搜索等算法實(shí)現(xiàn)圍棋棋盤(pán)控制》有一處打錯(cuò)，應(yīng)是 GitHub 而非 Github ，在此更正一下~

那么今天關(guān)于 Python 開(kāi)發(fā)時(shí)遇到的問(wèn)題的分享就到此為止了，再見(jiàn)！

到此這篇關(guān)于Python相互導(dǎo)入的問(wèn)題解決的文章就介紹到這了,更多相關(guān)Python相互導(dǎo)入內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論