如何避免Python的循環導入問題

本文首載於Gevin的博客
未經Gevin受權，禁止轉載
原文連接：如何避免Python的循環導入問題

how to avoid python circle import error

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這種語法在Python 3 中已經不支持了，因此不要在代碼中用這種方法來避免循環引入。

如：

# 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時，適用狀況不徹底相同
• 本文內容我在GitHub上提供了一個Demo，歡迎查看或fork
• Reference：This Gist