前話

最近跟著廖雪峰的教程學到 模塊 這一節(jié)。關于如何自定義一個模塊，如果大家不懂的話先來看看基本的介紹：

模塊

在計算機程序的開發(fā)過程中，隨著程序代碼越寫越多，在一個文件里代碼就會越來越長，越來越不容易維護。

為了編寫可維護的代碼，我們把很多函數(shù)分組，分別放到不同的文件里，這樣，每個文件包含的代碼就相對較少，很多編程語言都采用這種組織代碼的方式。在Python中，一個.py文件就稱之為一個模塊（Module）。

使用模塊有什么好處？

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

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

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

舉個例子，一個abc.py的文件就是一個名字叫abc的模塊，一個xyz.py的文件就是一個名字叫xyz的模塊。

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

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

引入了包以后，只要頂層的包名不與別人沖突，那所有模塊都不會與別人沖突?，F(xiàn)在，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。

自己創(chuàng)建模塊時要注意命名，不能和Python自帶的模塊名稱沖突。例如，系統(tǒng)自帶了sys模塊，自己的模塊就不可命名為sys.py，否則將無法導入系統(tǒng)自帶的sys模塊。

mycompany.web也是一個模塊，請指出該模塊對應的.py文件。

小結

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

創(chuàng)建自己的模塊時，要注意：

• 模塊名要遵循Python變量命名規(guī)范，不要使用中文、特殊字符；
• 模塊名不要和系統(tǒng)模塊名沖突，最好先查看系統(tǒng)是否已存在該模塊，檢查方法是在Python交互環(huán)境執(zhí)行import abc，若成功則說明系統(tǒng)存在此模塊。

模塊是個好東西啊，大牛們開源共享許多模塊也加快了大家開發(fā)的速度，許多開源模塊可以在這里找到 ↓

https://pypi.python.org/pypi

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

因此在這里記錄下來。

開始

第一種，直接 import

這里有個大前提，就是你的py執(zhí)行文件和模塊同屬于同個目錄（父級目錄），如下圖：

• main.py 和 pwcong模塊同在python目錄
• 執(zhí)行文件為main.py
• pwcong文件夾為一個模塊

我把pwcong模塊提供的函數(shù)寫在 __init__.py 里，里面只提供一個 hi 函數(shù)：

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

執(zhí)行文件main.py直接import模塊：

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

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

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

第二種，通過sys模塊導入自定義模塊的path

如果執(zhí)行文件和模塊不在同一目錄，這時候直接import是找不到自定義模塊的。如下圖：

• 執(zhí)行文件main.py在main目錄下
• pwcong模塊在python目錄下

sys模塊是python內置的，因此我們導入自定義模塊的步驟如下：

1. 先導入sys模塊
2. 然后通過sys.path.append(path) 函數(shù)來導入自定義模塊所在的目錄
3. 導入自定義模塊。

這時候 main.py 這樣寫：

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

最后執(zhí)行main.py文件，最終輸出 hi ，第二種方式完成。

第三種，通過pth文件找到自定義模塊

這個方法原理就是利用了系統(tǒng)變量，python會掃描path變量的路徑來導入模塊，可以在系統(tǒng)path里面添加。但是我還是推薦使用pth文件添加。

模塊和執(zhí)行文件目錄結構跟上圖一樣：

• 執(zhí)行文件main.py在main目錄下
• pwcong模塊在python目錄下

我們創(chuàng)建一個 module_pwcong.pth 文件，里面內容就是 pwcong模塊所在的目錄：

C:\Users\Pwcong\Desktop\python

將該 module_pwcong.pth 文件放到這里：

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

例如我的：

然后 main.py 導入并使用自定義模塊：

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

最后執(zhí)行 main.py 文件，可以輸出 hi ，第三種方式完成。

結束

到這里三種導入自定義模塊的方式栗子就完成了，我寫的應該很詳細了吧 ：）

好了，以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。

最新評論