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 pwcong
pwcong.hi()

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

使用模塊方式爲:先導入-》接着輸入模塊.變量|函數, 如上面例子的 pwcong.hi()
第二種,通過sys模塊導入自定義模塊的path

如果執行文件和模塊不在同一目錄,這時候直接import是找不到自定義模塊的。如下圖:在這裏插入圖片描述
執行文件main.py在main目錄下
pwcong模塊在python目錄下
sys模塊是python內置的,因此我們導入自定義模塊的步驟如下:

先導入sys模塊
然後通過sys.path.append(path) 函數來導入自定義模塊所在的目錄
導入自定義模塊。
這時候 main.py 這樣寫:

# main.py
# -*- coding: utf-8 -*-
import sys
sys.path.append(r"C:\Users\Pwcong\Desktop\python")
import pwcong
pwcong.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 pwcong
pwcong.hi()

最後執行 main.py 文件,可以輸出 hi ,第三種方式完成。

結束

到這裏三種導入自定義模塊的方式栗子就完成了,我寫的應該很詳細了吧 :)

非常感謝你的閱讀
大學的時候選擇了自學python,工作了發現吃了計算機基礎不好的虧,學歷不行這是沒辦法的事,只能後天彌補,於是在編碼之外開啓了自己的逆襲之路,不斷的學習python核心知識,深入的研習計算機基礎知識,整理好了,我放在我們的Python學習扣qun:774711191,如果你也不甘平庸,那就與我一起在編碼之外,不斷成長吧!

其實這裏不僅有技術,更有那些技術之外的東西,比如,如何做一個精緻的程序員,而不是“屌絲”,程序員本身就是高貴的一種存在啊,難道不是嗎?[點擊加入]想做你自己想成爲高尚人,加油!

@本文來源於公衆號:csdn2299,喜歡可以關注公衆號 程序員學府

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