1. 使用__slots__
正常情況下,當(dāng)我們定義了一個class,創(chuàng)建了一個class
的實例后,我們可以給該實例綁定任何屬性和方法,這就是動態(tài)語言的靈活性。先定義class:
class Student(object):
pass
然后,嘗試給實例綁定一個屬性:
>>> s = Student()
>>> s.name = 'Michael' # 動態(tài)給實例綁定一個屬性
>>> print(s.name)
Michael
還可以嘗試給實例綁定一個方法:
>>> def set_age(self, age): # 定義一個函數(shù)作為實例方法
... self.age = age
...
>>> from types import MethodType
>>> s.set_age = MethodType(set_age, s) # 給實例綁定一個方法
>>> s.set_age(25) # 調(diào)用實例方法
>>> s.age # 測試結(jié)果
25
但是,給一個實例綁定的方法,對另一個實例是不起作用的
為了給所有實例都綁定方法,可以給class綁定方法:
>>> def set_score(self, score):
... self.score = score
...
>>> Student.set_score = set_score
給class綁定方法后,所有實例均可調(diào)用:
>>> s.set_score(100)
>>> s.score
100
>>> s2.set_score(99)
>>> s2.score
99
通常情況下,上面的set_score
方法可以直接定義在class中,但動態(tài)綁定允許我們在程序運行的過程中動態(tài)給class加上功能,這在靜態(tài)語言中很難實現(xiàn)。
使用__slots__
但是,如果我們想要限制實例的屬性怎么辦?比如,只允許對Student實例添加name
和age
屬性。
為了達(dá)到限制的目的,Python允許在定義class的時候,定義一個特殊的__slots__
變量,來限制該class實例能添加的屬性:
class Student(object):
__slots__ = ('name', 'age') # 用tuple定義允許綁定的屬性名稱
然后,我們試試:
>>> s = Student() # 創(chuàng)建新的實例
>>> s.name = 'Michael' # 綁定屬性'name'
>>> s.age = 25 # 綁定屬性'age'
>>> s.score = 99 # 綁定屬性'score'
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: 'Student' object has no attribute 'score'
由于'score'
沒有被放到__slots__
中,所以不能綁定score屬性,試圖綁定score將得到AttributeError
的錯誤。
使用__slots__
要注意,__slots__
定義的屬性僅對當(dāng)前類實例起作用,對繼承的子類是不起作用的:
>>> class GraduateStudent(Student):
... pass
...
>>> g = GraduateStudent()
>>> g.score = 9999
除非在子類中也定義__slots__
,這樣,子類實例允許定義的屬性就是自身的__slots__
加上父類的__slots__
。
2. 使用 @property
在綁定屬性時,如果我們直接把屬性暴露出去,雖然寫起來很簡單,但是,沒辦法檢查參數(shù),導(dǎo)致可以把成績隨便改:
s = Student()
s.score = 9999
這顯然不合邏輯。為了限制score的范圍,可以通過一個set_score()
方法來設(shè)置成績,再通過一個get_score()
來獲取成績,這樣,在set_score()
方法里,就可以檢查參數(shù):
class Student(object):
def get_score(self):
return self._score
def set_score(self, value):
if not isinstance(value, int):
raise ValueError('score must be an integer!')
if value < 0 or value > 100:
raise ValueError('score must between 0 ~ 100!')
self._score = value
現(xiàn)在,對任意的Student實例進(jìn)行操作,就不能隨心所欲地設(shè)置score了:
>>> s = Student()
>>> s.set_score(60) # ok!
>>> s.get_score()
60
>>> s.set_score(9999)
Traceback (most recent call last):
...
ValueError: score must between 0 ~ 100!
但是,上面的調(diào)用方法又略顯復(fù)雜,沒有直接用屬性這么直接簡單。
有沒有既能檢查參數(shù),又可以用類似屬性這樣簡單的方式來訪問類的變量呢?對于追求完美的Python程序員來說,這是必須要做到的!
還記得裝飾器(decorator)可以給函數(shù)動態(tài)加上功能嗎?對于類的方法,裝飾器一樣起作用。Python內(nèi)置的@property
裝飾器就是負(fù)責(zé)把一個方法變成屬性調(diào)用的:
class Student(object):
@property
def score(self):
return self._score
@score.setter
def score(self, value):
if not isinstance(value, int):
raise ValueError('score must be an integer!')
if value < 0 or value > 100:
raise ValueError('score must between 0 ~ 100!')
self._score = value
@property
的實現(xiàn)比較復(fù)雜,我們先考察如何使用。把一個getter
方法變成屬性,只需要加上@property
就可以了,此時,@property
本身又創(chuàng)建了另一個裝飾器@score.setter
,負(fù)責(zé)把一個setter
方法變成屬性賦值,于是,我們就擁有一個可控的屬性操作:
>>> s = Student()
>>> s.score = 60 # OK,實際轉(zhuǎn)化為s.set_score(60)
>>> s.score # OK,實際轉(zhuǎn)化為s.get_score()
60
>>> s.score = 9999
Traceback (most recent call last):
...
ValueError: score must between 0 ~ 100!
注意到這個神奇的@property
,我們在對實例屬性操作的時候,就知道該屬性很可能不是直接暴露的,而是通過getter和setter方法來實現(xiàn)的。
還可以定義只讀屬性,只定義getter方法,不定義setter方法就是一個只讀屬性:
class Student(object):
@property
def birth(self):
return self._birth
@birth.setter
def birth(self, value):
self._birth = value
@property
def age(self):
return 2015 - self._birth
上面的birth
是可讀寫屬性,而age
就是一個只讀屬性,因為age
可以根據(jù)birth和當(dāng)前時間計算出來。
小結(jié)
@property
廣泛應(yīng)用在類的定義中,可以讓調(diào)用者寫出簡短的代碼,同時保證對參數(shù)進(jìn)行必要的檢查,這樣,程序運行時就減少了出錯的可能性。
3. 多重繼承
繼承是面向?qū)ο缶幊痰囊粋€重要的方式,因為通過繼承,子類就可以擴展父類的功能。
回憶一下Animal類層次的設(shè)計,假設(shè)我們要實現(xiàn)以下4種動物:
Dog - 狗狗;
Bat - 蝙蝠;
Parrot - 鸚鵡;
Ostrich - 鴕鳥。
以上,既有哺乳類動物,也有飛行動物,如何設(shè)計規(guī)劃?
正確的做法是采用多重繼承。首先,主要的類層次仍按照哺乳類和鳥類設(shè)計:
class Animal(object):
pass
# 大類:
class Mammal(Animal):
pass
class Bird(Animal):
pass
# 各種動物:
class Dog(Mammal):
pass
class Bat(Mammal):
pass
class Parrot(Bird):
pass
class Ostrich(Bird):
pass
現(xiàn)在,我們要給動物再加上Runnable和Flyable的功能,只需要先定義好Runnable和Flyable的類:
class Runnable(object):
def run(self):
print('Running...')
class Flyable(object):
def fly(self):
print('Flying...')
對于需要Runnable功能的動物,就多繼承一個Runnable,例如Dog:
class Dog(Mammal, Runnable):
pass
對于需要Flyable功能的動物,就多繼承一個Flyable,例如Bat:
class Bat(Mammal, Flyable):
pass
通過多重繼承,一個子類就可以同時獲得多個父類的所有功能。
MixIn
在設(shè)計類的繼承關(guān)系時,通常,主線都是單一繼承下來的,例如,Ostrich繼承自Bird。但是,如果需要“混入”額外的功能,通過多重繼承就可以實現(xiàn),比如,讓Ostrich除了繼承自Bird外,再同時繼承Runnable。這種設(shè)計通常稱之為MixIn
。
為了更好地看出繼承關(guān)系,我們把Runnable
和Flyable
改為RunnableMixIn
和FlyableMixIn
。類似的,你還可以定義出肉食動物CarnivorousMixIn
和植食動物HerbivoresMixIn
,讓某個動物同時擁有好幾個MixIn:
class Dog(Mammal, RunnableMixIn, CarnivorousMixIn):
pass
MixIn
的目的就是給一個類增加多個功能,這樣,在設(shè)計類的時候,我們優(yōu)先考慮通過多重繼承來組合多個MixIn的功能,而不是設(shè)計多層次的復(fù)雜的繼承關(guān)系。
小結(jié)
由于Python允許使用多重繼承,因此,MixIn
就是一種常見的設(shè)計。
只允許單一繼承的語言(如Java)不能使用MixIn
的設(shè)計。
4. 定制類
看到類似__slots__
這種形如__xxx__
的變量或者函數(shù)名就要注意,這些在Python中是有特殊用途的。
__slots__
我們已經(jīng)知道怎么用了,__len__()
方法我們也知道是為了能讓class
作用于len()
函數(shù)。
除此之外,Python的class中還有許多這樣有特殊用途的函數(shù),可以幫助我們定制類。
__str__
我們先定義一個Student類,打印一個實例:
>>> class Student(object):
... def __init__(self, name):
... self.name = name
...
>>> print(Student('Michael'))
<__main__.Student object at 0x109afb190>
打印出一堆<__main__.Student object at 0x109afb190>
,不好看。
怎么才能打印得好看呢?只需要定義好__str__()
方法,返回一個好看的字符串就可以了:
>>> class Student(object):
... def __init__(self, name):
... self.name = name
... def __str__(self):
... return 'Student object (name: %s)' % self.name
...
>>> print(Student('Michael'))
Student object (name: Michael)
這樣打印出來的實例,不但好看,而且容易看出實例內(nèi)部重要的數(shù)據(jù)。
但是細(xì)心的朋友會發(fā)現(xiàn)直接敲變量不用print
,打印出來的實例還是不好看:
>>> s = Student('Michael')
>>> s
<__main__.Student object at 0x109afb310>
這是因為直接顯示變量調(diào)用的不是__str__()
,而是__repr__()
,兩者的區(qū)別是__str__()
返回用戶看到的字符串,而__repr__()
返回程序開發(fā)者看到的字符串,也就是說,__repr__()
是為調(diào)試服務(wù)的。
解決辦法是再定義一個__repr__()
。但是通常__str__()
和__repr__()
代碼都是一樣的,所以,有個偷懶的寫法:
class Student(object):
def __init__(self, name):
self.name = name
def __str__(self):
return 'Student object (name=%s)' % self.name
__repr__ = __str__
__iter__
如果一個類想被用于for ... in
循環(huán),類似list
或tuple
那樣,就必須實現(xiàn)一個__iter__()
方法,該方法返回一個迭代對象,然后,Python的for循環(huán)就會不斷調(diào)用該迭代對象的__next__()
方法拿到循環(huán)的下一個值,直到遇到StopIteration
錯誤時退出循環(huán)。
我們以斐波那契數(shù)列為例,寫一個Fib
類,可以作用于for
循環(huán):
class Fib(object):
def __init__(self):
self.a, self.b = 0, 1 # 初始化兩個計數(shù)器a,b
def __iter__(self):
return self # 實例本身就是迭代對象,故返回自己
def __next__(self):
self.a, self.b = self.b, self.a + self.b # 計算下一個值
if self.a > 100000: # 退出循環(huán)的條件
raise StopIteration()
return self.a # 返回下一個值
現(xiàn)在,試試把Fib
實例作用于for
循環(huán):
>>> for n in Fib():
... print(n)
...
1
1
2
3
5
...
46368
75025
__getitem__
Fib實例雖然能作用于for循環(huán),看起來和list有點像,但是,把它當(dāng)成list來使用還是不行,比如,取第5個元素:
>>> Fib()[5]
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'Fib' object does not support indexing
要表現(xiàn)得像list那樣按照下標(biāo)取出元素,需要實現(xiàn)__getitem__()
方法:
class Fib(object):
def __getitem__(self, n):
a, b = 1, 1
for x in range(n):
a, b = b, a + b
return a
現(xiàn)在,就可以按下標(biāo)訪問數(shù)列的任意一項了:
>>> f = Fib()
>>> f[0]
1
>>> f[1]
1
>>> f[2]
2
但是list有個神奇的切片方法:
>>> list(range(100))[5:10]
[5, 6, 7, 8, 9]
對于Fib卻報錯。原因是__getitem__()
傳入的參數(shù)可能是一個int
,也可能是一個切片對象slice
,所以要做判斷:
class Fib(object):
def __getitem__(self, n):
if isinstance(n, int): # n是索引
a, b = 1, 1
for x in range(n):
a, b = b, a + b
return a
if isinstance(n, slice): # n是切片
start = n.start
stop = n.stop
if start is None:
start = 0
a, b = 1, 1
L = []
for x in range(stop):
if x >= start:
L.append(a)
a, b = b, a + b
return L
現(xiàn)在試試Fib的切片:
>>> f = Fib()
>>> f[0:5]
[1, 1, 2, 3, 5]
>>> f[:10]
[1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
但是沒有對step
參數(shù)作處理:
>>> f[:10:2]
[1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
也沒有對負(fù)數(shù)作處理,所以,要正確實現(xiàn)一個__getitem__()
還是有很多工作要做的。
此外,如果把對象看成dict
,__getitem__()
的參數(shù)也可能是一個可以作key
的object
,例如str
。
與之對應(yīng)的是__setitem__()
方法,把對象視作list
或dict
來對集合賦值。最后,還有一個__delitem__()
方法,用于刪除某個元素。
總之,通過上面的方法,我們自己定義的類表現(xiàn)得和Python自帶的list、tuple、dict沒什么區(qū)別,這完全歸功于動態(tài)語言的“鴨子類型”,不需要強制繼承某個接口。
__getattr__
正常情況下,當(dāng)我們調(diào)用類的方法或?qū)傩詴r,如果不存在,就會報錯。比如定義Student類:
class Student(object): def __init__(self): self.name = 'Michael'
調(diào)用name
屬性,沒問題,但是,調(diào)用不存在的score
屬性,就有問題了:
>>> s = Student()>>> print(s.name)Michael>>> print(s.score)Traceback (most recent call last): ...AttributeError: 'Student' object has no attribute 'score'
錯誤信息很清楚地告訴我們,沒有找到score
這個attribute
。
要避免這個錯誤,除了可以加上一個score
屬性外,Python還有另一個機制,那就是寫一個__getattr__()
方法,動態(tài)返回一個屬性。修改如下:
class Student(object): def __init__(self): self.name = 'Michael' def __getattr__(self, attr): if attr=='score': return 99
當(dāng)調(diào)用不存在的屬性時,比如score
,Python解釋器會試圖調(diào)用__getattr__(self, 'score')
來嘗試獲得屬性,這樣,我們就有機會返回score
的值:
>>> s = Student()>>> s.name'Michael'>>> s.score99
返回函數(shù)也是完全可以的:
class Student(object): def __getattr__(self, attr): if attr=='age': return lambda: 25
只是調(diào)用方式要變?yōu)椋?/p>
>>> s.age()25
注意,只有在沒有找到屬性的情況下,才調(diào)用__getattr__
,已有的屬性,比如name
,不會在__getattr__
中查找。
此外,注意到任意調(diào)用如s.abc
都會返回None,這是因為我們義的__getattr__
默認(rèn)返回就是None。要讓class只響應(yīng)特定的幾個屬性,我們就要按照約定,拋出AttributeError
的錯誤:
class Student(object): def __getattr__(self, attr): if attr=='age': return lambda: 25 raise AttributeError('\'Student\' object has no attribute \'%s\'' % attr)
這實際上可以把一個類的所有屬性和方法調(diào)用全部動態(tài)化處理了,不需要任何特殊手段。
這種完全動態(tài)調(diào)用的特性有什么實際作用呢?作用就是,可以針對完全動態(tài)的情況作調(diào)用。
舉個例子:
現(xiàn)在很多網(wǎng)站都搞REST API
,比如新浪微博、豆瓣啥的,調(diào)用API的URL類似:
http://api.server/user/friends
http://api.server/user/timeline/list
如果要寫SDK,給每個URL對應(yīng)的API都寫一個方法,那得累死,而且,API一旦改動,SDK也要改。
利用完全動態(tài)的__getattr__
,我們可以寫出一個鏈?zhǔn)秸{(diào)用:
class Chain(object): def __init__(self, path=''): self._path = path def __getattr__(self, path): return Chain('%s/%s' % (self._path, path)) def __str__(self): return self._path __repr__ = __str__
試試:
>>> Chain().status.user.timeline.list'/status/user/timeline/list'
這樣,無論API怎么變,SDK都可以根據(jù)URL實現(xiàn)完全動態(tài)的調(diào)用,而且,不隨API的增加而改變!
還有些REST API會把參數(shù)放到URL中,比如GitHub的API:
GET /users/:user/repos
調(diào)用時,需要把:user
替換為實際用戶名。如果我們能寫出這樣的鏈?zhǔn)秸{(diào)用:Chain().users('michael').repos
就可以非常方便地調(diào)用API了。有興趣的童鞋可以試試寫出來。
__call__
一個對象實例可以有自己的屬性和方法,當(dāng)我們調(diào)用實例方法時,我們用instance.method()
來調(diào)用。能不能直接在實例本身上調(diào)用呢?在Python中,答案是肯定的。
任何類,只需要定義一個__call__()
方法,就可以直接對實例進(jìn)行調(diào)用。請看示例:
class Student(object):
def __init__(self, name):
self.name = name
def __call__(self):
print('My name is %s.' % self.name)
調(diào)用方式如下:
>>> s = Student('Michael')
>>> s() # self參數(shù)不要傳入
My name is Michael.
__call__()
還可以定義參數(shù)。對實例進(jìn)行直接調(diào)用就好比對一個函數(shù)進(jìn)行調(diào)用一樣,所以你完全可以把對象看成函數(shù),把函數(shù)看成對象,因為這兩者之間本來就沒啥根本的區(qū)別。
如果你把對象看成函數(shù),那么函數(shù)本身其實也可以在運行期動態(tài)創(chuàng)建出來,因為類的實例都是運行期創(chuàng)建出來的,這么一來,我們就模糊了對象和函數(shù)的界限。
那么,怎么判斷一個變量是對象還是函數(shù)呢?其實,更多的時候,我們需要判斷一個對象是否能被調(diào)用,能被調(diào)用的對象就是一個Callable對象,比如函數(shù)和我們上面定義的帶有__call__()
的類實例:
>>> callable(Student())
True
>>> callable(max)
True
>>> callable([1, 2, 3])
False
>>> callable(None)
False
>>> callable('str')
False
通過callable()
函數(shù),我們就可以判斷一個對象是否是“可調(diào)用”對象。
本節(jié)介紹的是最常用的幾個定制方法,還有很多可定制的方法,請參考Python的官方文檔。
5. 使用枚舉類
當(dāng)我們需要定義常量時,一個辦法是用大寫變量通過整數(shù)來定義,例如月份:JAN = 1
,好處是簡單,缺點是類型是int
,并且仍然是變量。
更好的方法是為這樣的枚舉類型定義一個class類型,然后,每個常量都是class的一個唯一實例。Python提供了Enum
類來實現(xiàn)這個功能:
from enum import Enum
Month = Enum('Month', ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'))
這樣我們就獲得了Month
類型的枚舉類,可以直接使用Month.Jan
來引用一個常量,或者枚舉它的所有成員:
for name, member in Month.__members__.items():
print(name, '=>', member, ',', member.value)
value
屬性則是自動賦給成員的int
常量,默認(rèn)從1開始計數(shù)。
如果需要更精確地控制枚舉類型,可以從Enum
派生出自定義類:
from enum import Enum, unique@uniqueclass Weekday(Enum): Sun = 0 # Sun的value被設(shè)定為0 Mon = 1 Tue = 2 Wed = 3 Thu = 4 Fri = 5 Sat = 6
@unique
裝飾器可以幫助我們檢查保證沒有重復(fù)值。
訪問這些枚舉類型可以有若干種方法:
>>> day1 = Weekday.Mon>>> print(day1)Weekday.Mon>>> print(Weekday.Tue)Weekday.Tue>>> print(Weekday['Tue'])Weekday.Tue>>> print(Weekday.Tue.value)2>>> print(day1 == Weekday.Mon)True>>> print(day1 == Weekday.Tue)False>>> print(Weekday(1))Weekday.Mon>>> print(day1 == Weekday(1))True>>> Weekday(7)Traceback (most recent call last): ...ValueError: 7 is not a valid Weekday>>> for name, member in Weekday.__members__.items():... print(name, '=>', member)...Sun => Weekday.SunMon => Weekday.MonTue => Weekday.TueWed => Weekday.WedThu => Weekday.ThuFri => Weekday.FriSat => Weekday.Sat
可見,既可以用成員名稱引用枚舉常量,又可以直接根據(jù)value
的值獲得枚舉常量。
Enum可以把一組相關(guān)常量定義在一個class中,且class不可變,而且成員可以直接比較。
6.使用元類
type()
動態(tài)語言和靜態(tài)語言最大的不同,就是函數(shù)和類的定義,不是編譯時定義的,而是運行時動態(tài)創(chuàng)建的。
比方說我們要定義一個Hello的class,就寫一個hello.py
模塊:
class Hello(object):
def hello(self, name='world'):
print('Hello, %s.' % name)
當(dāng)Python解釋器載入hello模塊時,就會依次執(zhí)行該模塊的所有語句,執(zhí)行結(jié)果就是動態(tài)創(chuàng)建出一個Hello的class對象,測試如下:
>>> from hello import Hello
>>> h = Hello()
>>> h.hello()
Hello, world.
>>> print(type(Hello))
<class 'type'>
>>> print(type(h))
<class 'hello.Hello'>
type()
函數(shù)可以查看一個類型或變量的類型,Hello是一個class,它的類型就是type,而h是一個實例,它的類型就是class Hello。
我們說class的定義是運行時動態(tài)創(chuàng)建的,而創(chuàng)建class的方法就是使用type()
函數(shù)。
type()
函數(shù)既可以返回一個對象的類型,又可以創(chuàng)建出新的類型,比如,我們可以通過type()
函數(shù)創(chuàng)建出Hello類,而無需通過class Hello(object)...的定義:
>>> def fn(self, name='world'): # 先定義函數(shù)
... print('Hello, %s.' % name)
...
>>> Hello = type('Hello', (object,), dict(hello=fn)) # 創(chuàng)建Hello class
>>> h = Hello()
>>> h.hello()
Hello, world.
>>> print(type(Hello))
<class 'type'>
>>> print(type(h))
<class '__main__.Hello'>
要創(chuàng)建一個class對象,type()
函數(shù)依次傳入3個參數(shù):
class
的名稱;
繼承的父類集合,注意Python支持多重繼承,如果只有一個父類,別忘了tuple
的單元素寫法;
class的方法名稱與函數(shù)綁定,這里我們把函數(shù)fn
綁定到方法名hello上。
通過type()
函數(shù)創(chuàng)建的類和直接寫class是完全一樣的,因為Python解釋器遇到class定義時,僅僅是掃描一下class定義的語法,然后調(diào)用type()
函數(shù)創(chuàng)建出class。
正常情況下,我們都用class Xxx...
來定義類,但是,type()
函數(shù)也允許我們動態(tài)創(chuàng)建出類來,也就是說,動態(tài)語言本身支持運行期動態(tài)創(chuàng)建類,這和靜態(tài)語言有非常大的不同,要在靜態(tài)語言運行期創(chuàng)建類,必須構(gòu)造源代碼字符串再調(diào)用編譯器,或者借助一些工具生成字節(jié)碼實現(xiàn),本質(zhì)上都是動態(tài)編譯,會非常復(fù)雜。
metaclass
除了使用type()
動態(tài)創(chuàng)建類以外,要控制類的創(chuàng)建行為,還可以使用metaclass
。
metaclass
,直譯為元類
,簡單的解釋就是:
當(dāng)我們定義了類以后,就可以根據(jù)這個類創(chuàng)建出實例,所以:先定義類,然后創(chuàng)建實例。
但是如果我們想創(chuàng)建出類呢?那就必須根據(jù)metaclass創(chuàng)建出類,所以:先定義metaclass,然后創(chuàng)建類。
連接起來就是:先定義metaclass
,就可以創(chuàng)建類,最后創(chuàng)建實例。
所以,metaclass
允許你創(chuàng)建類或者修改類。換句話說,你可以把類看成是metaclass
創(chuàng)建出來的“實例”。
metaclass
是Python面向?qū)ο罄镒铍y理解,也是最難使用的魔術(shù)代碼。正常情況下,你不會碰到需要使用metaclass
的情況,所以,以下內(nèi)容看不懂也沒關(guān)系,因為基本上你不會用到。
我們先看一個簡單的例子,這個metaclass可以給我們自定義的MyList增加一個add
方法:
定義ListMetaclass
,按照默認(rèn)習(xí)慣,metaclass
的類名總是以Metaclass
結(jié)尾,以便清楚地表示這是一個metaclass
:
# metaclass是類的模板,所以必須從`type`類型派生:
class ListMetaclass(type):
def __new__(cls, name, bases, attrs):
attrs['add'] = lambda self, value: self.append(value)
return type.__new__(cls, name, bases, attrs)
有了ListMetaclass
,我們在定義類的時候還要指示使用ListMetaclass
來定制類,傳入關(guān)鍵字參數(shù)metaclass
:
class MyList(list, metaclass=ListMetaclass):
pass
當(dāng)我們傳入關(guān)鍵字參數(shù)metaclass
時,魔術(shù)就生效了,它指示Python解釋器在創(chuàng)建MyList時,要通過ListMetaclass.__new__()
來創(chuàng)建,在此,我們可以修改類的定義,比如,加上新的方法,然后,返回修改后的定義。
__new__()
方法接收到的參數(shù)依次是:
當(dāng)前準(zhǔn)備創(chuàng)建的類的對象;
類的名字;
類繼承的父類集合;
類的方法集合。
測試一下MyList是否可以調(diào)用add()
方法:
>>> L = MyList()
>>> L.add(1)
>> L
[1]
而普通的list沒有add()
方法:
>>> L2 = list()
>>> L2.add(1)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: 'list' object has no attribute 'add'
動態(tài)修改有什么意義?直接在MyList定義中寫上add()
方法不是更簡單嗎?正常情況下,確實應(yīng)該直接寫,通過metaclass
修改純屬變態(tài)。
但是,總會遇到需要通過metaclass修改類定義的。ORM就是一個典型的例子。
ORM全稱“Object Relational Mapping”,即對象-關(guān)系映射,就是把關(guān)系數(shù)據(jù)庫的一行映射為一個對象,也就是一個類對應(yīng)一個表,這樣,寫代碼更簡單,不用直接操作SQL語句。
要編寫一個ORM框架,所有的類都只能動態(tài)定義,因為只有使用者才能根據(jù)表的結(jié)構(gòu)定義出對應(yīng)的類來。
讓我們來嘗試編寫一個ORM框架。
編寫底層模塊的第一步,就是先把調(diào)用接口寫出來。比如,使用者如果使用這個ORM框架,想定義一個User類來操作對應(yīng)的數(shù)據(jù)庫表User,我們期待他寫出這樣的代碼:
class User(Model):
# 定義類的屬性到列的映射:
id = IntegerField('id')
name = StringField('username')
email = StringField('email')
password = StringField('password')
# 創(chuàng)建一個實例:
u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
# 保存到數(shù)據(jù)庫:
u.save()
其中,父類Model和屬性類型StringField
、IntegerField
是由ORM框架提供的,剩下的魔術(shù)方法比如save()全部由metaclass
自動完成。雖然metaclass
的編寫會比較復(fù)雜,但ORM的使用者用起來卻異常簡單。
現(xiàn)在,我們就按上面的接口來實現(xiàn)該ORM。
首先來定義Field
類,它負(fù)責(zé)保存數(shù)據(jù)庫表的字段名和字段類型:
class Field(object):
def __init__(self, name, column_type):
self.name = name
self.column_type = column_type
def __str__(self):
return '<%s:%s>' % (self.__class__.__name__, self.name)
在Field的基礎(chǔ)上,進(jìn)一步定義各種類型的Field,比如StringField,IntegerField等等:
class StringField(Field):
def __init__(self, name):
super(StringField, self).__init__(name, 'varchar(100)')
class IntegerField(Field):
def __init__(self, name):
super(IntegerField, self).__init__(name, 'bigint')
下一步,就是編寫最復(fù)雜的ModelMetaclass
了:
class ModelMetaclass(type):
def __new__(cls, name, bases, attrs):
if name=='Model':
return type.__new__(cls, name, bases, attrs)
print('Found model: %s' % name)
mappings = dict()
for k, v in attrs.items():
if isinstance(v, Field):
print('Found mapping: %s ==> %s' % (k, v))
mappings[k] = v
for k in mappings.keys():
attrs.pop(k)
attrs['__mappings__'] = mappings # 保存屬性和列的映射關(guān)系
attrs['__table__'] = name # 假設(shè)表名和類名一致
return type.__new__(cls, name, bases, attrs)
以及基類Model:
class Model(dict, metaclass=ModelMetaclass):
def __init__(self, **kw):
super(Model, self).__init__(**kw)
def __getattr__(self, key):
try:
return self[key]
except KeyError:
raise AttributeError(r"'Model' object has no attribute '%s'" % key)
def __setattr__(self, key, value):
self[key] = value
def save(self):
fields = []
params = []
args = []
for k, v in self.__mappings__.items():
fields.append(v.name)
params.append('?')
args.append(getattr(self, k, None))
sql = 'insert into %s (%s) values (%s)' % (self.__table__, ','.join(fields), ','.join(params))
print('SQL: %s' % sql)
print('ARGS: %s' % str(args))
當(dāng)用戶定義一個class User(Model)
時,Python解釋器首先在當(dāng)前類User的定義中查找metaclass
,如果沒有找到,就繼續(xù)在父類Model中查找metaclass
,找到了,就使用Model中定義的metaclass
的ModelMetaclass
來創(chuàng)建User類,也就是說,metaclass
可以隱式地繼承到子類,但子類自己卻感覺不到。
在ModelMetaclass中,一共做了幾件事情:
排除掉對Model類的修改;
在當(dāng)前類(比如User)中查找定義的類的所有屬性,如果找到一個Field屬性,就把它保存到一個__mappings__
的dict
中,同時從類屬性中刪除該Field
屬性,否則,容易造成運行時錯誤(實例的屬性會遮蓋類的同名屬性);
把表名保存到__table__
中,這里簡化為表名默認(rèn)為類名。
在Model類中,就可以定義各種操作數(shù)據(jù)庫的方法,比如save()
,delete()
,find()
,update
等等。
我們實現(xiàn)了save()
方法,把一個實例保存到數(shù)據(jù)庫中。因為有表名,屬性到字段的映射和屬性值的集合,就可以構(gòu)造出INSERT語句。
編寫代碼試試:
u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
u.save()
輸出如下:
Found model: User
Found mapping: email ==> <StringField:email>
Found mapping: password ==> <StringField:password>
Found mapping: id ==> <IntegerField:uid>
Found mapping: name ==> <StringField:username>
SQL: insert into User (password,email,username,id) values (?,?,?,?)
ARGS: ['my-pwd', 'test@orm.org', 'Michael', 12345]
可以看到,save()
方法已經(jīng)打印出了可執(zhí)行的SQL語句,以及參數(shù)列表,只需要真正連接到數(shù)據(jù)庫,執(zhí)行該SQL語句,就可以完成真正的功能。
不到100行代碼,我們就通過metaclass實現(xiàn)了一個精簡的ORM框架。