Python基礎(chǔ)-包與模塊
寫在前面
如非特別說明旬薯，下文均基于Python3
摘要
- 為重用以及更好的維護代碼效诅，
Python使用了模塊與包布隔；一個Python文件就是一個模塊，包是組織模塊的特殊目錄(包含__init__.py文件)澎迎。 - 模塊搜索路徑庐杨，
Python解釋器在特定的目錄中搜索模塊，運行時sys.path即搜索路徑夹供。 - 使用
import關(guān)鍵字導(dǎo)入模塊灵份，注意import *與__all__的關(guān)系。
1. 模塊與導(dǎo)入
A module is a file containing Python definitions and statements
Python模塊就是包含定義以及語句的文件哮洽，文件名是模塊的名字加上.py后綴填渠。
1.1 為重用而生
假設(shè)有一個完成特定功能，很好用的函數(shù)或者類鸟辅。為了使用這個功能氛什，不得不把這段代碼復(fù)制到需要使用的每一個文件中。重復(fù)代碼是編程的大忌匪凉，如果功能實現(xiàn)需要修改枪眉，會不得不修改每一個出現(xiàn)的地方，這是反人類的再层。
重用能夠很好的解決這一問題贸铜，實際上堡纬，函數(shù)，類等結(jié)構(gòu)在一定程度上也為重用提供了便利蒿秦。
Python中烤镐，將一系列相關(guān)的函數(shù)，類等組織在一個文件中棍鳖，每一個文件都是一個Python模塊职车。
1.2 導(dǎo)入模塊
使用import關(guān)鍵字導(dǎo)入模塊(模塊需在搜索路徑中)：
- import sys；基礎(chǔ)導(dǎo)入語句鹊杖。
- import sys as system；為導(dǎo)入的名字起別名扛芽。
- from sys import path骂蓖；導(dǎo)入模塊特定元素。
- from sys import *川尖；從sys中導(dǎo)入全部可導(dǎo)入名字
import-only-once
模塊只導(dǎo)入一次這種行為在大多數(shù)情況下是一種實質(zhì)性的優(yōu)化登下，在同一個解釋器生命周期內(nèi)，多次使用import語句導(dǎo)入同一個模塊叮喳，導(dǎo)入只發(fā)生一次被芳。
這一點可以在模塊中加入輸出語句證明。
import *與__all__
使用import *可能會污染當(dāng)前模塊的名字空間馍悟，導(dǎo)入了一些不需要引用的名字畔濒。因此不推薦使用。
事實上锣咒，規(guī)范的第三方模塊會提供一個模塊公共接口侵状，暴露該模塊可用的接口。公共接口由模塊名為__all__的列表定義毅整。
如定義名為mtest1的模塊：
__all__ = ['test1', 'test12']
def test1():
print('test1')
def test11():
print('test11')
def test12():
print('test12')
使用全部導(dǎo)入的方式：
>>> form mtest1 import *
>>> dir()
>>> ['__annotations__', '__builtins__', '__doc__', '__loader__','__name__', '__package__', '__spec__', 'test1', 'test12']
可以看到函數(shù)test11()并沒有被導(dǎo)入趣兄，這就是__all__的作用了。
2. 包與其構(gòu)建
為了更好組織模塊悼嫉，將模塊分組為包(package)艇潭。
2.1 包是特殊模塊
從文件系統(tǒng)上看，包就是模塊所在目錄戏蔑。為使Python解釋器將其區(qū)別普通目錄作為包看待蹋凝，包中必須直接包含一個名為__init__.py的文件(模塊)。
包基本上就是另外一類模塊辛臊，不同的地方在于包能包含其他模塊與包仙粱。包作為一個模塊，其內(nèi)容其實就是文件__init__.py(模塊)的內(nèi)容彻舰。
如名為constants的包伐割，文件constants/__init__.py如下：
PI = 3.14
那么可以將包constants作為普通模塊對待：
import constants
print(constants.PI)
2.2 構(gòu)建包
如果要構(gòu)建一個名為drawing的包候味，其中包含shapes和colors模塊，需要創(chuàng)建一下目錄和文件：
| 文件/目錄 | 描述 |
|---|---|
| ~/python | 加入到搜索路徑中的目錄 |
| ~/python/drawing | 包目錄(drawing包) |
| ~/python/drawing/_init_.py | 包代碼(drawing模塊) |
| ~/python/drawing/colors.py | color模塊 |
| ~/python/drawing/shapes.py | shapes模塊 |
假設(shè)已經(jīng)將~/python作為搜索目錄隔心。依照這個設(shè)置白群，下列導(dǎo)入語句都是合法的：
-
import drawing# 導(dǎo)入drawing包(即__init__.py模塊) -
import drawing.colors# 導(dǎo)入colors模塊，使用drawing.colors.attr的方式引用 -
from drawing import shapes# 導(dǎo)入shapes模塊
__all__變量
與模塊的__all__變量相似硬霍，包的__all__變量決定了使用from package import *導(dǎo)入的子模塊帜慢。
如以上drawing包的__init__.py文件內(nèi)容如下：
__all__ = ['colors']
那么使用from drawing import *只會導(dǎo)入colors模塊。
3. 搜索路徑
現(xiàn)在已經(jīng)編寫完了一個很好用的模塊唯卖，并且通過了測試粱玲。那么如何讓這個模塊可用呢？即如何讓這個模塊具備可導(dǎo)入到其他模塊的能力拜轨。
3.1 搜索模塊
當(dāng)使用import語句導(dǎo)入模塊時抽减，Python解釋器通過以下方式搜索模塊：
- 首先搜索
built-in模塊 - 最后搜索變量
sys.path提供的路徑列表
sys.path在解釋器啟動時從以下位置初始化：
- 當(dāng)前腳本路徑
- 環(huán)境變量
PYTHONPATH指定的路徑集合 - 安裝默認(rèn)路徑
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的文件，內(nèi)容是需要搜索的路徑谤牡，一行一個副硅，也可以將指定路徑加入到搜索目錄中：
