第八章 模塊和包
本章的主題就是模塊和包。較大的Python程序基本上都使用模塊和包進行組織,Python發行版也包括方方面面許許多多的模塊...python
模塊
你可使用import語句將一個源代碼文件做爲模塊導入.例如:socket
使用import spam 語句就能夠將這個文件做爲模塊導入。系統在導入模塊時,要作如下三件事:函數
- 爲源代碼文件中定義的對象建立一個名字空間,經過這個名字空間能夠訪問到模塊中定義的函數及變量。 2.在新建立的名字空間裏執行源代碼文件. 3.建立一個名爲源代碼文件的對象,該對象引用模塊的名字空間,這樣就能夠經過這個對象訪問模塊中的函數及變量,如:
用逗號分割模塊名稱就能夠同時導入多個模塊:spa
import socket, os, regex
模塊導入時可使用 as 關鍵字來改變模塊的引用對象名字:命令行
使用from語句能夠將模塊中的對象直接導入到當前的名字空間. from語句不建立一個到模塊名字空間的引用對象,而是把被導入模塊的一個或多個對象直接放入當前的名字空間:3d
from語句支持逗號分割的對象,也可使用星號(*)表明模塊中除下劃線開頭的全部對象:調試
不過,若是一個模塊若是定義有列表__all__,則from module import * 語句只能導入__all__列表中存在的對象。code
# module: foo.py
__all__ = [ 'bar', 'spam' ] # 定義使用 `*` 能夠導入的對象
另外, as 也能夠和 from 聯合使用:orm
import 語句能夠在程序的任何位置使用,你能夠在程序中屢次導入同一個模塊,但模塊中的代碼*僅僅*在該模塊被首次導入時執行。後面的import語句只是簡單的建立一個到模塊名字空間的引用而已。sys.modules字典中保存着全部被導入模塊的模塊名到模塊對象的映射。這個字典用來決定是否須要使用import語句來導入一個模塊的最新拷貝.對象
from module import * 語句只能用於一個模塊的最頂層.*特別注意*:因爲存在做用域衝突,不容許在函數中使用from 語句。
每一個模塊都擁有 __name__ 屬性,它是一個內容爲模塊名字的字符串。最頂層的模塊名稱是 __main__ .命令行或是交互模式下程序都運行在__main__ 模塊內部. 利用__name__屬性,咱們可讓同一個程序在不一樣的場合(單獨執行或被導入)具備不一樣的行爲,象下面這樣作:
# 檢查是單獨執行仍是被導入
if __name__ == '__main__': # Yes statements else: # No (可能被做爲模塊導入) statements
模塊搜索路徑
導入模塊時,解釋器會搜索sys.path列表,這個列表中保存着一系列目錄。一個典型的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']
空字符串 表明當前目錄. 要加入新的搜索路徑,只須要將這個路徑加入到這個列表.
模塊導入和彙編
到如今爲止,本章介紹的模塊都是包含Python源代碼的文本文件. 不過模塊不限於此,能夠被 import 語句導入的模塊共有如下四類:
- 使用Python寫的程序( .py文件)
- C或C++擴展(已編譯爲共享庫或DLL文件)
- 包(包含多個模塊)
- 內建模塊(使用C編寫並已連接到Python解釋器內)
當查詢模塊 foo 時,解釋器按照 sys.path 列表中目錄順序來查找如下文件(目錄也是文件的一種):
- 定義爲一個包的目錄 foo
- foo.so, foomodule.so, foomodule.sl,或 foomodule.dll (已編譯擴展)
- foo.pyo (只在使用 -O 或 -OO 選項時)
- foo.pyc
- foo.py
後面立刻介紹包
已編譯擴展在附錄B:"Extending and Embedding Python."中有詳細描述.
對於.py文件,當一個模塊第一次被導入時,它就被彙編爲字節代碼,並將字節碼寫入一個同名的 .pyc文件.後來的導入操做會直接讀取.pyc文件而不是.py文件.(除非.py文件的修改日期更新,這種狀況會從新生成.pyc文件) 在解釋器使用 -O 選項時,擴展名爲.pyo的同名文件被使用. pyo文件的內容雖去掉行號,斷言,及其餘調試信息的字節碼,體積更小,運行速度更快.若是使用-OO選項代替-O,則文檔字符串也會在建立.pyo文件時也被忽略.
若是在sys.path提供的全部路徑均查找失敗,解釋器會繼續在內建模塊中尋找,若是再次失敗,則引起 ImportError 異常.
.pyc和.pyo文件的彙編,當且僅當import 語句執行時進行.
當 import 語句搜索文件時,文件名是大小寫敏感的
即便在文件系統大小寫不敏感的系統上也是如此(Windows等). 這樣, import foo 只會導入文件foo.py而不會是FOO.PY. *注意*:Python的2.1以前的版本的,這個功能在某些平臺上會有問題.要寫出兼容性好的程序,就避免在模塊名中大小定混用.
從新導入模塊
若是更新了一個已經用import語句導入的模塊,內建函數reload()能夠從新導入並運行更新後的模塊代碼.它須要一個模塊對象作爲參數.例如:
在reload()運行以後的針對模塊的操做都會使用新導入代碼,不過reload()並不會更新使用舊模塊建立的對象,所以有可能出現新舊版本對象共存的狀況。 *注意* 使用C或C++編譯的模塊不能經過 reload() 函數來從新導入。
記住一個原則,除非是在調試和開發過程當中,不然不要使用reload()函數.
包
多個關係密切的模塊應該組織成一個包,以便於維護和使用。這項技術能有效避免名字空間衝突。建立一個名字爲包名字的文件夾並在該文件夾下建立一個__init__.py 文件就定義了一個包。你能夠根據須要在該文件夾下存放資源文件、已編譯擴展及子包。舉例來講,一個包可能有如下結構:
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語句使用如下幾種方式導入包中的模塊:
* import Graphics.Primitive.fill 導入模塊Graphics.Primitive.fill,只能以全名訪問模塊屬性,例如 Graphics.Primitive.fill.floodfill(img,x,y,color).
* from Graphics.Primitive import fill 導入模塊fill ,只能以 fill.屬性名 這種方式訪問模塊屬性,例如 fill.floodfill(img,x,y,color).
* from Graphics.Primitive.fill import floodfill 導入模塊fill ,並將函數floodfill放入當前名稱空間,直接訪問被導入的屬性,例如 floodfill(img,x,y,color).
不管一個包的哪一個部分被導入, 在文件__init__.py中的代碼都會運行.這個文件的內容容許爲空,不過一般狀況下它用來存放包的初始化代碼。導入過程遇到的全部 __init__.py文件都被運行.所以 import Graphics.Primitive.fill 語句會順序運行 Graphics 和 Primitive 文件夾下的__init__.py文件.
下邊這個語句具備歧義:
from Graphics.Primitive import *
這個語句的原意圖是想將Graphics.Primitive包下的全部模塊導入到當前的名稱空間.然而,因爲不一樣平臺間文件名規則不一樣(好比大小寫敏感問題), Python不能正確斷定哪些模塊要被導入.這個語句只會順序運行 Graphics 和 Primitive 文件夾下的__init__.py文件. 要解決這個問題,應該在Primitive文件夾下面的__init__.py中定義一個名字all的列表,例如:
這樣,上邊的語句就能夠導入列表中全部模塊.
下面這個語句只會執行Graphics目錄下的__init__.py文件,而不會導入任何模塊:
不過既然 import Graphics 語句會運行 Graphics 目錄下的 init.py文件,咱們就能夠採起下面的手段來解決這個問題:
這樣import Graphics語句就能夠導入全部的子模塊(只能用全名來訪問這些模塊的屬性).
在一個包中,同一目錄下的兩個模塊能夠互相引用而不須要提供包的名字.例如 Graphics.Primitive.fill模塊可使用import lines導入Graphics.Primitive.lines . 不過若是兩個模塊位於同一個包的不一樣目錄,就必須提供包名.例如,若是Graphics.Graph2d的plot2d模塊須要使用Graphics.Primitive下的lines模塊,就必須使用from Graphics.Primitive import lines這樣的語句.若是須要,一個模塊能夠經過 __name__ 屬性獲得本身的全名.例如:下面的代碼在僅知道同級子包的名字狀況下(不知道它們共同的頂級包名)導入該子包下的一個模塊。
最後,當Python導入一個包時,它定義了一個包含目錄列表的特殊變量__path__ ,它用於查找包的模塊(__path__與sys.path變量的做用類似). 能夠在__init__.py文件中訪問__path__變量.這個列表的初始值只有一個元素.即包的目錄.只要你以爲必要,一個包也能夠到其餘的目錄中去(在__path__增長要搜索的目錄)搜索模塊。(換言之,一個模塊能夠屬於一個包,卻不位於這個包所在的目錄或子目錄下。