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

引言

在剛?cè)腴T(mén)python時(shí)，模塊化編程、模塊、類庫(kù)等術(shù)語(yǔ)常常并不容易理清。尤其是Modules（模塊）和Packages（包），在import引用時(shí)很容易混淆出錯(cuò)。

實(shí)際上，Python中的函數(shù)(Function)、類(Class)、模塊(Module)、包庫(kù)(Package)，都是為了實(shí)現(xiàn)模塊化引用，讓程序的組織更清晰有條理。

• 通常，函數(shù)、變量、類存儲(chǔ)在被稱為模塊(Module)的.py文件中，一組模塊文件又組成了包(Package)。
• 將函數(shù)、變量、類存儲(chǔ)在存儲(chǔ)在獨(dú)立的.py文件中，可隱藏代碼實(shí)現(xiàn)的細(xì)節(jié)，將不同代碼塊重新組織，與主程序分離，簡(jiǎn)化主程序的邏輯，提高主程序的可讀性。
• 有了包和模塊文件，可以在其他不同程序中進(jìn)行復(fù)用，還可以使用其他人開(kāi)發(fā)的第三方依賴庫(kù)。

Python Modules模塊

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

在模塊內(nèi)，模塊的名稱可以用全局變量 __name__表示（字符串）。

舉個(gè)例子，我們創(chuàng)建了一個(gè)fibo.py文件，文件內(nèi)容為：

# 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就是一個(gè)模塊，fib、fib2是fibo模塊中的函數(shù)。

導(dǎo)入模塊

如果我們想要在其他程序中使用fibo模塊，可以有以下三種方式導(dǎo)入：

①導(dǎo)入整個(gè)模塊

#import module_name
import fibo

可使用下面的語(yǔ)法來(lái)使用其中任何一個(gè)函數(shù)：

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

⭕ 注意：這里模塊名+句點(diǎn)不可省略。

②導(dǎo)入模塊中的特定函數(shù)

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

若使用這種語(yǔ)法，調(diào)用函數(shù)時(shí)就無(wú)需使用模塊名+句點(diǎn)。

因?yàn)樵趇mport語(yǔ)句中已經(jīng)顯式地導(dǎo)入了函數(shù)fib和fib2，因此調(diào)用它時(shí)只需指定其名稱。

③導(dǎo)入模塊中的所有函數(shù)

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

這種方式會(huì)導(dǎo)入除可下劃線 (__)開(kāi)頭的名稱以外的所有函數(shù)。

⭕ 注意：在大多數(shù)情況下，通常不推薦*這種用法，因?yàn)樗赡軙?huì)在解釋器中引入了一組未知的名稱，而且通常會(huì)導(dǎo)致代碼可讀性變差。

給導(dǎo)入的模塊一個(gè)別名

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

利用as給導(dǎo)入模塊一個(gè)別名，簡(jiǎn)化代碼中的調(diào)用寫(xiě)法。

單獨(dú)運(yùn)行模塊

如果我們想單獨(dú)測(cè)試下模塊，可以在模塊中添加以下代碼，就可以既用作腳本，也可用作可導(dǎo)入模塊：

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

單獨(dú)運(yùn)行模塊：

python fibo.py 100

這段解析命令行的代碼僅在模塊作為“主”文件執(zhí)行時(shí)才運(yùn)行。

加速模塊加載

為了加快模塊的加載速度，Python 會(huì)將每個(gè)模塊的編譯版本（如*.pyc）會(huì)緩存在__pycache__下的目錄中。生成編譯文件pyc的詳細(xì)過(guò)程，可以參考文檔PEP 3147。

Python 會(huì)根據(jù)編譯版本檢查源代碼的修改日期，以查看它是否已過(guò)期并需要重新編譯。

Python Packages包

Packages包可以理解為一組模塊的容器，并用Package.Module的方式來(lái)構(gòu)建命名空間3。

以文件系統(tǒng)來(lái)類比的話，可以將包視為文件系統(tǒng)上的目錄，而將模塊視為目錄中的文件。4

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

利用這樣的方法，可以避免一些多模塊的包之間命名發(fā)生沖突的問(wèn)題，有點(diǎn)類似于C++中的std::string、cv::imread等命名空間的引用。

例如，這是一個(gè)官方的package例子，提供了關(guān)于聲音處理的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 必須有這個(gè)文件，才能使 Python 將包含該文件的目錄視為包（Package）。__init__.py可以是一個(gè)空文件，也可以執(zhí)行包的初始化代碼或設(shè)置__all__變量。
• formats/ 、effects/ 、filters/ 是次一級(jí)的子包（Subpackage），每個(gè)子包中也有__init__.py 文件。
• echo.py等文件是子包中的模塊（Module），模塊中可能包含函數(shù)、類或變量。

引用包（Package）中的模塊

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

這種方式，可以直接引用函數(shù)，而不用加上前面包的前綴。

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

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

這種方式會(huì)加載子模塊echo，同時(shí)使子模塊中的 echofilter() 函數(shù)直接可用。

from package import item語(yǔ)句會(huì)先測(cè)試item是否在包中定義；如果包中沒(méi)有找到定義，會(huì)假定item是一個(gè)模塊并嘗試加載它。如果依舊找不到item， 就會(huì)引發(fā)我們常見(jiàn)的ImportError異常。

利用相對(duì)路徑引用包和模塊

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

這里的.可以訪問(wèn)同級(jí)目錄下的包（Package）或者模塊（Module）。
這里的..可以訪問(wèn)上一級(jí)目錄下的包（Package）或者模塊（Module）。

利用__all__提供包的顯式索引

當(dāng)我們直接采用from sound.effects import *時(shí)，可能會(huì)引用一些不需要的內(nèi)容，或者導(dǎo)致加載速度過(guò)慢。

這時(shí)我們可以通過(guò)在__init__.py中定義一個(gè)_all__列表，來(lái)指定用 * 時(shí)應(yīng)導(dǎo)入的模塊名稱列表：

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

這樣我們就可以維護(hù)在import * 時(shí)需要導(dǎo)入的模塊列表，在發(fā)布不同版本的包時(shí)很有用。

打包自己的Package并分發(fā)

通過(guò)setuptool工具打包自己的Package，可以參考這兩篇文檔：

https://packaging.python.org/tutorials/packaging-projects/
如何添加必要的文件和結(jié)構(gòu)來(lái)創(chuàng)建包、如何構(gòu)建包以及如何將其上傳到Python Package Index。

https://packaging.python.org/guides/distributing-packages-using-setuptools/
介紹如何配置、打包和分發(fā)自己的 Python 項(xiàng)目的基礎(chǔ)知識(shí)。

安裝python社區(qū)中的Package

注意，在python社區(qū)中的Package，通常是指發(fā)行版的軟件包，而不是源代碼中一組模塊的容器（a container of modules）。

常見(jiàn)的包可以查看PyPI：https://pypi.org/，通過(guò)使用pip install來(lái)安裝社區(qū)提供的Packages。

總結(jié)

模塊化就是將相關(guān)代碼組織到不同層級(jí)的文件里，便于復(fù)用，提高代碼的可讀性。

函數(shù)、變量、類存儲(chǔ)在被稱為模塊(Module)的.py文件中，一組模塊文件又組成了包(Package)。

引入Package包或Module模塊，可以用import …或from … import …，還可以通過(guò)相對(duì)路徑引用上一級(jí)的包和模塊。

本篇文章就到這里了，希望能給你帶來(lái)幫助，也希望您能夠多多關(guān)注腳本之家的更多內(nèi)容！