本章的主題就是模塊和包。較大的Python程序基本上都使用模塊和包進(jìn)行組織，Python發(fā)行版也包括方方面面許許多多的模塊...
1.1. 模塊
你可以使用import語(yǔ)句將一個(gè)源代碼文件作為模塊導(dǎo)入.例如:
使用import spam 語(yǔ)句就可以將這個(gè)文件作為模塊導(dǎo)入。系統(tǒng)在導(dǎo)入模塊時(shí)，要做以下三件事：
1. 為源代碼文件中定義的對(duì)象創(chuàng)建一個(gè)名字空間，通過(guò)這個(gè)名字空間可以訪問(wèn)到模塊中定義的函數(shù)及變量。 2.在新創(chuàng)建的名字空間里執(zhí)行源代碼文件. 3.創(chuàng)建一個(gè)名為源代碼文件的對(duì)象，該對(duì)象引用模塊的名字空間，這樣就可以通過(guò)這個(gè)對(duì)象訪問(wèn)模塊中的函數(shù)及變量，如：
- import spam # 導(dǎo)入并運(yùn)行模塊 spam
- print spam.a # 訪問(wèn)模塊 spam 的屬性
- spam.foo()
- c = spam.bar()
- ...
用逗號(hào)分割模塊名稱就可以同時(shí)導(dǎo)入多個(gè)模塊:
- import socket, os, regex
模塊導(dǎo)入時(shí)可以使用 as 關(guān)鍵字來(lái)改變模塊的引用對(duì)象名字:
- import os as system
- import socket as net, thread as threads
- system.chdir("..")
- net.gethostname()
使用from語(yǔ)句可以將模塊中的對(duì)象直接導(dǎo)入到當(dāng)前的名字空間. from語(yǔ)句不創(chuàng)建一個(gè)到模塊名字空間的引用對(duì)象，而是把被導(dǎo)入模塊的一個(gè)或多個(gè)對(duì)象直接放入當(dāng)前的名字空間:
- from socket import gethostname
- # 將gethostname放如當(dāng)前名字空間
- print gethostname() # 直接調(diào)用
- socket.gethostname() # 引發(fā)異常NameError: socket
from語(yǔ)句支持逗號(hào)分割的對(duì)象，也可以使用星號(hào)(*)代表模塊中除下劃線開頭的所有對(duì)象:
- from socket import gethostname, socket
- from socket import * # 載入所有對(duì)象到當(dāng)前名字空間
不過(guò)，如果一個(gè)模塊如果定義有列表__all__，則from module import * 語(yǔ)句只能導(dǎo)入__all__列表中存在的對(duì)象。
- # module: foo.py
- __all__ = [ 'bar', 'spam' ] # 定義使用 `*` 可以導(dǎo)入的對(duì)象
- from socket import gethostname as hostname
- h = hostname()
import 語(yǔ)句可以在程序的任何位置使用，你可以在程序中多次導(dǎo)入同一個(gè)模塊，但模塊中的代碼*僅僅*在該模塊被首次導(dǎo)入時(shí)執(zhí)行。后面的import語(yǔ)句只是簡(jiǎn)單的創(chuàng)建一個(gè)到模塊名字空間的引用而已。sys.modules字典中保存著所有被導(dǎo)入模塊的模塊名到模塊對(duì)象的映射。這個(gè)字典用來(lái)決定是否需要使用 import語(yǔ)句來(lái)導(dǎo)入一個(gè)模塊的最新拷貝.
from module import * 語(yǔ)句只能用于一個(gè)模塊的最頂層.*特別注意*：由于存在作用域沖突，不允許在函數(shù)中使用from 語(yǔ)句。
每個(gè)模塊都擁有 __name__ 屬性，它是一個(gè)內(nèi)容為模塊名字的字符串。最頂層的模塊名稱是 __main__ .命令行或是交互模式下程序都運(yùn)行在__main__ 模塊內(nèi)部. 利用__name__屬性，我們可以讓同一個(gè)程序在不同的場(chǎng)合（單獨(dú)執(zhí)行或被導(dǎo)入)具有不同的行為，象下面這樣做：
- # 檢查是單獨(dú)執(zhí)行還是被導(dǎo)入
- if __name__ == '__main__':
- # Yes
- statements
- else:
- # No (可能被作為模塊導(dǎo)入)
- statements
1.2. 模塊搜索路徑
導(dǎo)入模塊時(shí),解釋器會(huì)搜索sys.path列表,這個(gè)列表中保存著一系列目錄。一個(gè)典型的sys.path 列表的值：
Linux:
['', '/usr/local/lib/python2.0',
'/usr/local/lib/python2.0/plat-sunos5',
'/usr/local/lib/python2.0/lib-tk',
'/usr/local/lib/python2.0/lib-dynload',
'/usr/local/lib/python2.0/site-packages']
Windows:
['', 'C:\\WINDOWS\\system32\\python24.zip', 'C:\\Documents and Settings\\weizhong', 'C:\\Python24\\DLLs', 'C:\\Python24\\lib', 'C:\\Python24\\lib\\plat-win', 'C:\\Python24\\lib\\lib-tk', 'C:\\Python24\\Lib\\site-packages\\pythonwin', 'C:\\Python24', 'C:\\Python24\\lib\\site-packages', 'C:\\Python24\\lib\\site-packages\\win32', 'C:\\Python24\\lib\\site-packages\\win32\\lib', 'C:\\Python24\\lib\\site-packages\\wx-2.6-msw-unicode']
空字符串 代表當(dāng)前目錄. 要加入新的搜索路徑,只需要將這個(gè)路徑加入到這個(gè)列表.
1.3. 模塊導(dǎo)入和匯編
到現(xiàn)在為止，本章介紹的模塊都是包含Python源代碼的文本文件. 不過(guò)模塊不限于此，可以被 import 語(yǔ)句導(dǎo)入的模塊共有以下四類:
* 使用Python寫的程序( .py文件)
* C或C++擴(kuò)展(已編譯為共享庫(kù)或DLL文件)
* 包(包含多個(gè)模塊)
* 內(nèi)建模塊(使用C編寫并已鏈接到Python解釋器內(nèi))
當(dāng)查詢模塊 foo 時(shí),解釋器按照 sys.path 列表中目錄順序來(lái)查找以下文件(目錄也是文件的一種):
1. 定義為一個(gè)包的目錄 foo
2. foo.so, foomodule.so, foomodule.sl,或 foomodule.dll (已編譯擴(kuò)展)
3. foo.pyo (只在使用 -O 或 -OO 選項(xiàng)時(shí))
4. foo.pyc
5. foo.py
后面馬上介紹包
已編譯擴(kuò)展在附錄B:"Extending and Embedding Python."中有詳細(xì)描述.
對(duì)于.py文件,當(dāng)一個(gè)模塊第一次被導(dǎo)入時(shí),它就被匯編為字節(jié)代碼,并將字節(jié)碼寫入一個(gè)同名的 .pyc文件.后來(lái)的導(dǎo)入操作會(huì)直接讀取.pyc文件而不是.py文件.(除非.py文件的修改日期更新,這種情況會(huì)重新生成.pyc文件) 在解釋器使用 -O 選項(xiàng)時(shí)，擴(kuò)展名為.pyo的同名文件被使用. pyo文件的內(nèi)容雖去掉行號(hào),斷言,及其他調(diào)試信息的字節(jié)碼，體積更小,運(yùn)行速度更快.如果使用-OO選項(xiàng)代替-O,則文檔字符串也會(huì)在創(chuàng)建.pyo文件時(shí)也被忽略.
如果在sys.path提供的所有路徑均查找失敗,解釋器會(huì)繼續(xù)在內(nèi)建模塊中尋找,如果再次失敗，則引發(fā) ImportError 異常.
.pyc和.pyo文件的匯編,當(dāng)且僅當(dāng)import 語(yǔ)句執(zhí)行時(shí)進(jìn)行.
當(dāng) import 語(yǔ)句搜索文件時(shí),文件名是大小寫敏感的
即使在文件系統(tǒng)大小寫不敏感的系統(tǒng)上也是如此(Windows等). 這樣, import foo 只會(huì)導(dǎo)入文件foo.py而不會(huì)是FOO.PY. *注意*:Python的2.1之前的版本的,這個(gè)功能在某些平臺(tái)上會(huì)有問(wèn)題.要寫出兼容性好的程序,就避免在模塊名中大小定混用.
1.4. 重新導(dǎo)入模塊
如果更新了一個(gè)已經(jīng)用import語(yǔ)句導(dǎo)入的模塊，內(nèi)建函數(shù)reload()可以重新導(dǎo)入并運(yùn)行更新后的模塊代碼.它需要一個(gè)模塊對(duì)象做為參數(shù).例如:
- import foo
- ... some code ...
- reload(foo) # 重新導(dǎo)入 foo
在reload()運(yùn)行之后的針對(duì)模塊的操作都會(huì)使用新導(dǎo)入代碼，不過(guò)reload()并不會(huì)更新使用舊模塊創(chuàng)建的對(duì)象，因此有可能出現(xiàn)新舊版本對(duì)象共存的情況。 *注意* 使用C或C++編譯的模塊不能通過(guò) reload() 函數(shù)來(lái)重新導(dǎo)入。
記住一個(gè)原則，除非是在調(diào)試和開發(fā)過(guò)程中，否則不要使用reload()函數(shù).
1.5. 包
多個(gè)關(guān)系密切的模塊應(yīng)該組織成一個(gè)包，以便于維護(hù)和使用。這項(xiàng)技術(shù)能有效避免名字空間沖突。創(chuàng)建一個(gè)名字為包名字的文件夾并在該文件夾下創(chuàng)建一個(gè)__init__.py 文件就定義了一個(gè)包。你可以根據(jù)需要在該文件夾下存放資源文件、已編譯擴(kuò)展及子包。舉例來(lái)說(shuō)，一個(gè)包可能有以下結(jié)構(gòu):
Graphics/
__init__.py
Primitive/
__init__.py
lines.py
fill.py
text.py
...
Graph2d/
__init__.py
plot2d.py
...
Graph3d/
__init__.py
plot3d.py
...
Formats/
__init__.py
gif.py
png.py
tiff.py
jpeg.py
import語(yǔ)句使用以下幾種方式導(dǎo)入包中的模塊:
* import Graphics.Primitive.fill 導(dǎo)入模塊Graphics.Primitive.fill,只能以全名訪問(wèn)模塊屬性,例如 Graphics.Primitive.fill.floodfill(img,x,y,color).
* from Graphics.Primitive import fill 導(dǎo)入模塊fill ,只能以 fill.屬性名 這種方式訪問(wèn)模塊屬性,例如 fill.floodfill(img,x,y,color).
* from Graphics.Primitive.fill import floodfill 導(dǎo)入模塊fill ,并將函數(shù)floodfill放入當(dāng)前名稱空間,直接訪問(wèn)被導(dǎo)入的屬性，例如 floodfill(img,x,y,color).
無(wú)論一個(gè)包的哪個(gè)部分被導(dǎo)入, 在文件__init__.py中的代碼都會(huì)運(yùn)行.這個(gè)文件的內(nèi)容允許為空,不過(guò)通常情況下它用來(lái)存放包的初始化代碼。導(dǎo)入過(guò)程遇到的所有 __init__.py文件都被運(yùn)行.因此 import Graphics.Primitive.fill 語(yǔ)句會(huì)順序運(yùn)行 Graphics 和 Primitive 文件夾下的__init__.py文件.
下邊這個(gè)語(yǔ)句具有歧義:
from Graphics.Primitive import *
這個(gè)語(yǔ)句的原意圖是想將Graphics.Primitive包下的所有模塊導(dǎo)入到當(dāng)前的名稱空間.然而,由于不同平臺(tái)間文件名規(guī)則不同(比如大小寫敏感問(wèn)題), Python不能正確判定哪些模塊要被導(dǎo)入.這個(gè)語(yǔ)句只會(huì)順序運(yùn)行 Graphics 和 Primitive 文件夾下的__init__.py文件. 要解決這個(gè)問(wèn)題，應(yīng)該在Primitive文件夾下面的__init__.py中定義一個(gè)名字all的列表，例如:
- # Graphics/Primitive/__init__.py
- __all__ = ["lines","text","fill",...]
這樣,上邊的語(yǔ)句就可以導(dǎo)入列表中所有模塊.
下面這個(gè)語(yǔ)句只會(huì)執(zhí)行Graphics目錄下的__init__.py文件，而不會(huì)導(dǎo)入任何模塊:
- import Graphics
- Graphics.Primitive.fill.floodfill(img,x,y,color) # 失敗!
- 不過(guò)既然 import Graphics 語(yǔ)句會(huì)運(yùn)行 Graphics 目錄下的 init.py文件,我們就可以采取下面的手段來(lái)解決這個(gè)問(wèn)題：
- # Graphics/__init__.py
- import Primitive, Graph2d, Graph3d
- # Graphics/Primitive/__init__.py
- import lines, fill, text, ...
這樣import Graphics語(yǔ)句就可以導(dǎo)入所有的子模塊(只能用全名來(lái)訪問(wèn)這些模塊的屬性).
在一個(gè)包中，同一目錄下的兩個(gè)模塊可以互相引用而不需要提供包的名字.例如 Graphics.Primitive.fill模塊可以使用import lines導(dǎo)入Graphics.Primitive.lines . 不過(guò)如果兩個(gè)模塊位于同一個(gè)包的不同目錄,就必須提供包名.例如,如果Graphics.Graph2d的plot2d模塊需要使用 Graphics.Primitive下的lines模塊,就必須使用from Graphics.Primitive import lines這樣的語(yǔ)句.如果需要,一個(gè)模塊可以通過(guò) __name__ 屬性得到自己的全名.例如：下面的代碼在僅知道同級(jí)子包的名字情況下(不知道它們共同的頂級(jí)包名)導(dǎo)入該子包下的一個(gè)模塊。
- # Graphics/Graph2d/plot2d.py
- # 決定包的名稱,以及自身的位置
- import string
- base_package = string.join(string.split(__name__,'.')[:-2],'.')
- # 導(dǎo)入 ../Primitive/fill.py 模塊
- exec "from %s.Primitive import fill" % (base_package,)
最后,當(dāng)Python導(dǎo)入一個(gè)包時(shí),它定義了一個(gè)包含目錄列表的特殊變量__path__ ,它用于查找包的模塊(__path__與sys.path變量的作用相似). 可以在__init__.py文件中訪問(wèn)__path__變量.這個(gè)列表的初始值只有一個(gè)元素.即包的目錄.只要你覺(jué)得必要,一個(gè)包也可以到其他的目錄中去(在__path__增加要搜索的目錄)搜索模塊。(換言之，一個(gè)模塊可以屬于一個(gè)包，卻不位于這個(gè)包所在的目錄或子目錄下。
