Python中模塊與包有相同名字的處理方法

在編程開(kāi)發(fā)中，個(gè)人覺(jué)得，只要按照規(guī)范去做，很少會(huì)出問(wèn)題。剛開(kāi)始學(xué)習(xí)一門(mén)技術(shù)時(shí)，的確會(huì)遇到很多的坑。踩的坑多了，這是好事，會(huì)學(xué)到更多東西，也會(huì)越來(lái)越覺(jué)得按照規(guī)范做的重要性，規(guī)范的制定就是用來(lái)規(guī)避問(wèn)題的。有時(shí)候確實(shí)應(yīng)該聽(tīng)聽(tīng)有經(jīng)驗(yàn)人的建議，不要一意孤行。這好像不是本文的重點(diǎn)，其實(shí)我重點(diǎn)是想表達(dá)，盡量按規(guī)范做事，這樣會(huì)少走很多彎路。

我現(xiàn)在使用的主力編程語(yǔ)言是 Python，在接觸 Python 至今，我感覺(jué)我踩的坑還是極少的，基本上沒(méi)有遇到什么奇怪的問(wèn)題。實(shí)際上，這并不是一件好事，不踩坑，很多躺在暗處的知識(shí)點(diǎn)你不會(huì)了解，所以也很難成長(zhǎng)。幸好，有一些會(huì)踩坑的同事。

一同事問(wèn)我，在 Python 中，如果一個(gè)模塊和一個(gè)包同名時(shí)，是不是只能導(dǎo)入包，如果要導(dǎo)入模塊該怎么辦。他的意思大概是這樣的，在項(xiàng)目的同一級(jí)目錄下，有一個(gè) foo.py 文件和一個(gè) foo/ 目錄，如果 import foo 會(huì)導(dǎo)入 foo/ 的內(nèi)容而不是 foo.py 的內(nèi)容。

被問(wèn)到這個(gè)問(wèn)題時(shí)，我首先感覺(jué)到的是詫異，這明顯是存在歧義的。如果是我，肯定不會(huì)把模塊名和包名設(shè)計(jì)成一樣的名字，因?yàn)楸举|(zhì)上來(lái)說(shuō)在導(dǎo)入的時(shí)候沒(méi)法區(qū)分到底要導(dǎo)入誰(shuí)。除非系統(tǒng)有特別的規(guī)定，例如，規(guī)定這種情況只能導(dǎo)入包。

我的潛意識(shí)里認(rèn)為這里應(yīng)該報(bào)錯(cuò)，Python 解釋器不知道要導(dǎo)入誰(shuí)。但是，同事告訴我，別人的代碼是這么寫(xiě)的，而且在這種情況下會(huì)默認(rèn)導(dǎo)入包。那就是可以的咯，而且解釋器已經(jīng)規(guī)定這種情況會(huì)總是導(dǎo)入包。

為了驗(yàn)證下這一點(diǎn)，我寫(xiě)了個(gè)簡(jiǎn)單的項(xiàng)目，項(xiàng)目結(jié)構(gòu)如下：

.
├── main.py
└── same
 ├── api
 │ └── __init__.py
 ├── auth
 │ └── __init__.py
 ├── auth.py
 └── __init__.py

其中：

same/api/__init__/py 的內(nèi)容：    
from .. import auth

same/auth/__init__.py 的內(nèi)容：    
auth_str = "This is str in package!"

same/auth.py 的內(nèi)容：    
auth_str = "This is str in module!"

main.py 的內(nèi)容：
    
from __future__ import print_function
 
from same.api import auth
 
# Script starts from here
 
if __name__ == "__main__":
 print(auth.auth_str)
稍微有些復(fù)雜，哈哈，主要是同事那兒大致的結(jié)構(gòu)是這樣的，這里是為更好的模擬下。我在 same.auth 包中定義了一個(gè) auth_str 字符串，又在同名的 same.auth 模塊中定義了一個(gè)同名的 auth_str 字符串，然后在 same.api 包嘗試導(dǎo)入 auth，最后在 main.py 嘗試輸出 same.api.auth.auth_str，看看到底哪個(gè)字符串會(huì)被打印。同時(shí)嘗試用 Python2 和 Python3 執(zhí)行 main.py，得到的結(jié)果都是：    
This is str in package!
這里驗(yàn)證了我們的猜想是正確的，解釋器的確只導(dǎo)入了包中內(nèi)容。但是，我并不知道是否有官方的資料說(shuō)明就是這樣的，所以我不敢確信，萬(wàn)一這只是巧合呢。
于是，我開(kāi)始查資料來(lái)驗(yàn)證這一結(jié)論。我就說(shuō)實(shí)話吧，對(duì)于一個(gè)英文水平爛到你無(wú)法想象的我，只能先嘗試用百度搜索下答案了。事實(shí)是，用百度往往都是遺憾的。片刻后，無(wú)果，我只能硬著頭皮嘗試英文搜索了。于是，在 stackoverflow 上找到了如下提問(wèn)：
How python deals with module and package having the same name?
其中有一個(gè)人回答說(shuō) Python 官方文檔中在描述模塊搜索路徑時(shí)提到了這一點(diǎn)：https://docs.python.org/3/tutorial/modules.html#the-module-search-path.
文檔中有如下一段描述：
After initialization, Python programs can modify sys.path. The directory containing the script being run is placed at the beginning of the search path, ahead of the standard library path. This means that scripts in that directory will be loaded instead of modules of the same name in the library directory. This is an error unless the replacement is intended. See section Standard Modules for more information.
也就是說(shuō)，目錄在庫(kù)的搜索路徑下會(huì)首先被搜索，這就意味著目錄會(huì)代替同名的模塊被加載。
這下終于放心了，之前的結(jié)論得到證實(shí)。在 Python 中，如果嘗試導(dǎo)入同名的模塊和包時(shí)，包會(huì)被導(dǎo)入。這種情況下，如果想要導(dǎo)入模塊，恐怕要用一些 ‘hack' 的方法，上面提到的 stackoverflow 帖下有一些示例可以參考。當(dāng)然，最好的方法是避免這樣的設(shè)計(jì)，這樣你就不會(huì)花那么長(zhǎng)時(shí)間去查資料，也不會(huì)花那么長(zhǎng)時(shí)間來(lái)寫(xiě)類似于本文的文章。