Python import的搜索路徑

import的搜索路徑為：

• 搜索「內(nèi)置模塊」（built-in module）
• 搜索 sys.path 中的路徑
• 而sys.path在初始化時(shí)，又會(huì)按照順序添加以下路徑：

foo.py 所在目錄（如果是軟鏈接，那么是真正的 foo.py 所在目錄）或當(dāng)前目錄；

環(huán)境變量 PYTHONPATH中列出的目錄（類(lèi)似環(huán)境變量 PATH，由用戶定義，默認(rèn)為空）；
site 模塊被 import 時(shí)添加的路徑1（site 會(huì)在運(yùn)行時(shí)被自動(dòng) import）。

import site 所添加的路徑一般是 XXX/site-packages。如果懶得記 sys.path 的初始化過(guò)程，可以簡(jiǎn)單的認(rèn)為 import 的查找順序是：

內(nèi)置模塊

.py 文件所在目錄
pip 或 easy_install 安裝的包

絕對(duì)導(dǎo)入和相對(duì)導(dǎo)入

絕對(duì)導(dǎo)入和相對(duì)導(dǎo)入的關(guān)系可以類(lèi)比絕對(duì)路徑和相對(duì)路徑。

絕對(duì)導(dǎo)入的格式為：

import A.B
或
from A import B

相對(duì)導(dǎo)入格式為：

from . import B
或
from ..A import B

其中，點(diǎn)號(hào).代表當(dāng)前模塊，..代表上層模塊，…代表上上層模塊，依次類(lèi)推。

模塊的執(zhí)行方式

模塊的執(zhí)行可以有兩種方式：直接執(zhí)行和以模塊執(zhí)行，即：

python example/foo.py
或
python -m example.foo

注意，以模塊執(zhí)行時(shí)，一定要有包的概念，即example一定是個(gè)包，而foo是這個(gè)包下的模塊，這樣才能順利執(zhí)行。

包和模塊

模塊: 一個(gè) .py 文件就是一個(gè)模塊（module）

包: init .py 文件所在目錄就是包（package）

各種情形測(cè)試

模塊直接導(dǎo)入

即模塊所在的目錄都不是一個(gè)包結(jié)構(gòu)，各個(gè)模塊都是獨(dú)立的，比如以下的目錄結(jié)構(gòu)：

D:\LEARN\IMPORT_TEST\TEST1
├─pack1
│  modu1.py
└─pack2
  modu2.py

modu1.py中的內(nèi)容為：

import sys
sys.path.append("D:\\learn\\import_test\\TEST1\\pack2")
from modu2 import hello2
hello2()

modu2.py中的內(nèi)容為：

def hello2():
 print("hello, I am module 2")

注意在modu1中一定加上sys.path.append那部分內(nèi)容，即根據(jù)上面的描述，一定要讓modu1能找到modu2才行，否則就會(huì)出現(xiàn)如下錯(cuò)誤：

ModuleNotFoundError: No module named 'modu2'

此時(shí)進(jìn)入pack1目錄下，以直接執(zhí)行或模塊執(zhí)行的方式都可以順利輸出。

包外導(dǎo)入

將上面兩個(gè)模塊所在的目錄都變?yōu)榘Y(jié)構(gòu)，即：

D:\LEARN\IMPORT_TEST\TEST2
├─pack1
│  modu1.py
│  __init__.py
└─pack2
  modu2.py
  __init__.py

此時(shí)也能順利執(zhí)行，同時(shí)比上面非包結(jié)構(gòu)的多出來(lái)一條執(zhí)行方式，即：

python -m pack1.modu1


即以包名+模塊名的方式執(zhí)行。

上面兩種情形，即模塊與模塊、包與包都是相互獨(dú)立的關(guān)系，也就沒(méi)有相對(duì)導(dǎo)入的意義。

如果是在一個(gè)包內(nèi)的不同模塊的導(dǎo)入，那么最自然的就是使用相對(duì)導(dǎo)入。

包內(nèi)相對(duì)導(dǎo)入

D:\LEARN\IMPORT_TEST\Test3
│ __init__.py
│
├─pack1
│  modu1.py
│  __init__.py
│
└─pack2
  modu2.py
  __init__.py

此時(shí)modu1.py中的內(nèi)容為：

from ..pack2.modu2 import hello2
hello2()

即將sys.path.append去掉，因?yàn)槭窃谝粋€(gè)包內(nèi)相互引用，此時(shí)這樣寫(xiě)沒(méi)有意義。

此時(shí)正確運(yùn)行的方式是進(jìn)入Test3上一層的文件夾，然后：

python -m Test3.pack1.modu1

即明確地告訴解釋器模塊的層次結(jié)構(gòu)。

而如果采用直接運(yùn)行的方式，比如：

python Test3\pack1\modu1.py

就會(huì)報(bào)如下錯(cuò)誤：

ValueError: attempted relative import beyond top-level package

這是因?yàn)椋鄬?duì)導(dǎo)入使用模塊的 name （這里的name和下面的main都是有兩個(gè)下劃線的，但是網(wǎng)頁(yè)顯示不出來(lái)。。）屬性來(lái)決定模塊在包結(jié)構(gòu)中的位置。當(dāng) name 屬性不包含包信息（i.e. 沒(méi)有用'.'表示的層次結(jié)構(gòu)，比如' main ‘），則相對(duì)導(dǎo)入將模塊解析為頂層模塊，而不管模塊在文件系統(tǒng)中的實(shí)際位置。這里模塊被直接運(yùn)行，則它自己為頂層模塊，不存在層次結(jié)構(gòu)，所以找不到其他的相對(duì)路徑。

因此，直接運(yùn)行帶有相對(duì)導(dǎo)入的模塊是不行的，需要通過(guò)模塊運(yùn)行的方式，將包結(jié)構(gòu)明確告訴它才行。

這個(gè)原理也適用于下面這種錯(cuò)誤，比如將modu2移動(dòng)到pack1中，即與modu1在同一個(gè)目錄下，然后將modu1的內(nèi)容改為這樣的相對(duì)引用：

from .modu2 import hello2
hello2()

此時(shí)使用模塊執(zhí)行的方式?jīng)]有問(wèn)題，如果還是想嘗試直接運(yùn)行，那么就會(huì)出現(xiàn)：

ModuleNotFoundError: No module named '__main__.modu2'; '__main__' is not a package

原因就是此時(shí)沒(méi)有包結(jié)構(gòu)， main 也不是個(gè)包。

那么解決方法就是或者使用模塊運(yùn)行的方式運(yùn)行，或者將它改成下面的絕對(duì)導(dǎo)入的方式就可以直接運(yùn)行。

包內(nèi)絕對(duì)導(dǎo)入

那么，如果將modu1.py中的內(nèi)容改為絕對(duì)導(dǎo)入，即：

from Test3.pack2.modu2 import hello2
hello2()

此時(shí)正確運(yùn)行方式也是進(jìn)入Test3上一層文件夾，然后使用模塊執(zhí)行的方式運(yùn)行：

python -m Test3.pack1.modu1

如果此時(shí)采用直接運(yùn)行的方式：

python Test3\pack1\modu1.py

那么就會(huì)報(bào)錯(cuò)：

ModuleNotFoundError: No module named 'Test3'

這主要是因?yàn)門(mén)est3沒(méi)有被找到，即按照第一部分所說(shuō)，Test3沒(méi)有在import的搜索路徑中。所以，只要將它加入進(jìn)去即可，比如：

set PYTHONPATH=D:\learn\import_test\

此時(shí)再直接運(yùn)行就沒(méi)有問(wèn)題了。

總結(jié)

以上所述是小編給大家介紹的Python3中的Import理解，希望對(duì)大家有所幫助！

最新評(píng)論