Python包及其定義和引用詳解
對於一個需要實際應用的模塊而言,往往會具有很多程序單元,包括變量、函數和類等,如果將整個模塊的所有內容都定義在同一個 Python 源文件中,這個文件將會變得非常龐大,顯然並不利於模塊化開發。
什麼是包
爲了更好地管理多個模塊源文件,Python 提供了包的概念。那麼問題來了,什麼是包呢?
從物理上看,包就是一個文件夾,在該文件夾下包含了一個 init.py 文件,該文件夾可用於包含多個模塊源文件;從邏輯上看,包的本質依然是模塊。
根據上面介紹可以得到一個推論,包的作用是包含多個模塊,但包的本質依然是模塊,因此包也可用於包含包。典型地,當我們爲 Python 安裝了 numpy 模塊之後,可以在 Python 安裝目錄的 Lib\site-packages 目錄下找到一個 numpy 文件夾,它就是前面安裝的 numpy 模塊(其實是一個包)。該文件夾的內容如圖 1 所示:
圖 1 numpy 模塊(包)的文件結構
從圖 1 可以看出,在 numpy 包(也是模塊)下既包含了 matlib.py 等模塊源文件,也包含了 core 等子包(也是模塊)。這正對應了我們剛剛介紹的:包的本質依然是模塊,因此包又可以包含包。
定義包
掌握了包是什麼之後,接下來學習如何定義包。定義包更簡單,主要有兩步:
- 創建一個文件夾,該文件夾的名字就是該包的包名。
- 在該文件夾內添加一個 init.py 文件即可。
下面定義一個非常簡單的包。先新建一個 first_package 文件夾,然後在該文件夾中添加一個 init.py 文件,該文件內容如下:
'''
這是學習包的第一個示例
'''
print('this is first_package')
上面的 Python 源文件非常簡單,該文件開始部分的字符串是該包的說明文檔,接下來是一條簡單的輸出語句。
下面通過如下程序來使用該包:
# 導入first_package包(模塊)
import first_package
print('==========')
print(first_package.__doc__)
print(type(first_package))
print(first_package)
再次強調,包的本質就是模塊,因此導入包和導入模塊的語法完全相同。因此,上面程序中第 2 行代碼導入了 first_package 包。程序最後三行代碼輸出了包的說明文檔、包的類型和包本身。
運行該程序,可以看到如下輸出結果:
this is first package
==========
這是學習包的第一個示例
<class 'module'>
<module 'first_package' from 'G:\\publish\\codes\\09\\9.3\\first_package\\__init__.py'>
從上面的輸出結果可以看出,在導入 first_package 包時,程序執行了該包所對應的文件夾下的 init.py;從倒數第二行輸出可以看到,包的本質就是模塊;從最後一行輸出可以看到,使用 import
first_package 導入包的本質就是加載井執行該包下的 init.py 文件,然後將整個文件內容賦值給與包同名的變量,該變量的類型是 module。
與模塊類似的是,包被導入之後,會在包目錄下生成一個 pycache 文件夾,並在該文件夾內爲包生成一個 init.cpython-36.pyc 文件。
由於導入包就相當於導入該包下的 init.py 文件,因此我們完全可以在 init.py 文件中定義變量、函數、類等程序單元,但實際上往往並不會這麼做。想一想原因是什麼?包的主要作用是包含多個模塊,因此 init.py 文件的主要作用就是導入該包內的其他模塊。
下面再定義一個更加複雜的包,在該包下將會包含多個模塊,並使用 init.py 文件來加載這些模塊。
新建一個 fk_package 包,並在該包下包含三個模塊文件:
- print_shape.py
- billing.py
- arithmetic_chart.py
fk_package 的文件結構如下:
fk_package
┠──arithmetic_chart.py
┠──billing.py
┠──print_shape.py
┗━━__init__.py
其中,arithmetic_chart.py 模塊文件的內容如下:
def print_multiple_chart(n):
'打印乘法口角表的函數'
for i in range(n):
for j in range(i + 1):
print('%d * %d = %2d' % ((j + 1) , (i + 1) , (j + 1)* (i + 1)), end=' ')
print('')
上面模塊文件中定義了一個打印乘法口訣表的函數。
billing.py 模塊文件的內容如下:
class Item:
'定義代表商品的Item類'
def __init__(self, price):
self.price = price
def __repr__(self):
return 'Item[price=%g]' % self.price
print_shape.py 模塊文件的內容如下:
def print_blank_triangle(n):
'使用星號打印一個空心的三角形'
if n <= 0:
raise ValueError('n必須大於0')
for i in range(n):
print(' ' * (n - i - 1), end='')
print('*', end='')
if i != n - 1:
print(' ' * (2 * i - 1), end='')
else:
print('*' * (2 * i - 1), end='')
if i != 0:
print('*')
else:
print('')
tk_package 包下的 init.py 文件暫時爲空,不用編寫任何內容。
上面三個模塊文件都位於 fk_package 包下,總共提供了兩個函數和一個類。這意味着 fk_package 包(也是模塊)總共包含 arithmetic_chart、 billing 和 print_shape 三個模塊。在這種情況下,這三個模塊就相當於 fk_package 包的成員。
導入包內成員
如果需要使用 arithmetic_chart、 billing 和 print_shape 這三個模塊,則可以在程序中執行如下導入代碼:
# 導入fk_package包,實際上就是導入包下__init__.py文件
import fk_package
# 導入fk_package包下的print_shape模塊,
# 實際上就是導入fk_package目錄下的print_shape.py
import fk_package.print_shape
# 實際上就是導入fk_package包(模塊)導入print_shape模塊
from fk_package import billing
# 導入fk_package包下的arithmetic_chart模塊,
# 實際上就是導入fk_package目錄下的arithmetic_chart.py
import fk_package.arithmetic_chart
fk_package.print_shape.print_blank_triangle(5)
im = billing.Item(4.5)
print(im)
fk_package.arithmetic_chart.print_multiple_chart(5)
上面程序中第 2 行代碼是“import fk_package”,由於導入包的本質只是加載並執行包裏的 init.py 文件,因此執行這條導入語句之後,程序只能使用 fk_package 目錄下的 init.py 文件中定義的程序單元。對於本例而言,由於 fk_package_init_.py 文件內容爲空,因此這條導入語句沒有任何作用。
第 5 行導入語句的本質就是加載並執行 fk_package 包下的 print_shape.py 文件,並將其賦值給 fk_package.print_shape 變量。因此執行這條導入語句之後,程序可訪問 fk_package\print_shape.py 文件所定義的程序單元,但需要添加 fk_package.print_shape 前綴。
第 8 行導入語句的本質是導入 fk_package 包(也是模塊)下的 billing 成員(其實是模塊)。因此執行這條導入語句之後,程序可使用 fk_package\billing.py 文件定義的程序單元,而且只需要添加 billing 前綴。
第 11 行代碼與第 5 行代碼的導入效果相同。
該程序後面分別測試了 fk_package 包下的 print_shape、billing、arithmetic_chart 這三個模塊的功能。運行上面程序,可以看到三個模塊的功能完全可以正常顯示。
上面程序雖然可以正常運行,但此時存在兩個問題:
- 爲了調用包內模塊中的程序單元,需要使用很長的前綴,這實在是太麻煩了。
- 包內 init.py 文件的功能完全被忽略了。
想一想就知道,包內的 init.py 文件並不是用來定義程序單元的,而是用於導入該包內模塊的成員,這樣即可把模塊中的成員導入變成包內成員,以後使用起來會更加方便。
將 fk_package 包下的 init.py 文件編輯成如下形式:
# 從當前包導入print_shape模塊
from . import print_shape
# 從.print_shape導入所有程序單元到fk_package中
from .print_shape import *
# 從當前包導入billing模塊
from . import billing
# 從.billing導入所有程序單元到fk_package中
from .billing import *
# 從當前包導入arithmetic_chart模塊
from . import arithmetic_chart
# 從.arithmetic_chart導入所有程序單元到fk_package中
from .arithmetic_chart import *
該程序的代碼基本上差不多,都是通過如下兩行代碼來處理導入的:
# 從當前包導入print_shape模塊
from . import print_shape
# 從.print_shape導入所有程序單元到fk_package中
from .print_shape import *
上面第一行 from...import 用於導入當前包(模塊)中的 print_shape(模塊),這樣即可在 tk_package 中使用 print_shape 模塊。但這種導入方式是將 print_shape 模塊導入了 fk_package 包中,因此當其他程序使用 print_shape 內的成員時,依然需要通過 fk_package.print_shape 前綴進行調用。
第二行導入語句用於將 print_shape 模塊內的所有程序單元導入 fk_package 模塊中,這樣以後只要使用 fk_package.前綴就可以使用三個模塊內的程序單元。例如如下程序:
# 導入fk_package包,實際上就是導入包下__init__.py文件
import fk_package
# 直接使用fk_package前綴即可調用它所包含的模塊內的程序單元。
fk_package.print_blank_triangle(5)
im = fk_package.Item(4.5)
print(im)
fk_package.print_multiple_chart(5)
上面第 2 行代碼是導入 tk_package 包,導入該包的本質就是導入該包下的 init.py 文件。而 init.py 文件又執行了導入,它們會把三個模塊內的程序單元導入 tk_package 包中,因此程序的下面代碼可使用 tk_package.前綴來訪問三個模塊內的程序單元。
運行上面程序,同樣可以看到正常的運行結果。