Python的絕對導入和相對導入

2019 年 11 月 27 日
筆記

Python 相對導入與絕對導入，這兩個概念是相對於包內導入而言的。包內導入即是包內的模組導入包內部的模組。

Python import 的搜索路徑

在當前目錄下搜索該模組
在環境變數 PYTHONPATH 中指定的路徑列表中依次搜索
在 Python 安裝路徑的 lib 庫中搜索

Python import 的步驟

python 所有載入的模組資訊都存放在 sys.modules 結構中，當 import 一個模組時，會按如下步驟來進行

如果是 import A，檢查 sys.modules 中是否已經有 A，如果有則不載入，如果沒有則為 A 創建 module 對象，並載入 A
如果是 from A import B，先為 A 創建 module 對象，再解析A，從中尋找B並填充到 A 的 __dict__ 中

相對導入與絕對導入

絕對導入的格式為 import A.B 或 from A import B，相對導入格式為 from . import B 或 from ..A import B，.代表當前模組，..代表上層模組，…代表上上層模組，依次類推。

相對導入可以避免硬編碼帶來的維護問題，例如我們改了某一頂層包的名，那麼其子包所有的導入就都不能用了。但是存在相對導入語句的模組，不能直接運行，否則會有異常：

ValueError: Attempted relative import in non-package

如果是絕對導入，一個模組只能導入自身的子模組或和它的頂層模組同級別的模組及其子模組。
如果是相對導入，一個模組必須有包結構且只能導入它的頂層模組內部的模組。所以，如果一個模組被直接運行，則它自己為頂層模組，不存在層次結構，所以找不到其他的相對路徑，所以如果直接運行python xx.py ，而xx.py有相對導入就會報錯

看下面例子：

package  ├── __init__.py  ├── sub_pkg1  │   ├── __init__.py  │   ├── moduleX.py  │   ├── moduleY.py  └── sub_pkg2      ├── __init__.py      └── moduleZ.py

moduleX.py

# import moduleY  # from sub_pkg1 import moduleY  from . import moduleY    print  "X __name__", __name__

moduleY.py

print  "Y __name__", __name__

當我們直接運行 python sub_pkg1/moduleX.py的時候，會報錯

ValueError: Attempted relative import in non-package

當我們這樣運行的時候 python -m sub_pkg1.moduleX，才能正常運行

Y __name__ sub_pkg1.moduleY  X __name__ __main__

為什麼會這樣？簡單地說，直接運行 .py 文件和 import 這個文件有很大區別。Python 解釋器判斷一個 py 文件屬於哪個 package 時並不完全由該文件所在的文件夾決定。它還取決於這個文件是如何 load 進來的（直接運行 or import）。

有兩種方式載入一個 py 文件：

作為 top-level 腳本作為 top-level 腳本指的是直接運行腳本，比如 python myfile.py。有且只能有一個 top-level 腳本，就是最開始執行的那個（比如 python myfile.py 中的 myfile.py）。
作為 module 作為 module 是指，執行 python -m myfile，或者在其它 py 文件中用 import 語句來載入，那麼它就會被當作一個 module。

當一個 py 文件被載入之後，它會被賦予一個名字，保存在 __name__ 屬性中。如果是 top-level 腳本，那麼名字就是 __main__。如果是作為 module，名字就是把它所在的 packages/subpackages 和文件名用 . 連接起來。

例如，moduleX 被 import 進來，它的名字就是 package.subpackage1.moduleX。如果 import 了 moduleA，它的名字是 package.moduleA。如果直接運行 moduleX 或 moduleA，那麼名字就都是__main__ 了。

所以上面的moduleX的__name__是__main__，因為他是直接運行的， moduleY的__name__是sub_pkg1.moduleY，因為他是被import 來使用的。

from future import absolute_import

Python2.x 預設為相對路徑導入，Python3.x 預設為絕對路徑導入。絕對導入可以避免導入子包覆蓋掉標準庫模組（由於名字相同，發生衝突）。如果在 Python2.x 中要默認使用絕對導入，可以在文件開頭加入如下語句：

from __future__ import absolute_import

這句 import 並不是指將所有的導入視為絕對導入，而是指禁用 implicit relative import（隱式相對導入）, 但並不會禁掉 explicit relative import（顯示相對導入）。

那麼到底什麼是隱式相對導入，什麼又是顯示的相對導入呢？上面的moduleX.py，三種的import moduleY都是可以的

import moduleY # 隱式相對引入  from . import moduleY # 顯式相對引入  from sub_pkg1 import moduleY # 絕對引入

隱式相對就是沒有告訴解釋器相對於誰，但默認相對與當前模組；而顯示相對則明確告訴解釋器相對於誰來導入。以上導入方式的第三種，才是官方推薦的，第一種是官方強烈不推薦的，Python3 中已經被廢棄，這種方式只能用於導入 path 中的模組。

相對與絕對僅針對包內導入而言

最後再次強調，相對導入與絕對導入僅針對於包內導入而言，要不然本文所討論的內容就沒有意義。所謂的包，就是包含 __init__.py 文件的目錄，該文件在包導入時會被首先執行，該文件可以為空，也可以在其中加入任意合法的 Python 程式碼。

相對導入可以避免硬編碼，對於包的維護是友好的。絕對導入可以避免與標準庫命名的衝突，實際上也不推薦自定義模組與標準庫命令相同。

前面提到含有相對導入的模組不能被直接運行，實際上含有絕對導入的模組也不能被直接運行，會出現 ImportError：

ImportError: No module named XXX

這與絕對導入時是一樣的原因。要運行包中包含絕對導入和相對導入的模組，可以用 python -m A.B.C 告訴解釋器模組的層次結構。

有人可能會問：假如有兩個模組 a.py 和 b.py 放在同一個目錄下，為什麼能在 b.py 中 import a 呢？

這是因為這兩個文件所在的目錄不是一個包，那麼每一個 python 文件都是一個獨立的、可以直接被其他模組導入的模組，就像你導入標準庫一樣，它們不存在相對導入和絕對導入的問題。相對導入與絕對導入僅用於包內部。