本文主要介紹如何在一個Python專案中，優雅的實現專案內各個package的模組（module）之間的相互引用。

之所以寫這篇文章，是因為網上流傳的各種奇技淫巧簡直五花八門（包括stackoverflow等知名社群），極易誤導對python的import機制不熟悉的人。比如我就曾一度因為找不到優雅的import方式，而認為python是一門愚蠢的語言。所以，我把近一上午的學習結果總結出來，希望大家不要誤入歧途。

本文參考瞭如下兩篇部落格： 
habnab關於python package的精彩總結：地址點我 
Jean-Paul Calderone關於python專案結構的建議：地址點我

demo project

本文以一個demo project為例，來介紹python的包管理機制。

這個demo project我放到github上了：地址點我

其中，專案根目錄有三個資料夾：

• data：存放專案資料
• doc：存放專案文件
• package：一個demo python package

其中，package中的檔案結構如下圖： 

python package

基礎知識

當你import的時候，python只會在sys.path這個變數（一個list，你可以print出來看）裡面的路徑中找可能匹配的package和module。

而一個package跟一個普通資料夾的區別在於，package的資料夾中多了一個__init__.py檔案。換句話說，如果你在某個資料夾中添加了一個__init__.py檔案，則python就認為這個資料夾是一個package。

__init__.py檔案可以是空的（也推薦者這麼做），它只是告訴python當前資料夾是一個package。當然，也可以在裡面新增一些程式碼，這些程式碼會在import這個包的時候執行。

所以，請確保你要import的檔案所在的資料夾有__init__.py檔案（除非它在sys.path中某個資料夾下）。

錯誤的import做法

如上述project中，如果你想讓subpackage2中的foo2來import subpackage1中的foo1，便會出現找不到subpackage1的情況。

目前網路上大部分的做法都是通過sys.path.append(yourpath)之類的方法，將你需要import的module的目錄新增到sys.path中。或者，通過修改PYTHONPATH這個環境變數來將新增（跟修改sys.path效果相同）。

但是，這種做法有如下幾個缺點：

• 如果你用PYTHONPATH，那麼當有多個專案時，你需要把每個專案的根目錄都加入到PYTHONPATH中，會使得PYTHONPATH變得十分臃腫
• 如果你使用sys.path，由於資料夾是動態新增的，所以當你使用相對路徑的時候，實際路徑會十分依賴於你的入口函式，當入口函式改變很可能就會導致程式碼無法執行
• 如果你使用絕對路徑，將你的程式碼在其他機器上執行的時候需要重新配置這些變數，十分麻煩

正確的做法

程式碼中正常import

首先，在程式碼中按照正常方式匯入你需要的包

比如，你需要在app.py中匯入foo1，則：

from package.subpackage1 import foo1 

雖然你可能發現from subpackage1 import foo1也可以正常執行，但是請避免這種使用相對路徑的方法。因為這在python3中將不再支援，同時也有可能會引起奇怪的問題。同時，雖然PEP 328中也給出了 from .subpackage1 import foo1這樣的形式，但是還是不要自己給自己製造麻煩，統一使用完整路徑（絕對路徑）為好。

再比如，如果你需要在foo2.py中匯入foo1.py（在不同的subpackage中），則：

from package.subpackage1 import foo1

跟上面一模一樣，這就是使用絕對路徑的好處，各處的引用高度統一。同時，如果你的package被安裝在其他使用者的機器中，其他使用者也會使用這種絕對路徑來import你package中的模組（回想你自己import第三方package的情景）。

建立__main__.py檔案

在package的根目錄中建立__main__.py檔案，可以使得你的package可以通過python -m直接執行。

demo中的__main__.py檔案十分簡單：

from package.app import main

main()

即import真正的主函式app.py中的main方法，然後呼叫main()

用python -m執行你的python檔案

python的-m引數官方說法是： 
Searches sys.path for the named module and runs the corresponding .py file as a script.

在下面的例子中，加上-m引數後，所執行的.py檔案便會識別其頂層的package

回到剛才的例子。建立完__main__.py之後，cd到專案的根目錄，執行

python -m package

即可實現直接執行__main__.py，即直接運行了package這個包

如果你想直接執行package內的某個.py檔案，比如foo1，則：

python -m package.subpackage1.foo1

當然，你要確保foo1中存在判斷其是否是入口函式的邏輯，如下：

if __name__ == "__main__":

    speak()

總結

至此，我們已經實現了你所希望的所有功能：

• 在project內部實現各個模組之間的import
• project中的各個.py檔案可以直接執行
• 將project遷移到其他機器時，不用進行額外配置

如果還有不明白的，可以將github上的原始碼下載下來看一看，然後用python -m執行一下