Python3匯入自訂模組的三種方法詳解

這篇文章主要給大家介紹了關於Python3匯入自訂模組的三種方法，文中通過範例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值

前話

最近跟著廖雪峰的教程學到 模組 這一節。關於如何自訂一個模組，如果大家不懂的話先來看看基本的介紹：

模組

在電腦程式的開發過程中，隨著程式碼越寫越多，在一個檔案裡代碼就會越來越長，越來越不容易維護。

為了編寫可維護的代碼，我們把很多函數分組，分別放到不同的檔案裡，這樣，每個檔案包含的代碼就相對較少，很多程式設計語言都採用這種組織代碼的方式。在Python中，一個.py檔案就稱之為一個模組（Module）。

使用模組有什麼好處？

最大的好處是大大提高了代碼的可維護性。其次，編寫代碼不必從零開始。當一個模組編寫完畢，就可以被其他地方引用。我們在編寫程式的時候，也經常引用其他模組，包括Python內建的模組和來自第三方的模組。

使用模組還可以避免函數名和變數名衝突。相同名字的函數和變數完全可以分別存在不同的模組中，因此，我們自己在編寫模組時，不必考慮名字會與其他模組衝突。但是也要注意，盡量不要與內建函數名字衝突。點這裡查看Python的所有內建函數。

你也許還想到，如果不同的人編寫的模組名相同怎麼辦？為了避免模組名衝突，Python又引入了按目錄來組織模組的方法，稱為包（Package）。

舉個例子，一個abc.py的檔案就是一個名字叫abc的模組，一個xyz.py的檔案就是一個名字叫xyz的模組。

現在，假設我們的abc和xyz這兩個模組名字與其他模組衝突了，於是我們可以通過包來組織模組，避免衝突。方法是選擇一個頂層包名，比如mycompany，按照如下目錄存放：

mycompany
├─ __init__.py
├─ abc.py
└─ xyz.py

引入了包以後，只要頂層的包名不與別人衝突，那所有模組都不會與別人衝突。現在，abc.py模組的名字就變成了mycompany.abc，類似的，xyz.py的模組名變成了mycompany.xyz。

請注意，每一個包目錄下面都會有一個__init__.py的檔案，這個檔案是必須存在的，否則，Python就把這個目錄當成普通目錄，而不是一個包。__init__.py可以是空檔案，也可以有Python代碼，因為__init__.py本身就是一個模組，而它的模組名就是mycompany。

類似的，可以有多級目錄，組成多級層次的包結構。比如如下的目錄結構：

mycompany
├─ web
│ ├─ __init__.py
│ ├─ utils.py
│ └─ www.py
├─ __init__.py
├─ abc.py
└─ xyz.py

檔案www.py的模組名就是mycompany.web.www，兩個檔案utils.py的模組名分別是mycompany.utils和mycompany.web.utils。

自己建立模組時要注意命名，不能和Python內建的模組名稱衝突。例如，系統內建了sys模組，自己的模組就不可命名為sys.py，否則將無法匯入系統內建的sys模組。

mycompany.web也是一個模組，請指出該模組對應的.py檔案。

小結

模組是一組Python代碼的集合，可以使用其他模組，也可以被其他模組使用。

建立自己的模組時，要注意：

• 模組名要遵循Python變數命名規範，不要使用中文、特殊字元；

• 模組名不要和系統模組名衝突，最好先查看系統是否已存在該模組，檢查方法是在Python互動環境執行import abc，若成功則說明系統存在此模組。

模組是個好東西啊，大牛們開源共用許多模組也加快了大家開發的速度

因為剛入門所有有很多細節不懂，在網上搜尋資料的時候發現各位大神們的教程實在太過於精簡，讓我這個菜鳥很辛苦的才操作成功。

因此在這裡記錄下來。

開始

第一種，直接 import

這裡有個大前提，就是你的py執行檔案和模組同屬於同個目錄（父級目錄），如：

• main.py 和 pwcong模組同在python目錄

• 執行檔案為main.py

• pwcong檔案夾為一個模組

我把pwcong模組提供的函數寫在 __init__.py 裡，裡面只提供一個 hi 函數：

# pwcong 模組的 __init__.py# -*- coding: utf-8 -*-def hi(): print("hi")

執行檔案main.py直接import模組：

# main.py# -*- coding: utf-8 -*-import pwcongpwcong.hi()

接著我們運行一下main.py可以看到命令列視窗輸出了一句 hi ，第一種方式完成。

使用模組方式為：先匯入-》接著輸入模組.變數|函數， 如上面例子的 pwcong.hi()

第二種，通過sys模組匯入自訂模組的path

如果執行檔案和模組不在同一目錄，這時候直接import是找不到自訂模組的。如：

• 執行檔案main.py在main目錄下

• pwcong模組在python目錄下

sys模組是python內建的，因此我們匯入自訂模組的步驟如下：

1. 先匯入sys模組

2. 然後通過sys.path.append(path) 函數來匯入自訂模組所在的目錄

3. 匯入自訂模組。

這時候 main.py 這樣寫：

# main.py# -*- coding: utf-8 -*-import syssys.path.append(r"C:\Users\Pwcong\Desktop\python")import pwcongpwcong.hi()

最後執行main.py檔案，最終輸出 hi ，第二種方式完成。

第三種，通過pth檔案找到自訂模組

這個方法原理就是利用了系統變數，python會掃描path變數的路徑來匯入模組，可以在系統path裡面添加。但是我還是推薦使用pth檔案添加。

模組和執行檔案目錄結構跟一樣：

• 執行檔案main.py在main目錄下

• pwcong模組在python目錄下

我們建立一個 module_pwcong.pth 檔案，裡面內容就是 pwcong模組所在的目錄：

C:\Users\Pwcong\Desktop\python

將該 module_pwcong.pth 檔案放到這裡：

python安裝目錄\Python35\Lib\site-packages

例如我的：

然後 main.py 匯入並使用自訂模組：

# -*- coding: utf-8 -*-import pwcongpwcong.hi()

最後執行 main.py 檔案，可以輸出 hi ，第三種方式完成。