詳解Python模塊化–模塊(Modules)和包(Packages)

引言

在剛入門python時,模塊化編程、模塊、類庫等術語常常並不容易理清。尤其是Modules(模塊)和Packages(包),在import引用時很容易混淆出錯。

實際上,Python中的函數(Function)、類(Class)、模塊(Module)、包庫(Package),都是為瞭實現模塊化引用,讓程序的組織更清晰有條理。

  • 通常,函數、變量、類存儲在被稱為模塊(Module)的.py文件中,一組模塊文件又組成瞭包(Package)。
  • 將函數、變量、類存儲在存儲在獨立的.py文件中,可隱藏代碼實現的細節,將不同代碼塊重新組織,與主程序分離,簡化主程序的邏輯,提高主程序的可讀性。
  • 有瞭包和模塊文件,可以在其他不同程序中進行復用,還可以使用其他人開發的第三方依賴庫。

Python Modules模塊

Modules2模塊是包含 Python 定義和語句的文件。以.py為後綴的文件名就是模塊名稱。

在模塊內,模塊的名稱可以用全局變量 __name__表示(字符串)。

舉個例子,我們創建瞭一個fibo.py文件,文件內容為:

# Fibonacci numbers module
def fib(n):    # write Fibonacci series up to n
    a, b = 0, 1
    while a < n:
        print(a, end=' ')
        a, b = b, a+b
    print()
def fib2(n):   # return Fibonacci series up to n
    result = []
    a, b = 0, 1
    while a < n:
        result.append(a)
        a, b = b, a+b
    return result

這裡fibo.py就是一個模塊,fib、fib2是fibo模塊中的函數。

導入模塊

如果我們想要在其他程序中使用fibo模塊,可以有以下三種方式導入:

①導入整個模塊

#import module_name
import fibo

可使用下面的語法來使用其中任何一個函數:

#module_name.func()
fibo.fib(10)

⭕ 註意:這裡模塊名+句點不可省略。

②導入模塊中的特定函數

#from module_name import function_name
from fibo import fib, fib2
fib(10)

若使用這種語法,調用函數時就無需使用模塊名+句點。

因為在import語句中已經顯式地導入瞭函數fib和fib2,因此調用它時隻需指定其名稱。

③導入模塊中的所有函數

#from module_name import *
from fibo import *
fib(20)

這種方式會導入除可下劃線 (__)開頭的名稱以外的所有函數。

⭕ 註意:在大多數情況下,通常不推薦*這種用法,因為它可能會在解釋器中引入瞭一組未知的名稱,而且通常會導致代碼可讀性變差。

給導入的模塊一個別名

# import module as m
import numpy as np
a = np.arange(100)

利用as給導入模塊一個別名,簡化代碼中的調用寫法。

單獨運行模塊

如果我們想單獨測試下模塊,可以在模塊中添加以下代碼,就可以既用作腳本,也可用作可導入模塊:

if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))

單獨運行模塊:

python fibo.py 100

這段解析命令行的代碼僅在模塊作為“主”文件執行時才運行。

加速模塊加載

為瞭加快模塊的加載速度,Python 會將每個模塊的編譯版本(如*.pyc)會緩存在__pycache__下的目錄中。生成編譯文件pyc的詳細過程,可以參考文檔PEP 3147。

Python 會根據編譯版本檢查源代碼的修改日期,以查看它是否已過期並需要重新編譯。

Python Packages包

Packages包可以理解為一組模塊的容器,並用Package.Module的方式來構建命名空間3。

以文件系統來類比的話,可以將包視為文件系統上的目錄,而將模塊視為目錄中的文件。4

例如,A.B指定的是在命名為B的包中命名為A的子模塊。

利用這樣的方法,可以避免一些多模塊的包之間命名發生沖突的問題,有點類似於C++中的std::string、cv::imread等命名空間的引用。

例如,這是一個官方的package例子,提供瞭關於聲音處理的sound包:

sound/                          Top-level package
      __init__.py               Initialize the sound package
      formats/                  Subpackage for file format conversions
              __init__.py
              wavread.py
              wavwrite.py
              ...
      effects/                  Subpackage for sound effects
              __init__.py
              echo.py
              ...
      filters/                  Subpackage for filters
              __init__.py
              equalizer.py
              ...
  • __init__.py 必須有這個文件,才能使 Python 將包含該文件的目錄視為包(Package)。__init__.py可以是一個空文件,也可以執行包的初始化代碼或設置__all__變量。
  • formats/ 、effects/ 、filters/ 是次一級的子包(Subpackage),每個子包中也有__init__.py 文件。
  • echo.py等文件是子包中的模塊(Module),模塊中可能包含函數、類或變量。

引用包(Package)中的模塊

from sound.effects import echo
echo.echofilter(input, output, delay=0.7, atten=4)

這種方式,可以直接引用函數,而不用加上前面包的前綴。

引用包(Package)中子模塊的函數或變量

from sound.effects.echo import echofilter
echofilter(input, output, delay=0.7, atten=4)

這種方式會加載子模塊echo,同時使子模塊中的 echofilter() 函數直接可用。

from package import item語句會先測試item是否在包中定義;如果包中沒有找到定義,會假定item是一個模塊並嘗試加載它。如果依舊找不到item, 就會引發我們常見的ImportError異常。

利用相對路徑引用包和模塊

from . import echo
from .. import formats
from ..filters import equalizer

這裡的.可以訪問同級目錄下的包(Package)或者模塊(Module)。
這裡的..可以訪問上一級目錄下的包(Package)或者模塊(Module)。

利用__all__提供包的顯式索引

當我們直接采用from sound.effects import *時,可能會引用一些不需要的內容,或者導致加載速度過慢。

這時我們可以通過在__init__.py中定義一個_all__列表,來指定用 * 時應導入的模塊名稱列表:

__all__ = ["echo", "surround", "reverse"]

這樣我們就可以維護在import * 時需要導入的模塊列表,在發佈不同版本的包時很有用。

打包自己的Package並分發

通過setuptool工具打包自己的Package,可以參考這兩篇文檔:

https://packaging.python.org/tutorials/packaging-projects/
如何添加必要的文件和結構來創建包、如何構建包以及如何將其上傳到Python Package Index。

https://packaging.python.org/guides/distributing-packages-using-setuptools/
介紹如何配置、打包和分發自己的 Python 項目的基礎知識。

安裝python社區中的Package

註意,在python社區中的Package,通常是指發行版的軟件包,而不是源代碼中一組模塊的容器(a container of modules)。

常見的包可以查看PyPI:https://pypi.org/,通過使用pip install來安裝社區提供的Packages。

總結

模塊化就是將相關代碼組織到不同層級的文件裡,便於復用,提高代碼的可讀性。

函數、變量、類存儲在被稱為模塊(Module)的.py文件中,一組模塊文件又組成瞭包(Package)。

引入Package包或Module模塊,可以用import …或from … import …,還可以通過相對路徑引用上一級的包和模塊。

本篇文章就到這裡瞭,希望能給你帶來幫助,也希望您能夠多多關註WalkonNet的更多內容!

推薦閱讀: