前言

在Python中，一個(gè).py文件代表一個(gè)Module。在Module中可以是任何的符合Python文件格式的Python腳本。了解Module導(dǎo)入機(jī)制大有用處。

1. Module組成

一個(gè).py文件就是一個(gè)module。Module中包括attribute, function等。 這里說的attribute其實(shí)是module的global variable。

我們創(chuàng)建1個(gè)test1.py文件，代碼如下

# 定義1個(gè)全局變量a
a = 1
# 聲明一個(gè)全局變量moduleName
global moduleName


# 定義一個(gè)函數(shù)printModuleName
def printModuleName():
    print(a + 2)
    print(__name__)
    print(moduleName)

print(dir())

這里我們定義了3個(gè)全局變量a、moduleName、printModuleName，除了我們自己定義的以外還有module內(nèi)置的全局變量

1.1 Module 內(nèi)置全局變量

上面我們說到了，每一個(gè)模塊都有內(nèi)置的全局變量，我們可以使用dir()函數(shù)，用于查看模塊內(nèi)容，例如上面的例子中，使用dir()查看結(jié)果如下：

['__annotations__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'a', 'moduleName', 'printModuleName']

其中a, moduleName, printModuleName 是由用戶自定義的。其他的全是內(nèi)置的。下面介紹幾個(gè)常用的內(nèi)置全局變量

1.1.1?__name__

指的是當(dāng)前模塊的名稱，比如上面的test1.py，模塊的名稱默認(rèn)就是test1，如果一個(gè)module是程序的入口，那么__name__=__'main'__，這也是我們經(jīng)常看到用到的

1.1.2?__builtins__

它就是內(nèi)置模塊builtins的引用。可以通過如下代碼測(cè)試：

import builtins
print(builtins == __builtins__)

打印結(jié)果為True，在Python代碼里，不需要我們導(dǎo)入就能直接使用的函數(shù)、類等，都是在這個(gè)內(nèi)置模塊里的。例如：range、dir?

1.1.3?__doc__

它就是module的文檔說明，具體是文件頭之后、代碼（包含import）之前的第一個(gè)多行注釋，測(cè)試如下

"""
模塊導(dǎo)入機(jī)制測(cè)試
"""


import builtins


# 定義1個(gè)全局變量a
a = 1
# 聲明一個(gè)全局變量moduleName
global moduleName


# 定義一個(gè)函數(shù)printModuleName
def printModuleName():
    print(a + 2)
    print(__name__)
    print(moduleName)


print(__doc__)

最后打印結(jié)果為

模塊導(dǎo)入機(jī)制測(cè)試

當(dāng)然如果你想查看某個(gè)方法的說明，也可以這么使用

1.1.4?__file__

當(dāng)前module所在的文件的絕對(duì)路徑

1.1.5?__package__

當(dāng)前module所在的包名。如果沒有，為None。

2. 包package

為避免模塊名沖突，Python引入了按目錄組織模塊的方法，稱之為包（package）。包是含有Python模塊的文件夾。

當(dāng)一個(gè)文件夾下有init.py時(shí)，意為該文件夾是一個(gè)包（package），其下的多個(gè)模塊（module）構(gòu)成一個(gè)整體，而這些模塊（module）都可通過同一個(gè)包（package）導(dǎo)入其他代碼中。

其中init.py文件用于組織包（package），方便管理各個(gè)模塊之間的引用、控制著包的導(dǎo)入行為。

該文件可以什么內(nèi)容都不寫，即為空文件，存在即可，相當(dāng)于一個(gè)標(biāo)記。

但若想使用from pacakge_1 import *這種形式的寫法，需在init.py中加上：__all__ = ['file_a', 'file_b']，并且package_1下有file_a.py和file_b.py，在導(dǎo)入時(shí)init.py文件將被執(zhí)行。

但不建議在init.py中寫模塊，以保證該文件簡(jiǎn)單。不過可在init.py導(dǎo)入我們需要的模塊，以便避免一個(gè)個(gè)導(dǎo)入、方便使用。

其中，__all__是一個(gè)重要的變量，用來指定此包（package）被import *時(shí)，哪些模塊（module）會(huì)被import進(jìn)【當(dāng)前作用域中】。不在__all__列表中的模塊不會(huì)被其他程序引用。可以重寫__all__，如__all__=?['當(dāng)前所屬包模塊1名字', '模塊1名字']，如果寫了這個(gè)，則會(huì)按列表中的模塊名進(jìn)行導(dǎo)入

在模糊導(dǎo)入時(shí)，形如from package import *，*是由__all__定義的。

當(dāng)我們?cè)趯?dǎo)入一個(gè)包（package）時(shí)（會(huì)先加載__init__.py定義的引入模塊，然后再運(yùn)行其他代碼），實(shí)際上是導(dǎo)入的它的__init__.py文件（導(dǎo)入時(shí)，該文件自動(dòng)運(yùn)行，助我們一下導(dǎo)入該包中的多個(gè)模塊）。我們可以在 init.py中再導(dǎo)入其他的包（package）或模塊或自定義類。

2.1 實(shí)戰(zhàn)案例

首先我們創(chuàng)建3個(gè)包，分別是test、test2、test3test包下創(chuàng)建test1.py用來執(zhí)行測(cè)試

test2包下創(chuàng)建file_a.py、file_b.py，用來測(cè)試包的導(dǎo)入

test3包下創(chuàng)建file_c.py，輔助測(cè)試

具體結(jié)構(gòu)如下：

核心代碼在test2/__init__.py中如下

__all__ = ['file_a', 'file_b', 'file_c', 'test_d']


from test3 import file_c


def test_d():
    return "test_d"

解釋下，當(dāng)我們?cè)?code>test/test1.py中寫了from test2 import *這句代碼，程序不是直接導(dǎo)入test2下的所有模塊，而是導(dǎo)入__init__.py文件并自動(dòng)運(yùn)行，由于我們寫了__all__ = ['file_a', 'file_b', 'file_c', 'test_d']，file_a和file_b是當(dāng)下包中的模塊，file_c是我們從test3包中導(dǎo)入的，test_d是__init__.py下我們定義的函數(shù)。

所以from test2 import *就是把__all__中指定的模塊和函數(shù)導(dǎo)入進(jìn)來了，接著我們查看test1.py下的代碼

from test2 import *
print(file_a.a())
print(file_b.b())
print(file_c.c())
print(test_d())

如果打印有結(jié)果，則證明了導(dǎo)入成功，并且導(dǎo)入的是__all__下的模塊和函數(shù)

3.sys.modules、命名空間

3.1 sys.modules

sys.modules是一個(gè)將模塊名稱映射到已加載的模塊的字典。可用來強(qiáng)制重新加載modules。Python一啟動(dòng)，它將被加載在內(nèi)存中。

當(dāng)我們導(dǎo)入新modules，sys.modules將自動(dòng)記錄下該module；當(dāng)?shù)诙卧賹?dǎo)入該module時(shí)，Python將直接到字典中查找，加快運(yùn)行速度。

它是1個(gè)字典，故擁有字典的一切方法，如sys.modules.keys()、sys.modules.values()、sys.modules['os']。但請(qǐng)不要輕易替換字典、或從字典中刪除某元素，將可能導(dǎo)致Python運(yùn)行失敗。

3.2 命名空間

命名空間就像一個(gè)dict，key是變量名字，value是變量的值。

• 每個(gè)函數(shù)function都有自己的命名空間，稱local namespace，記錄函數(shù)的變量。
• 每個(gè)模塊module都有自己的命名空間，稱global namespace，記錄模塊的變量，包括functions、classes、導(dǎo)入的modules、module級(jí)別的變量和常量。
• build-in命名空間，它包含build-in function和exceptions，可被任意模塊訪問。

假設(shè)你要訪問某段Python代碼中的變量x時(shí)，Python會(huì)在所有的命名空間中查找該變量，順序是：

• local namespace 即當(dāng)前函數(shù)或類方法。若找到，則停止搜索；
• global namespace 即當(dāng)前模塊。若找到，則停止搜索；
• build-in namespace Python會(huì)假設(shè)變量x是build-in的內(nèi)置函數(shù)或變量。若變量x不是build-in的內(nèi)置函數(shù)或變量，Python將報(bào)錯(cuò)NameError。
• 對(duì)于閉包，若在local namespace找不到該變量，則下一個(gè)查找目標(biāo)是父函數(shù)的local namespace。

我們可以看一個(gè)小例子

# test_namespace.py
def func(a=1):
    b = 2
    print(locals())  # 打印當(dāng)前函數(shù)的局部命名空間
    '''
    locs = locals()  # 只讀，不可寫，會(huì)報(bào)錯(cuò)
    locs['c'] = 3
    print(c)
    '''
    return a + b


func()
glos = globals()
glos['d'] = 4
print(d)
print(globals())

執(zhí)行func()會(huì)打印函數(shù)func的局部命名空間，結(jié)果如下：

{'a': 1, 'b': 2}

執(zhí)行print(globals())會(huì)打印模塊test_namespace的全局命名空間，結(jié)果如下：

{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <_frozen_importlib_external.SourceFileLoader object at 0x7fde2605c730>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__file__': '/Users/jkc/PycharmProjects/pythonProject1/test_namespace.py', '__cached__': None, 'func': <function func at 0x7fde246b9310>, 'glos': {...}, 'd': 4}

內(nèi)置函數(shù)locals()、globals()都會(huì)返回一個(gè)字典。區(qū)別：前者只讀、后者可寫。

命名空間在from module_name import、import module_name中的體現(xiàn)：from關(guān)鍵詞是導(dǎo)入模塊或包中的某個(gè)部分。

from module_A import X：會(huì)將該模塊的函數(shù)/變量導(dǎo)入到當(dāng)前模塊的命名空間中，無須用module_A.X訪問了。

import module_A：modules_A本身被導(dǎo)入，但保存它原有的命名空間，故得用module_A.X方式訪問其函數(shù)或變量。

接下來我們測(cè)試一下：

可以看到我們導(dǎo)入了函數(shù)a和模塊file_c，接著我們打印了全局變量，結(jié)果如下：

{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <_frozen_importlib_external.SourceFileLoader object at 0x7fab9585c730>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__file__': '/Users/jkc/PycharmProjects/pythonProject1/test3/test_namespace.py', '__cached__': None, 'a': <function a at 0x7fab95b04040>, 'file_c': <module 'file_c' from '/Users/jkc/PycharmProjects/pythonProject1/test3/file_c.py'>}

可以很清楚的看到全局變量中有函數(shù)a和模塊file_c，接著我們嘗試能否調(diào)用者2個(gè)

from test2.file_a import a
import file_c


print(globals())


file_c.c()
a()

最后也是可以成功調(diào)用

4. 導(dǎo)入

準(zhǔn)備工作如下：

4.1 絕對(duì)導(dǎo)入

所有的模塊import都從“根節(jié)點(diǎn)”開始。根節(jié)點(diǎn)的位置由sys.path中的路徑?jīng)Q定，項(xiàng)目的根目錄一般自動(dòng)在sys.path中。如果希望程序能處處執(zhí)行，需手動(dòng)修改sys.path。

例1：c.py中導(dǎo)入B包/B1子包/b1.py模塊

import os
import sys


BASE_DIR = os.path.dirname(os.path.abspath(__file__))
sys.path.append(BASE_DIR)

# 導(dǎo)入B包中的子包B1中的模塊b1
from B.B1 import b1

例2：b1.py中導(dǎo)入b2.py模塊

# 從B包中的子包B1中導(dǎo)入模塊b2
from B.B1 import b2

4.2 相對(duì)導(dǎo)入

只關(guān)心相對(duì)自己當(dāng)前目錄的模塊位置就好。不能在包（package）的內(nèi)部直接執(zhí)行（會(huì)報(bào)錯(cuò)）。不管根節(jié)點(diǎn)在哪兒，包內(nèi)的模塊相對(duì)位置都是正確的。

b1.py代碼如下：

# from . import b2  # 這種導(dǎo)入方式會(huì)報(bào)錯(cuò)
import b2  # 正確
b2.print_b2()

b2.py代碼如下：

def print_b2():
    print('b2')

最后運(yùn)行b1.py，打印b2。

4.3 單獨(dú)導(dǎo)入包

單獨(dú)import某個(gè)包名稱時(shí)，不會(huì)導(dǎo)入該包中所包含的所有子模塊。

c.py導(dǎo)入同級(jí)目錄B包的子包B1包的b2模塊，執(zhí)行b2模塊的print_b2()方法：

c.py代碼

import B
B.B1.b2.print_b2()

運(yùn)行c.py會(huì)以下錯(cuò)誤

AttributeError: module 'B' has no attribute 'B1'

因?yàn)?code>import B并不會(huì)自動(dòng)將B下的子模塊導(dǎo)入進(jìn)去，需要手動(dòng)添加，解決辦法如下

在B/init.py代碼下添加如下代碼

from . import B1

在B/B1/init.py代碼下添加如下代碼

from . import b2

此時(shí)，執(zhí)行c.py，成功打印b2。

5. import運(yùn)行機(jī)制

我們要理解Python在執(zhí)行import語句時(shí)，進(jìn)行了啥操作？

step1：創(chuàng)建一個(gè)新的、空的module對(duì)象（它可能包含多個(gè)module）；

step2：將該module對(duì)象 插入sys.modules中；

step3：裝載module的代碼（如果需要，需先編譯）；

step4：執(zhí)行新的module中對(duì)應(yīng)的代碼。

在執(zhí)行step3時(shí)，首先需找到module程序所在的位置，如導(dǎo)入的module名字為mod_1，則解釋器得找到mod_1.py文件，搜索順序是：

當(dāng)前路徑（或當(dāng)前目錄指定sys.path）->PYTHONPATH->Python安裝設(shè)置相關(guān)的默認(rèn)路徑。

對(duì)于不在sys.path中，一定要避免用import導(dǎo)入自定義包（package）的子模塊（module），而要用from…import…的絕對(duì)導(dǎo)入或相對(duì)導(dǎo)入，且包（package）的相對(duì)導(dǎo)入只能用from形式。

5.1 標(biāo)準(zhǔn)import，頂部導(dǎo)入

5.2 嵌套import

5.2.1 順序?qū)?import

• moduleB定義了變量b=2
• moduleA導(dǎo)入模塊moduleB，當(dāng)然moduleB還可以導(dǎo)入其他模塊
• test模塊導(dǎo)入moduleA

最后執(zhí)行test.py，將打印3

5.2.2 循環(huán)導(dǎo)入/嵌套導(dǎo)入

moduleA.py

from moduleB import ClassB


class ClassA:
    pass

moduleB.py

from moduleA import ClassA


class ClassB:
    pass

當(dāng)執(zhí)行moduleA.py時(shí)會(huì)報(bào)錯(cuò)

ImportError: cannot import name 'ClassA' from partially initialized module 'moduleA'

報(bào)錯(cuò)分析：

1.在運(yùn)行moduleA時(shí)，首選會(huì)執(zhí)行from moduleB import ClassB代碼

2.程序會(huì)判斷sys.modules中是否有

3.有代表字在第一次執(zhí)行時(shí)，創(chuàng)建的對(duì)象已經(jīng)緩存在sys.modules，直接得到，不過依然是空對(duì)象，因?yàn)?code>__dict__找不到ClassB，會(huì)報(bào)錯(cuò)

4.沒有會(huì)為moduleB.py創(chuàng)建1個(gè)module對(duì)象，此時(shí)創(chuàng)建的module對(duì)象為空

• 4.1 然后執(zhí)行moduleB.py的第一條語句from moduleA import ClassAPS：這么做的原因是python內(nèi)部創(chuàng)建了module對(duì)象后立馬執(zhí)行moduleB.py，目的是填充<module moduleB>的__dict__，當(dāng)然最終未能成功填充
• 4.2 接著判斷sys.modules中是否有
• 4.3 沒有會(huì)為moduleA.py創(chuàng)建1個(gè)module對(duì)象

PS：此時(shí)創(chuàng)建的module對(duì)象同樣為空，則需要執(zhí)行moduleA.py語句from moduleB import ClassB

5.最后回到操作2的過程，這次判斷有module對(duì)象，會(huì)進(jìn)行操作3，最后就會(huì)報(bào)錯(cuò)cannot import name 'ClassA'

解決辦法：組織代碼（重構(gòu)代碼）：更改代碼布局，可合并或分離競(jìng)爭(zhēng)資源。