前言

Python 中使用package時(shí)，出現(xiàn)循環(huán)導(dǎo)入問(wèn)題十分常見(jiàn)，我們創(chuàng)建如下package來(lái)說(shuō)明這個(gè)問(wèn)題:

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

其中，

__init__.py 將pkg指定為一個(gè)Python package

module_a.py中定義了一個(gè)action_a()函數(shù)，該函數(shù)引用了module_b.py中的一個(gè)attribute，如一個(gè)函數(shù)或變量

module_b.py中定義了一個(gè)action_b()函數(shù)，該函數(shù)引用了module_a.py中的一個(gè)attribute，如一個(gè)函數(shù)或變量

這種情況下，執(zhí)行該package時(shí)會(huì)拋出circular import error錯(cuò)誤，即循環(huán)引用，因?yàn)閙odule_a試圖去引入module_b時(shí)，而module_b首先要引入module_a，這會(huì)導(dǎo)致Python解釋器無(wú)法執(zhí)行下去。

然而，我們可以通過(guò)一些巧妙的方法，讓上面的邏輯正常工作，同時(shí)避免循環(huán)引入的錯(cuò)誤。

那么，什么時(shí)候它能正常工作，什么時(shí)候不能正常工作，而那些能夠正常工作的情況又是什么原因呢？

何時(shí)它能正常工作？

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

在module的頂部import，如import another_module，module 中的函數(shù)以another_module.attribute的方式引用another_module中的函數(shù)或變量等。這種方式之所以有效，是由于import another_module是基于當(dāng)前目錄的相對(duì)引用，而且是一種隱式引用，如果從另一個(gè)package中引入module時(shí)，就可以失效了。另外，import another_module這種語(yǔ)法在Python3 中已經(jīng)不支持了，所以不要在代碼中用這種方法來(lái)避免循環(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，絕對(duì)引入

在module的頂部import，使用從package開(kāi)始的絕對(duì)路徑，如import package.another_module，module 中的函數(shù)以package.another_module.attribute的方式引用another_module中的函數(shù)或變量等。之所以要掛上package name來(lái)引入，是由于import .another_module這種形式的“相對(duì)引入”會(huì)報(bào)語(yǔ)法錯(cuò)誤，而掛上package的絕對(duì)引入，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，相對(duì)引入也支持，如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，也支持相對(duì)引入，引入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)雅，影響代碼可讀性，不建議使用

注

本文討論的問(wèn)題，是Python中調(diào)用package時(shí)，應(yīng)如何避免循環(huán)引入

當(dāng)直接在命令行執(zhí)行一個(gè)Python module時(shí)，適用情況不完全相同

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

最新評(píng)論