1. 為重用以及更好的維護代碼，`Python`使用了模塊與包；一個`Python`文件就是一個模塊，包是組織模塊的特殊目錄(包含`__init__.py`文件)。 2. 模塊搜索路徑，`Python`解釋器在特定的目錄中搜索模塊，運行時`sys.path`即搜索路徑。 3. 使用`import`關... ...
Python基礎-包與模塊
寫在前面
如非特別說明，下文均基於Python3
摘要
- 為重用以及更好的維護代碼，
Python使用了模塊與包；一個Python文件就是一個模塊，包是組織模塊的特殊目錄(包含__init__.py文件)。 - 模塊搜索路徑，
Python解釋器在特定的目錄中搜索模塊，運行時sys.path即搜索路徑。 - 使用
import關鍵字導入模塊，註意import *與__all__的關係。
1. 模塊與導入
A module is a file containing Python definitions and statements
Python模塊就是包含定義以及語句的文件，文件名是模塊的名字加上.py尾碼。
1.1 為重用而生
假設有一個完成特定功能，很好用的函數或者類。為了使用這個功能，不得不把這段代碼複製到需要使用的每一個文件中。重覆代碼是編程的大忌，如果功能實現需要修改，會不得不修改每一個出現的地方，這是反人類的。
重用能夠很好的解決這一問題，實際上，函數，類等結構在一定程度上也為重用提供了便利。
Python中，將一系列相關的函數，類等組織在一個文件中，每一個文件都是一個Python模塊。
1.2 導入模塊
使用import關鍵字導入模塊(模塊需在搜索路徑中)：
- import sys；基礎導入語句。
- import sys as system；為導入的名字起別名。
- from sys import path；導入模塊特定元素。
- from sys import *；從sys中導入全部可導入名字
import-only-once
模塊只導入一次這種行為在大多數情況下是一種實質性的優化，在同一個解釋器生命周期內，多次使用import語句導入同一個模塊，導入只發生一次。
這一點可以在模塊中加入輸出語句證明。
import *與__all__
使用import *可能會污染當前模塊的名字空間，導入了一些不需要引用的名字。因此不推薦使用。
事實上，規範的第三方模塊會提供一個模塊公共介面，暴露該模塊可用的介面。公共介面由模塊名為__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']可以看到函數test11()並沒有被導入，這就是__all__的作用了。
2. 包與其構建
為了更好組織模塊，將模塊分組為包(package)。
2.1 包是特殊模塊
從文件系統上看，包就是模塊所在目錄。為使Python解釋器將其區別普通目錄作為包看待，包中必須直接包含一個名為__init__.py的文件(模塊)。
包基本上就是另外一類模塊，不同的地方在於包能包含其他模塊與包。包作為一個模塊，其內容其實就是文件__init__.py(模塊)的內容。
如名為constants的包，文件constants/__init__.py如下：
PI = 3.14那麼可以將包constants作為普通模塊對待：
import constants
print(constants.PI)2.2 構建包
如果要構建一個名為drawing的包，其中包含shapes和colors模塊，需要創建一下目錄和文件：
| 文件/目錄 | 描述 |
|---|---|
| ~/python | 加入到搜索路徑中的目錄 |
| ~/python/drawing | 包目錄(drawing包) |
| ~/python/drawing/__init__.py | 包代碼(drawing模塊) |
| ~/python/drawing/colors.py | color模塊 |
| ~/python/drawing/shapes.py | shapes模塊 |
假設已經將~/python作為搜索目錄。依照這個設置，下列導入語句都是合法的：
import drawing# 導入drawing包(即__init__.py模塊)import drawing.colors# 導入colors模塊，使用drawing.colors.attr的方式引用from drawing import shapes# 導入shapes模塊
__all__變數
與模塊的__all__變數相似，包的__all__變數決定了使用from package import *導入的子模塊。
如以上drawing包的__init__.py文件內容如下：
__all__ = ['colors']那麼使用from drawing import *只會導入colors模塊。
3. 搜索路徑
現在已經編寫完了一個很好用的模塊，並且通過了測試。那麼如何讓這個模塊可用呢？即如何讓這個模塊具備可導入到其他模塊的能力。
3.1 搜索模塊
當使用import語句導入模塊時，Python解釋器通過以下方式搜索模塊：
- 首先搜索
built-in模塊 - 最後搜索變數
sys.path提供的路徑列表
sys.path在解釋器啟動時從以下位置初始化：
- 當前腳本路徑
- 環境變數
PYTHONPATH指定的路徑集合 - 安裝預設路徑
sys.path初始化完成後，可以在運行時修改。
3.2 讓模塊可用
那麼現在若要使模塊可用，一是將其放置到已有的搜索路徑下，二是指定模塊所在路徑為搜索路徑。
一般情況下，若選擇第一種方式，我們將模塊放置到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.
若選擇第二種方式，直接將模塊所在目錄加入到環境變數PYTHONPATH中即可。
值得註意的是，可以在\lib\site-packages路徑下新建一個名為user_lib.pth的文件，內容是需要搜索的路徑，一行一個，也可以將指定路徑加入到搜索目錄中：
