詳解Python中的相對導入和絕對導入

前言

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,.代表當前模塊,..代表上層模塊,...代表上上層模塊,依次類推。

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

1

ValueError: Attempted relative import in non-package

這是什麼原因呢?我們需要先來了解下導入模塊時的一些規則:

在沒有明確指定包結構的情況下,Python 是根據 __name__ 來決定一個模塊在包中的結構的,如果是 __main__ 則它本身是頂層模塊,沒有包結構,如果是A.B.C 結構,那麼頂層模塊是 A。基本上遵循這樣的原則:

  • 如果是絕對導入,一個模塊只能導入自身的子模塊或和它的頂層模塊同級別的模塊及其子模塊

  • 如果是相對導入,一個模塊必須有包結構且只能導入它的頂層模塊內部的模塊

如果一個模塊被直接運行,則它自己爲頂層模塊,不存在層次結構,所以找不到其他的相對路徑。

Python2.x 缺省爲相對路徑導入,Python3.x 缺省爲絕對路徑導入。絕對導入可以避免導入子包覆蓋掉標準庫模塊(由於名字相同,發生衝突)。如果在 Python2.x 中要默認使用絕對導入,可以在文件開頭加入如下語句:

1

from __future__ import absolute_import

from __future__ import absolute_import

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

那麼到底什麼是隱式相對導入,什麼又是顯示的相對導入呢?我們來看一個例子,假設有如下包結構:

1

2

3

4

5

6

7

8

9

10

11

12

13

14

thing

├── books

│ ├── adventure.py

│ ├── history.py

│ ├── horror.py

│ ├── __init__.py

│ └── lovestory.py

├── furniture

│ ├── armchair.py

│ ├── bench.py

│ ├── __init__.py

│ ├── screen.py

│ └── stool.py

└── __init__.py

那麼如果在 stool 中引用 bench,則有如下幾種方式:

1

2

3

import bench     # 此爲 implicit relative import

from . import bench   # 此爲 explicit relative import

from furniture import bench # 此爲 absolute import

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

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

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

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

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

1

ImportError: No module named XXX

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

有人可能會問:假如有兩個模塊 a.py 和 b.py 放在同一個目錄下,爲什麼能在 b.py 中 import a 呢?

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

原文地址

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章