關於Python如何避免循環導入方法介紹

在大型的Python工程中，由於架構設計不當，可能會出現模組間相互引用的情況。以下這篇文章主要為大家介紹瞭如何避免Python的循環導入問題的相關資料，需要的朋友可以參考借鑒，下面來一起看看吧。

前言

Python 中使用package時，出現循環導入問題十分常見，我們建立如下package來說明這個問題:

pkg
 ├── __init__.py
 ├── module_a.py
 └── module_b.py

其中，

__init__.py 將pkg指定為一個Python package

module_a.py中定義了一個action_a()函數，函數引用了module_b.py中的一個attribute，如一個函數或變數

module_b.py中定義了一個action_b() 函數，函數引用了module_a.py中的一個attribute，如一個函數或變數

這種情況下，執行該package時會拋出circular import error錯誤，即循環引用，因為module_a試圖去引入module_b時，而module_b首先要引入module_a，這會導致Python解釋器無法執行。

然而，我們可以透過一些巧妙的方法，讓上面的邏輯正常運作，同時避免循環引入的錯誤。

那麼，什麼時候它能正常運作，什麼時候不能正常運作，而那些能夠正常運作的情況又是什麼原因呢？

何時它能正常運作？

 1. 在module頂部引入，不要用from，相對引入，只在Python 2中有效

在module的頂部import，如import another_module，module 中的函數以another_module.attribute的方式引用another_module中的函數或變數等。這種方式之所以有效，是由於import another_module是基於當前目錄的相對引用，而且是一種隱式引用，如果從另一個package中引入module時，就可以失效了。另外，import another_module這種語法在Python3 中已經不支援了，所以不要在程式碼中用這個方法來避免循環引入。

如：

# pkg/module_a.py 
from __future__ import print_function
import module_b
 
def action_a():
 print(module_b.action_b.__name__)
 
 
# pkg/module_b.py
from __future__ import print_function
import module_a
 
def action_b():
 print(module_a.action_a.__name__)

#2. 在module的頂端引入，不要用from，絕對要引入

在module的頂部import，使用從package開始的絕對路徑，如import package.another_module，module 中的函數以package.another_module.attribute的方式引用another_module中的函數或變數等。之所以要掛上package name來引入，是由於import .another_module這種形式的「相對引入」會報語法錯誤，而掛上package的絕對引入，Python 2和3都支援

案例：

# pkg/module_a.py
from __future__ import print_function
import pkg2.module_b
 
def action_a():
 print(pkg2.module_b.action_b.__name__)
 
 
# pkg/module_b.py
from __future__ import print_function
import pkg2.module_a
 
def action_b():
 print(pkg2.module_a.action_a.__name__)

3. 在module底部引入another module的attribute，而非another module，用from

在module的底部import（至少在被引用的attribute之後import），直接引入another module的attribute，如from package.another_module import attribute，相對引入也支持，如from .another_module import attribute，module中的函數直接使用被引用的attribute即可。

如：

# pkg/module_a.py
from __future__ import print_function
 
def action_a():
 print(action_b.__name__)
 
from .module_b import action_b
 
 
# pkg/module_b.py
from __future__ import print_function
 
def action_b():
 print(action_a.__name__)
 
from .module_a import action_a

#4. 函數頂端引入，可以用from

在module的function頂部import，如from package import another_module，也支援相對引入，引入module或attribute均可。

如：

# pkg/module_a.py
from __future__ import print_function
 
def action_a():
 from . import module_b
 print(module_b.action_b.__name__)
 
 
# pkg/module_b.py
from __future__ import print_function
 
def action_b():
 from . import module_a
 print(module_a.action_a.__name__)

或

# pkg/module_a.py
from __future__ import print_function
 
def action_a():
 from .module_b import action_b
 print(action_b.__name__)
 
 
# pkg/module_b.py
from __future__ import print_function
def action_b():
 from .module_a import action_a
 print(action_a.__name__)

這種方式雖然Python 2和3都支持，但編碼不夠優雅，影響代碼可讀性，不建議使用

#本文討論的問題，是Python中呼叫package時，應如何避免循環引入

當直接在命令列執行一個Python module時，適用情況不完全相同

以上是關於Python如何避免循環導入方法介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！