本文首載于Gevin的博客
未經(jīng)Gevin授權(quán)糕非,禁止轉(zhuǎn)載
原文鏈接:如何避免Python的循環(huán)導(dǎo)入問題
Python 中使用package時澎办,出現(xiàn)循環(huán)導(dǎo)入問題十分常見馆里,我們創(chuàng)建如下package來說明這個問題:
pkg
├── __init__.py
├── module_a.py
└── module_b.py
其中羹应,
-
__init__.py
將pkg
指定為一個Python package -
module_a.py
中定義了一個action_a()
函數(shù)倚评,該函數(shù)引用了module_b.py
中的一個attribute,如一個函數(shù)或變量 -
module_b.py
中定義了一個action_b()
函數(shù)单鹿,該函數(shù)引用了module_a.py
中的一個attribute掀宋,如一個函數(shù)或變量
這種情況下,執(zhí)行該package時會拋出circular import error錯誤仲锄,即循環(huán)引用劲妙,因為module_a
試圖去引入module_b
時,而module_b
首先要引入module_a
儒喊,這會導(dǎo)致Python解釋器無法執(zhí)行下去镣奋。
然而,我們可以通過一些巧妙的方法怀愧,讓上面的邏輯正常工作唆途,同時避免循環(huán)引入的錯誤富雅。
那么,什么時候它能正常工作肛搬,什么時候不能正常工作,而那些能夠正常工作的情況又是什么原因呢毕贼?
何時它能正常工作温赔?
1. 在module頂部引入,不要用from
鬼癣,相對引入陶贼,只在Python 2中有效
在module的頂部import,如import another_module
待秃,module 中的函數(shù)以another_module.attribute
的方式引用another_module
中的函數(shù)或變量等拜秧。這種方式之所以有效,是由于import another_module
是基于當(dāng)前目錄的相對引用章郁,而且是一種隱式引用枉氮,如果從另一個package中引入module時,就可以失效了暖庄。另外聊替,import another_module
這種語法在Python 3 中已經(jīng)不支持了,所以不要在代碼中用這種方法來避免循環(huán)引入培廓。
如:
# 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 中的函數(shù)以package.another_module.attribute
的方式引用another_module
中的函數(shù)或變量等价匠。之所以要掛上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中的函數(shù)直接使用被引用的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. 函數(shù)頂部引入滤灯,可以用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都支持黍判,但編碼不夠優(yōu)雅,影響代碼可讀性篙梢,不建議使用