淺析Python模塊之間的相互引用問題
摘要:詳細(xì)講解了相對(duì)路徑和絕對(duì)路徑的引用方法。
在某次運(yùn)行過程中出現(xiàn)了如下兩個(gè)報(bào)錯(cuò):
報(bào)錯(cuò)1: ModuleNotFoundError: No module named '__main__.src_test1'; '__main__' is not a package
報(bào)錯(cuò)2: ImportError: attempted relative import with no known parent package
于是基于這兩個(gè)報(bào)錯(cuò)探究了一下python3中的模塊相互引用的問題,下面來逐個(gè)解析,請(qǐng)耐心看完。
好的,我們先來構(gòu)造第一個(gè)錯(cuò),測(cè)試代碼結(jié)構(gòu)如下:
|--- test_main.py |--- src |--- __init__.py |--- src_test1.py |--- src_test2.py
src_test2.py 代碼
class Test2(object):
def foo(self):
print('I am foo')
src_test1.py 代碼,引用Test2模塊
from .src_test2 import Test2 def fun1(): t2 = Test2() t2.foo() if __name__ == "__main__": fun1()
此時(shí)運(yùn)行 src_test1.py 報(bào)錯(cuò)“No module named '__main__.src_test1'; '__main__' is not a package”
問題原因:
主要在于引用src_test2模塊的時(shí)候,用的是相對(duì)路徑".",在import語法中翻譯成"./",也就是當(dāng)前目錄下,按這樣理解也沒有問題,那為什么報(bào)錯(cuò)呢?
從 PEP 328 中,我們找到了關(guān)于 the relative imports(相對(duì)引用)的介紹

通俗一點(diǎn)意思就是,你程序入口運(yùn)行的那個(gè)模塊,就默認(rèn)為主模塊,他的name就是‘main',然后會(huì)將本模塊import中的點(diǎn)(.)替換成‘__main__',那么 .src_test2就變成了 __main__.src_test2,所以當(dāng)然找不到這個(gè)模塊了。
解決方法:
因此,建議的做法是在 src同層級(jí)目錄創(chuàng)建 引用模塊 test_main.py(為什么不在src目錄下創(chuàng)建,待會(huì)下一個(gè)報(bào)錯(cuò)再講),并引用src_test1模塊,代碼如下:
from src.src_test1 import fun1 if __name__ == "__main__": fun1()
那為什么這樣執(zhí)行就可以了呢,其中原理是什么呢?我是這樣理解的(歡迎糾正):test_main執(zhí)行時(shí),他被當(dāng)做根目錄,因此他引用的src.src_test1 是絕對(duì)路徑,這樣引用到哪都不會(huì)錯(cuò),此時(shí)他的name=‘main',當(dāng)執(zhí)行src_test1的時(shí)候,注意了此時(shí)test1的name是 src.src_test1,那么在test1中使用的是相對(duì)路徑,查找邏輯是先找到父節(jié)點(diǎn)(src目錄),再找父節(jié)點(diǎn)下面的src_test2,因此可以成功找到,Bingo!
輔證:
構(gòu)造一個(gè)例子,就可以理解上面的 執(zhí)行目錄就是根目錄 的說法了,修改test1,使引用test_main:
from .. import test_main 報(bào)錯(cuò):ValueError: attempted relative import beyond top-level package
OK,那繼續(xù)構(gòu)造第二個(gè)報(bào)錯(cuò):
上文中說過,解決main 的問題,就是創(chuàng)建一個(gè)模塊,來調(diào)用使用相對(duì)路徑的模塊,那么為什么我不能在相同目錄下創(chuàng)建這個(gè)文件來調(diào)用呢?讓我們來測(cè)試下代碼:
創(chuàng)建test_src.py文件,代碼結(jié)構(gòu)變更如下:
|--- test_main.py |--- src |--- __init__.py |--- src_test1.py |--- src_test2.pys |--- test_src.py
test_src 代碼:
from src_test1 import fun1 if __name__ == "__main__": fun1()
執(zhí)行報(bào)錯(cuò):ImportError: attempted relative import with no known parent package
問題原因:
當(dāng)執(zhí)行test_src時(shí),按上文理解,此時(shí)執(zhí)行文件所在的目錄為根目錄,那么引用test1的時(shí)候,需要注意的是,此時(shí)test1的name屬性不再是src.src_test1,因?yàn)槌绦蚋兄坏絪rc的存在,此時(shí)他的絕對(duì)路徑是 src_test1,此時(shí)再次引用相對(duì)路徑查找的test2,同樣的步驟,需要先找到父節(jié)點(diǎn),而此時(shí)他自己就是根節(jié)點(diǎn)了,已經(jīng)沒有父節(jié)點(diǎn)了,因此報(bào)錯(cuò)“no known parent package”。
解決方法:
此時(shí)為了避免父節(jié)點(diǎn)產(chǎn)生矛盾,因此將test1中的引入去掉相對(duì)引用即可
from .src_test2 import Test2 --> from src_test2 import Test2
繼續(xù)深入:
那使用相對(duì)路徑和絕對(duì)路徑,編譯器是怎么找到這個(gè)模塊的呢?
執(zhí)行import的時(shí)候,存在一個(gè)引入的順序,即優(yōu)先查找執(zhí)行目錄下有沒有此文件,如沒有,再查找lib庫下,如還沒有,再查找sys.path中的路徑,如再?zèng)]有,報(bào)錯(cuò)。
所以不管是當(dāng)前目錄,還是 sys.path中的目錄,都可以查到 src_test2這個(gè)模塊,就可以編譯成功。
號(hào)外:
解決完上述問題后,不管我們用哪種方式,我們調(diào)試代碼時(shí),都是單個(gè)文件調(diào)試,但此時(shí)根目錄就不對(duì)了,import方式又要改動(dòng),執(zhí)行起來很麻煩,所以這里推薦另一種方式(有更好的方式歡迎留言),使用sys.path.append()的方法
import sys,os sys.path.append(os.getcwd()) from src.src_test2 import Test2
使用append的方式,將程序文件根目錄放進(jìn)了sys.path中,然后再引用絕對(duì)路徑,這樣的方式,不管使用上文中的第一或第二執(zhí)行方式都可以調(diào)用,也可以單獨(dú)編譯test1文件,不用修改import路徑,也是相對(duì)安全的方式。但是缺點(diǎn)就是,如果你修改了某一個(gè)包名,需要將所有引用地方都修改一下,工作量大,所以因地制宜。
綜上,詳細(xì)講解了相對(duì)路徑和絕對(duì)路徑的引用方法,現(xiàn)在你應(yīng)該對(duì)import導(dǎo)入的問題有了清晰的理解吧
備注:本文基于Python3.7版本測(cè)試
到此這篇關(guān)于Python模塊之間的相互引用問題的文章就介紹到這了,更多相關(guān)Python模塊引用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
利用Python發(fā)送 10 萬個(gè) http 請(qǐng)求
這篇文章主要介紹了如何利用Python發(fā)送 10 萬個(gè) http 請(qǐng)求,下面我們講利用Python寫代碼實(shí)現(xiàn)10 萬個(gè) url,對(duì)每個(gè) url 發(fā)送 http 請(qǐng)求,并打印請(qǐng)求結(jié)果的狀態(tài)碼,需要的朋友可以參考一下2021-12-12
Python基礎(chǔ)教程之if判斷,while循環(huán),循環(huán)嵌套
這篇文章主要介紹了Python基礎(chǔ)教程之if判斷,while循環(huán),循環(huán)嵌套 的相關(guān)知識(shí),非常不錯(cuò),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-04-04
python shutil.move移動(dòng)文件或目錄方式
`shutil.move()`函數(shù)可以移動(dòng)文件或目錄,移動(dòng)目錄時(shí),如果目標(biāo)目錄不存在,會(huì)創(chuàng)建該目錄并將源目錄內(nèi)容移動(dòng)到新目錄;如果目標(biāo)目錄存在,則將源目錄移動(dòng)到目標(biāo)目錄下,移動(dòng)文件時(shí),如果目標(biāo)路徑是目錄,則將文件移動(dòng)到該目錄下并重命名2024-12-12
python pytest進(jìn)階之xunit fixture詳解
這篇文章主要介紹了python pytest進(jìn)階之xunit fixture詳解,了解unittest的同學(xué)應(yīng)該知道我們?cè)诔跏蓟h(huán)境和銷毀工作時(shí),unittest使用的是setUp,tearDown方法,那么在pytest框架中同樣存在類似的方法,今天我們就來具體說明,需要的朋友可以參考下2019-06-06
Python爬取動(dòng)態(tài)網(wǎng)頁中圖片的完整實(shí)例
這篇文章主要給大家介紹了關(guān)于Python爬取動(dòng)態(tài)網(wǎng)頁中圖片的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-03-03
python中cv2.projectPoints的用法小結(jié)
這篇文章主要介紹了python中cv2.projectPoints的用法,本文通過示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友參考下吧2023-12-12
TensorFlow實(shí)現(xiàn)指數(shù)衰減學(xué)習(xí)率的方法
這篇文章主要介紹了TensorFlow實(shí)現(xiàn)指數(shù)衰減學(xué)習(xí)率的方法,本文給大家介紹的非常詳細(xì),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-02-02

