你在Python中遇到過(guò)循環(huán)導(dǎo)入嗎？嗯，這是一種非常常見(jiàn)的代碼味道，表明設(shè)計(jì)或結(jié)構(gòu)有問(wèn)題。

循環(huán)導(dǎo)入示例

循環(huán)導(dǎo)入是如何發(fā)生的？當(dāng)兩個(gè)或多個(gè)相互依賴的模塊在完全初始化之前嘗試導(dǎo)入時(shí)，通常會(huì)發(fā)生此導(dǎo)入錯(cuò)誤。

假設(shè)我們有兩個(gè)模塊：module_1.py 和 module_2.py。

# module_1.py
from module_2 import ModY
class ModX:
    mody_obj = ModY()

# module_2.py
from module_1 import ModX
class ModY:
    modx_obj = ModX()

在上面的代碼片段中，module_1和module_2都是相互依賴的。

module_1 中 mody_obj 的初始化依賴于 module_2，module_2 中 modx_obj 的初始化依賴于 module_1。

這就是我們所說(shuō)的循環(huán)依賴。兩個(gè)模塊在嘗試互相加載時(shí)都會(huì)陷入導(dǎo)入循環(huán)。

如果我們運(yùn)行 module_1.py，我們將得到以下回溯。

Traceback (most recent call last):
  File "module_1.py", line 1, in <module>
    from module_2 import ModY
  File "module_2.py", line 1, in <module>
    from module_1 import ModX
  File "module_1.py", line 1, in <module>
    from module_2 import ModY
ImportError: cannot import name 'ModY' from partially initialized module 'module_2' (most likely due to a circular import)

這個(gè)錯(cuò)誤說(shuō)明了循環(huán)導(dǎo)入的情況。當(dāng)程序嘗試從 module_2 導(dǎo)入 ModY 時(shí)，當(dāng)時(shí) module_2 尚未完全初始化（由于另一個(gè)導(dǎo)入語(yǔ)句嘗試從 module_1 導(dǎo)入 ModX）。

如何修復(fù) Python 中的循環(huán)導(dǎo)入？ ??有多種方法可以消除 Python 中的循環(huán)導(dǎo)入。

修復(fù) Python 中的循環(huán)導(dǎo)入

將代碼移至公共文件中

我們可以將代碼移動(dòng)到一個(gè)公共文件中以避免導(dǎo)入錯(cuò)誤，然后嘗試從該文件導(dǎo)入模塊。

# main.py ----> common file
class ModX:
    pass

class ModY:
    pass

在上面的代碼片段中，我們將類 ModX 和 ModY 移動(dòng)到一個(gè)公共文件 (main.py) 中。

# module_1.py
from main import ModY

class Mod_X:
    mody_obj = ModY()

# module_2.py
from main import ModX

class Mod_Y:
    modx_obj = ModX()

現(xiàn)在，module_1 和 module_2 從 main 導(dǎo)入類，修復(fù)了循環(huán)導(dǎo)入的情況。

這種方法有一個(gè)問(wèn)題，有時(shí)代碼庫(kù)太大，將代碼移動(dòng)到另一個(gè)文件中會(huì)存在風(fēng)險(xiǎn)。

將導(dǎo)入移至模塊末尾

我們可以將導(dǎo)入語(yǔ)句移到模塊末尾。這將為導(dǎo)入另一個(gè)模塊之前留出時(shí)間來(lái)完全初始化模塊。

# module_1.py
class ModX:
   pass

from module_2 import ModY

class Mod_X:
   mody_obj = ModY()

# module_2.py
class ModY:
   pass

from module_1 import ModX

在類/函數(shù)范圍內(nèi)導(dǎo)入模塊

在類或函數(shù)作用域內(nèi)導(dǎo)入模塊可以避免循環(huán)導(dǎo)入。這允許僅在調(diào)用類或函數(shù)時(shí)導(dǎo)入模塊。當(dāng)我們想要最小化內(nèi)存使用時(shí)，它是相關(guān)的。

# module_1.py
class ModX:
  pass

class Mod_X:
   from module_2 import ModY
   mody_obj = ModY()

# module_2.py
class ModY:
   pass

class Mod_Y:
   from module_1 import ModX
   modx_obj = ModX()

我們分別將 import 語(yǔ)句移至 module_1 和 module_2 中的類 Mod_X 和 Mod_Y 范圍內(nèi)。

如果我們運(yùn)行 module_1 或 module_2，我們不會(huì)收到循環(huán)導(dǎo)入錯(cuò)誤。但是，這種方法使得類只能在類的范圍內(nèi)訪問(wèn)，因此我們無(wú)法全局利用導(dǎo)入。

使用模塊名稱/別名

使用模塊名稱或僅像這樣的別名可以解決問(wèn)題。這允許兩個(gè)模塊通過(guò)將循環(huán)依賴推遲到運(yùn)行時(shí)來(lái)完全加載。

# module_1.py
from module_2 import ModY
class ModX:
    mody_obj = ModY()

# module_2.py
from module_1 import ModX
class ModY:
    modx_obj = ModX()

使用 importlib 庫(kù)

我們還可以使用 importlib 庫(kù)動(dòng)態(tài)導(dǎo)入模塊。

Traceback (most recent call last):
  File "module_1.py", line 1, in <module>
    from module_2 import ModY
  File "module_2.py", line 1, in <module>
    from module_1 import ModX
  File "module_1.py", line 1, in <module>
    from module_2 import ModY
ImportError: cannot import name 'ModY' from partially initialized module 'module_2' (most likely due to a circular import)

# main.py ----> common file
class ModX:
    pass

class ModY:
    pass

Python 包中的循環(huán)導(dǎo)入

通常，循環(huán)導(dǎo)入 來(lái)自同一包內(nèi)的模塊。在復(fù)雜的項(xiàng)目中，目錄結(jié)構(gòu)也很復(fù)雜，包內(nèi)包。

這些包和子包包含 __init__.py 文件，以提供更輕松的模塊訪問(wèn)。這就是有時(shí)無(wú)意中在模塊之間產(chǎn)生循環(huán)依賴的地方。

我們有以下目錄結(jié)構(gòu)。

# module_1.py
from main import ModY

class Mod_X:
    mody_obj = ModY()

我們有一個(gè) mainpkg 包和一個(gè) main.py 文件。我們?cè)?mainpkg 中有兩個(gè)子包 modpkg_x 和 modpkg_y。

這是 modpkg_x 和 modpkg_y 中每個(gè) Python 文件的樣子。

mainpkg/modpkg_x/__init__.py

# module_2.py
from main import ModX

class Mod_Y:
    modx_obj = ModX()

此文件從 module_1 和 module_1_1 導(dǎo)入兩個(gè)類（ModX 和 ModA）。

mainpkg/modpkg_x/module_1.py

# module_1.py
class ModX:
   pass

from module_2 import ModY

class Mod_X:
   mody_obj = ModY()

module_1 從 module_2 導(dǎo)入 ModY 類。

mainpkg/modpkg_x/module_1_1.py

# module_2.py
class ModY:
   pass

from module_1 import ModX

module_1_1 沒(méi)有導(dǎo)入任何內(nèi)容。它不依賴于任何模塊。

mainpkg/modpkg_y/__init__.py

# module_1.py
class ModX:
  pass

class Mod_X:
   from module_2 import ModY
   mody_obj = ModY()

此文件從 module_2 導(dǎo)入 ModY 類。

mainpkg/modpkg_y/module_2.py

# module_2.py
class ModY:
   pass

class Mod_Y:
   from module_1 import ModX
   modx_obj = ModX()

module_2 從 module_1_1 導(dǎo)入 ModA 類。

我們?cè)?main.py 文件中有以下代碼。

root_dir/main.py

# module_1.py
import module_2 as m2

class ModX:
    def __init__(self):
        self.mody_obj = m2.ModY()

主文件從 module_2 導(dǎo)入 ModY 類。該文件依賴于 module_2。

如果我們?cè)谶@里可視化導(dǎo)入周期，它看起來(lái)像下面忽略 modpkg_x 和 modpkg_y 中的 __init__.py 文件。

我們可以看到主文件依賴于module_2，module_1也依賴于module_2，module_2又依賴于module_1_1。沒(méi)有導(dǎo)入周期。

但是你知道，模塊依賴于它們的 __init__.py 文件，因此 __init__.py 文件首先初始化，然后重新導(dǎo)入模塊。

這就是現(xiàn)在的導(dǎo)入周期。

這使得 module_1_1 依賴于 module_1，這是一個(gè)假依賴項(xiàng)。

如果是這種情況，清空子包 __init__.py 文件并使用單獨(dú)的 __init__.py 文件可以幫助在包級(jí)別集中導(dǎo)入。

# module_1.py
from module_2 import ModY
class ModX:
    mody_obj = ModY()

在此結(jié)構(gòu)中，我們?cè)?mainpkg 中添加了另一個(gè)子包 subpkg。

mainpkg/subpkg/__init__.py

# module_2.py
from module_1 import ModX
class ModY:
    modx_obj = ModX()

這將允許內(nèi)部模塊從單一來(lái)源導(dǎo)入，從而減少交叉導(dǎo)入的需要。

現(xiàn)在我們可以更新 main.py 文件中的導(dǎo)入語(yǔ)句。

root_dir/main.py

Traceback (most recent call last):
  File "module_1.py", line 1, in <module>
    from module_2 import ModY
  File "module_2.py", line 1, in <module>
    from module_1 import ModX
  File "module_1.py", line 1, in <module>
    from module_2 import ModY
ImportError: cannot import name 'ModY' from partially initialized module 'module_2' (most likely due to a circular import)

這解決了同一包內(nèi)模塊之間的循環(huán)依賴問(wèn)題。

結(jié)論

Python 中的循環(huán)依賴或?qū)胧且环N代碼異味，這表明需要對(duì)代碼進(jìn)行認(rèn)真的重構(gòu)和重構(gòu)。

您可以嘗試上述任何一種方法來(lái)避免 Python 中的循環(huán)依賴。

---

？如果您喜歡這篇文章，您可能還會(huì)感興趣

?Flask 中的模板繼承示例。

?exec() 和 eval() 之間的區(qū)別并舉例。

?了解Python中g(shù)lobal關(guān)鍵字的使用。

?Python 類型提示：函數(shù)、返回值、變量。

?為什么在函數(shù)定義中使用斜線和星號(hào)。

?學(xué)習(xí)率如何影響 ML 和 DL 模型？

---

現(xiàn)在就這些。

繼續(xù)編碼??。

以上是在 Python 中修復(fù)循環(huán)導(dǎo)入的不同方法的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！