python解決循環(huán)依賴(lài)

1.概述

在使用python開(kāi)發(fā)過(guò)程中在引入其他模塊時(shí)可能都經(jīng)歷過(guò)一個(gè)異常就是循環(huán)引用most likely due to a circular import，它的意思就是A引用了B，反過(guò)來(lái)B又引用了A，導(dǎo)致出現(xiàn)了循環(huán)引用異常。下面來(lái)介紹如何避免循環(huán)引用異常。

2.循環(huán)引用介紹

2.1.python引入模塊原理

下面通過(guò)一個(gè)循環(huán)引用示例，來(lái)介紹python引入模塊的原理。示例中創(chuàng)建了三個(gè)模塊，它的引用關(guān)系如下

• dialog.py模塊引入了app模塊的prefs類(lèi)的get方法
• app模塊引入了dialog模塊的show方法

創(chuàng)建一個(gè)python文件，命名為dialog.py

import app

class Dialog:
    def __init__(self, save_dir):
        self.save_dir = save_dir

save_dialog = Dialog(app.prefs.get('save_dir'))

def show():
    print('Showing the dialog!')

創(chuàng)建一個(gè)python文件，命名為app.py

import dialog

class Prefs:
    def get(self, name):
        pass

prefs = Prefs()
dialog.show()

創(chuàng)建一個(gè)python文件，命名為main.py

import app

運(yùn)行上面循環(huán)引用代碼，拋出了異常

AttributeError: partially initialized module 'app' has no attribute 'prefs' (most likely due to a circular import)

要明白上面為什么會(huì)拋出循環(huán)引用異常，首先要明白python是如何引入模塊的。在引入模塊的時(shí)候，python系統(tǒng)會(huì)按照深度優(yōu)先的順序，對(duì)模塊執(zhí)行以下五步：

• 1.在sys.path里尋找模塊的位置
• 2.把模塊的代碼加載進(jìn)來(lái)，并確認(rèn)這些代碼能編譯
• 3.創(chuàng)建響應(yīng)的空白模塊對(duì)象表示該模塊
• 4.把這個(gè)模塊插入sys.modules字典
• 5.運(yùn)行模塊對(duì)象之中的代碼定義該模塊的內(nèi)容

循環(huán)依賴(lài)之所以會(huì)出錯(cuò)，原因在于，執(zhí)行完第4步驟之后，這個(gè)模塊已經(jīng)位于sys.modules之中了，然而它的內(nèi)容還沒(méi)有得到定義，要等到執(zhí)行完第5步驟，才能齊備。

可是python在執(zhí)行import語(yǔ)句的時(shí)候，如果發(fā)現(xiàn)要引用的模塊已經(jīng)出現(xiàn)在了sys.modules之中，(也就是執(zhí)行完第4個(gè)步驟)，那么就會(huì)繼續(xù)執(zhí)行importd 下一條語(yǔ)句，而不會(huì)顧及模塊之中的內(nèi)容是否的得到了定義。

例如上面的例子，app模塊在執(zhí)行自己第5步驟時(shí)，首先遇到的就是引入dialog模塊的這條語(yǔ)句，而此刻他還沒(méi)有把自己的內(nèi)容定義出來(lái)，他只不過(guò)執(zhí)行完了前4步驟，讓自己出現(xiàn)在了sys.dodules字典里面而已。
等到dialog模塊反過(guò)來(lái)要引入app的時(shí)候，由于app模塊已經(jīng)出現(xiàn)在了sys.modules字典中，python就會(huì)認(rèn)為這個(gè)模塊已近引入，于是繼續(xù)執(zhí)行dialog模塊其他代碼，而不會(huì)考慮app里面的內(nèi)容到底有沒(méi)有定義。
這樣的話(huà)，執(zhí)行到save_dialog = Dialog(app.prefs.get('save_dir')) 這一句的時(shí)候，就會(huì)因?yàn)閍pp里面找不到prefs屬性而出錯(cuò)。(這個(gè)屬性必須等app執(zhí)行完第5步驟才能夠得到定義)

3.解決循環(huán)引用方法

如果要解決上面的循環(huán)引用異常，有四種解決辦法。

3.1.重構(gòu)引入關(guān)系

例如把prefs內(nèi)容提取到一個(gè)單獨(dú)的工具模塊中，把它放在依賴(lài)體系最底層，這樣app與dialog分別引入這個(gè)模塊。他們的關(guān)系如下

• app 引入 prefs
• dialog 引入 prefs

有時(shí)候這種重構(gòu)引入關(guān)系需要拆分代碼，對(duì)于大型的項(xiàng)目可能不太好拆分，還可以通過(guò)其他的方式解決

3.2.調(diào)整import語(yǔ)句

調(diào)整import位置，例如我們可以讓app模塊不要那么早就引入dialog模塊，而是等到prefs等其他內(nèi)容都創(chuàng)建出來(lái)之后，在引入dailog，這樣的話(huà)，等待dialog返回來(lái)使用app中的屬性時(shí)，就不會(huì)因?yàn)樵搶傩赃€沒(méi)有定義出來(lái)而發(fā)生AttributeError

class Prefs:
    def get(self, name):
        pass

prefs = Prefs()

import dialog  # Moved
dialog.show()

這種寫(xiě)法雖然可行，但是它違背了PEP8規(guī)范，依照建議，所有的import語(yǔ)句都應(yīng)該出現(xiàn)在文件開(kāi)頭。這種方式有個(gè)弊端，在執(zhí)行了一半，才發(fā)現(xiàn)自己要使用的那個(gè)模塊還沒(méi)有加載進(jìn)來(lái)，因此不建議使用這種方法。

3.3.把模塊分成引入-配置-運(yùn)行三個(gè)環(huán)節(jié)

循環(huán)引入可以通過(guò)勁量縮減引用時(shí)所要執(zhí)行的操作。我們可以讓模塊只把函數(shù)、類(lèi)、與常量定義出來(lái)，而不真正去執(zhí)行，這樣python在引入本模塊的時(shí)候，就不會(huì)由于操作其他模塊而出錯(cuò)了。
我們可以把本模塊里，需要用到其他模塊的那種操作放在configure函數(shù)中，等到模塊徹底引入完畢后，再去調(diào)用。

dialog.py模塊把調(diào)用的操作放在configure函數(shù)中

import app

class Dialog:
    def __init__(self):
        pass

save_dialog = Dialog()

def show():
    print('Showing the dialog!')

def configure():
    save_dialog.save_dir = app.prefs.get('save_dir')

app.py模塊把調(diào)用的操作放在configure函數(shù)中

import dialog

class Prefs:
    def get(self, name):
        pass

prefs = Prefs()

def configure():
    pass

main.py模塊按照引入-配置-運(yùn)行的順序先把那兩個(gè)模塊引入進(jìn)來(lái)，然后調(diào)用各自的configure函數(shù)，最后運(yùn)行dialog模塊的show函數(shù)

import app
import dialog

app.configure()
dialog.configure()

dialog.show()

這種寫(xiě)法能適應(yīng)許多種情況，而且便于我們運(yùn)用依賴(lài)注入模式來(lái)替換受依賴(lài)模塊之中的內(nèi)容。
但是有時(shí)候不太容易從代碼中抽離出這樣一個(gè)configure配置環(huán)節(jié)，因?yàn)樗言撃K定義的對(duì)象與這些對(duì)象的配置邏輯分別寫(xiě)到了兩個(gè)環(huán)節(jié)里面。

3.4.動(dòng)態(tài)引入

動(dòng)態(tài)引入比前幾個(gè)方法要簡(jiǎn)單，也就是把import語(yǔ)句從模塊級(jí)別下移到函數(shù)或方法里面，這樣就解決了循環(huán)依賴(lài)關(guān)系了。
這種import并不會(huì)在程序啟動(dòng)并初始化本模塊時(shí)執(zhí)行，而是等到相關(guān)函數(shù)真正運(yùn)行的時(shí)候才得以觸發(fā)，因此又叫做動(dòng)態(tài)引入

下面我們用動(dòng)態(tài)引入辦法修改dialog模塊，他只會(huì)在dialog.show函數(shù)真正運(yùn)行的時(shí)候去引入import模塊，而不像原來(lái)那樣，模塊剛初始化，就要引入app

class Dialog:
    def __init__(self):
        pass

# Using this instead will break things
# save_dialog = Dialog(app.prefs.get('save_dir'))
save_dialog = Dialog()

def show():
    import app  # Dynamic import
    save_dialog.save_dir = app.prefs.get('save_dir')
    print('Showing the dialog!')

app模塊修改

import dialog

class Prefs:
    def get(self, name):
        pass

prefs = Prefs()
dialog.show()

main模塊

import 

這樣寫(xiě)，實(shí)際上與剛才那種先引入，再配置，然后運(yùn)行的辦法是類(lèi)似的。區(qū)別僅僅在于，這次不調(diào)整代碼的結(jié)構(gòu)，也不修改模塊的定義與引入方式，只是把形成循環(huán)依賴(lài)的那條import語(yǔ)句推遲到真正需要使用另外一個(gè)模塊的那一刻。

一般來(lái)說(shuō)還是勁量避免動(dòng)態(tài)引入，因?yàn)閕mport語(yǔ)句畢竟是有開(kāi)銷(xiāo)的，如果它出現(xiàn)在需要頻繁執(zhí)行的循環(huán)體里面，那么這種開(kāi)銷(xiāo)會(huì)更大。另外，由于動(dòng)態(tài)引入會(huì)推遲代碼的執(zhí)行時(shí)機(jī)，有可能你代碼啟動(dòng)很久之后，如果因?yàn)閯?dòng)態(tài)引入其他模塊發(fā)生異常而奔潰。

到此這篇關(guān)于python解決循環(huán)依賴(lài)的文章就介紹到這了,更多相關(guān)python循環(huán)依賴(lài)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論