本文和大家分享的主要是python中包與模塊相關內容,一起來看看吧,希望對大家學習python有所幫助。
摘要
1. 為重用以及更好的維護代碼, Python 使用了模塊與包;一個 Python 文件就是一個模塊,包是組織模塊的特殊目錄(包含 __init__.py 文件)。
2. 模塊搜索路徑, Python 解釋器在特定的目錄中搜索模塊,運行時 sys.path 即搜索路徑。
3. 使用 import 關鍵字導入模塊,注意 import * 與 __all__ 的關系。
1. 模塊與導入
A module is a file containing Python definitions and statements
Python 模塊就是包含定義以及語句的文件,文件名是模塊的名字加上 .py 后綴。
1.1 為重用而生
假設有一個完成特定功能,很好用的函數(shù)或者類。為了使用這個功能,不得不把這段代碼復制到需要使用的每一個文件中。重復代碼是編程的大忌,如果功能實現(xiàn)需要修改,會不得不修改每一個出現(xiàn)的地方,這是反人類的。
重用能夠很好的解決這一問題,實際上,函數(shù),類等結構在一定程度上也為重用提供了便利。
Python 中,將一系列相關的函數(shù),類等組織在一個文件中,每一個文件都是一個 Python 模塊。
1.2 導入模塊
使用 import 關鍵字導入模塊(模塊需在搜索路徑中):
1. import sys;基礎導入語句。
2. import sys as system;為導入的名字起別名。
3. from sys import path;導入模塊特定元素。
4. from sys import *;從sys中導入全部可導入名字
import-only-once
模塊只導入一次這種行為在大多數(shù)情況下是一種實質性的優(yōu)化,在同一個解釋器生命周期內,多次使用 import 語句導入同一個模塊,導入只發(fā)生一次。
這一點可以在模塊中加入輸出語句證明。
import * 與 __all__
使用 import * 可能會污染當前模塊的名字空間,導入了一些不需要引用的名字。因此不推薦使用。
事實上,規(guī)范的第三方模塊會提供一個模塊公共接口,暴露該模塊可用的接口。公共接口由模塊名為 __all__ 的列表定義。
如定義名為 mtest1 的模塊:
__all__ = ['test1', 'test12']
def test1():
print('test1')
def test11():
print('test11')
def test12():
print('test12')
使用全部導入的方式:
>>> form mtest1 import *
>>> dir()
>>> ['__annotations__', '__builtins__', '__doc__', '__loader__','__name__', '__package__', '__spec__', 'test1', 'test12']
可以看到函數(shù) test11() 并沒有被導入,這就是 __all__ 的作用了。
2. 包與其構建
為了更好組織模塊,將模塊分組為包(package)。
2.1 包是特殊模塊
從文件系統(tǒng)上看,包就是模塊所在目錄。為使 Python 解釋器將其區(qū)別普通目錄作為包看待,包中必須直接包含一個名為 __init__.py 的文件(模塊)。
包基本上就是另外一類模塊,不同的地方在于包能包含其他模塊與包。包作為一個模塊,其內容其實就是文件 __init__.py (模塊)的內容。
如名為 constants 的包,文件 constants/__init__.py 如下:
PI = 3.14
那么可以將包 constants 作為普通模塊對待:
import constantsprint(constants.PI)
2.2 構建包
如果要構建一個名為 drawing 的包,其中包含 shapes 和 colors 模塊,需要創(chuàng)建一下目錄和文件:
~/python加入到搜索路徑中的目錄
~/python/drawing包目錄(drawing包)
~/python/drawing/__init__.py包代碼(drawing模塊)
~/python/drawing/colors.pycolor模塊
~/python/drawing/shapes.pyshapes模塊
假設已經將 ~/python 作為搜索目錄。依照這個設置,下列導入語句都是合法的:
1. import drawing # 導入drawing包(即 __init__.py 模塊)
2. import drawing.colors # 導入colors模塊,使用drawing.colors.attr的方式引用
3. from drawing import shapes # 導入shapes模塊
__all__ 變量
與模塊的 __all__ 變量相似,包的 __all__ 變量決定了使用 from package import * 導入的子模塊。
如以上 drawing 包的 __init__.py 文件內容如下:
__all__ = ['colors']
那么使用 from drawing import * 只會導入 colors 模塊。
3. 搜索路徑
現(xiàn)在已經編寫完了一個很好用的模塊,并且通過了測試。那么如何讓這個模塊可用呢?即如何讓這個模塊具備可導入到其他模塊的能力。
3.1 搜索模塊
當使用 import 語句導入模塊時, Python 解釋器通過以下方式搜索模塊:
1. 首先搜索 built-in 模塊
2. 最后搜索變量 sys.path 提供的路徑列表
sys.path 在解釋器啟動時從以下位置初始化:
1. 當前腳本路徑
2. 環(huán)境變量 PYTHONPATH 指定的路徑集合
3. 安裝默認路徑
sys.path 初始化完成后,可以在運行時修改。
3.2 讓模塊可用
那么現(xiàn)在若要使模塊可用,一是將其放置到已有的搜索路徑下,二是指定模塊所在路徑為搜索路徑。
一般情況下,若選擇第一種方式,我們將模塊放置到 Python 安裝路徑的 \lib\site-packages 下,這個目錄是專門用來安裝第三方模塊的。正如該目錄下的 README 文件展示的那樣:
This directory exists so that 3rd party packages can be installed here. Read the source for site.py for more details.
若選擇第二種方式,直接將模塊所在目錄加入到環(huán)境變量 PYTHONPATH 中即可。
值得注意的是,可以在 \lib\site-packages 路徑下新建一個名為 user_lib.pth 的文件,內容是需要搜索的路徑,一行一個,也可以將指定路徑加入到搜索目錄中:
來源:博客園