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

不言
發布: 2023-03-23 18:18:02
原創
5761 人瀏覽過

這篇文章主要為大家介紹了關於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內建的,因此我們導入自訂模組的步驟如下:

  1. 先導入sys模組

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

  3. 匯入自訂模組。

這時候 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 ,第三種方式完成。




#

以上是Python3導入自訂模組的三種方法詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
作者最新文章
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板
關於我們 免責聲明 Sitemap
PHP中文網:公益線上PHP培訓,幫助PHP學習者快速成長!