10.4 將模塊分割成多個(gè)文件

問題

你想將一個(gè)模塊分割成多個(gè)文件。但是你不想將分離的文件統(tǒng)一成一個(gè)邏輯模塊時(shí)使已有的代碼遭到破壞。

解決方案

程序模塊可以通過變成包來分割成多個(gè)獨(dú)立的文件?？紤]下下面簡單的模塊：

# mymodule.py
class A:
    def spam(self):
        print('A.spam')

class B(A):
    def bar(self):
        print('B.bar')

假設(shè)你想mymodule.py分為兩個(gè)文件，每個(gè)定義的一個(gè)類。要做到這一點(diǎn)，首先用mymodule目錄來替換文件mymodule.py。 這這個(gè)目錄下，創(chuàng)建以下文件：

mymodule/
    __init__.py
    a.py
    b.py

在a.py文件中插入以下代碼：

# a.py
class A:
    def spam(self):
        print('A.spam')

在b.py文件中插入以下代碼：

# b.py
from .a import A
class B(A):
    def bar(self):
        print('B.bar')

最后，在 init.py 中，將2個(gè)文件粘合在一起：

# __init__.py
from .a import A
from .b import B

如果按照這些步驟，所產(chǎn)生的包MyModule將作為一個(gè)單一的邏輯模塊：

>>> import mymodule
>>> a = mymodule.A()
>>> a.spam()
A.spam
>>> b = mymodule.B()
>>> b.bar()
B.bar
>>>

討論

在這個(gè)章節(jié)中的主要問題是一個(gè)設(shè)計(jì)問題，不管你是否希望用戶使用很多小模塊或只是一個(gè)模塊。舉個(gè)例子，在一個(gè)大型的代碼庫中，你可以將這一切都分割成獨(dú)立的文件，讓用戶使用大量的import語句，就像這樣：

from mymodule.a import A
from mymodule.b import B
...

這樣能工作，但這讓用戶承受更多的負(fù)擔(dān)，用戶要知道不同的部分位于何處。通常情況下，將這些統(tǒng)一起來，使用一條import將更加容易，就像這樣：

from mymodule import A, B

對后者而言，讓mymodule成為一個(gè)大的源文件是最常見的。但是，這一章節(jié)展示了如何合并多個(gè)文件合并成一個(gè)單一的邏輯命名空間。 這樣做的關(guān)鍵是創(chuàng)建一個(gè)包目錄，使用 init.py 文件來將每部分粘合在一起。

當(dāng)一個(gè)模塊被分割，你需要特別注意交叉引用的文件名。舉個(gè)例子，在這一章節(jié)中，B類需要訪問A類作為基類。用包的相對導(dǎo)入 from .a import A 來獲取。

整個(gè)章節(jié)都使用包的相對導(dǎo)入來避免將頂層模塊名硬編碼到源代碼中。這使得重命名模塊或者將它移動(dòng)到別的位置更容易。（見10.3小節(jié)）

作為這一章節(jié)的延伸，將介紹延遲導(dǎo)入。如圖所示，init.py文件一次導(dǎo)入所有必需的組件的。但是對于一個(gè)很大的模塊，可能你只想組件在需要時(shí)被加載。 要做到這一點(diǎn)，init.py有細(xì)微的變化：

# __init__.py
def A():
    from .a import A
    return A()

def B():
    from .b import B
    return B()

在這個(gè)版本中，類A和類B被替換為在第一次訪問時(shí)加載所需的類的函數(shù)。對于用戶，這看起來不會(huì)有太大的不同。 例如：

>>> import mymodule
>>> a = mymodule.A()
>>> a.spam()
A.spam
>>>

延遲加載的主要缺點(diǎn)是繼承和類型檢查可能會(huì)中斷。你可能會(huì)稍微改變你的代碼，例如:

if isinstance(x, mymodule.A): # Error
...

if isinstance(x, mymodule.a.A): # Ok
...

延遲加載的真實(shí)例子, 見標(biāo)準(zhǔn)庫 multiprocessing/init.py 的源碼.