[toc]
定制類和魔法方法
- new
- str , repr
- iter
- getitem , setitem , delitem
- getattr , setattr , delattr
- call
new
在 Python 中,當(dāng)我們創(chuàng)建一個(gè)類的實(shí)例時(shí)淆两,類會(huì)先調(diào)用 new(cls[, ...]) 來創(chuàng)建實(shí)例铺敌,然后 init 方法再對(duì)該實(shí)例(self)進(jìn)行初始化。
關(guān)于 new 和 init 有幾點(diǎn)需要注意:
new 是在 init 之前被調(diào)用的椅棺;
new 是類方法犁罩,init 是實(shí)例方法;
重載 new 方法两疚,需要返回類的實(shí)例床估;
一般情況下,我們不需要重載 new 方法诱渤。但在某些情況下丐巫,我們想控制實(shí)例的創(chuàng)建過程,這時(shí)可以通過重載 _new 方法來實(shí)現(xiàn)。
class A(object):
_dict = dict()
def __new__(cls):
if 'key' in A._dict:
print "EXISTS"
return A._dict['key']
else:
print "NEW"
return object.__new__(cls)
def __init__(self):
print "INIT"
A._dict['key'] = self
str & repr
class Foo(object):
def __init__(self, name):
self.name = name
def __str__(self):
return 'Foo object (name: %s)' % self.name
def __repr__(self):
return 'Foo object (name: %s)' % self.name
print Foo('ethan') # 使用 print
Foo object (name: ethan)str(Foo('ethan')) # 使用 str
'Foo object (name: ethan)'Foo('ethan') # 直接顯示
<main.Foo at 0x10c37a490>
Foo('ethan') # 使用repr(類中實(shí)現(xiàn))
'Foo object (name: ethan)'
iter
在某些情況下递胧,我們希望實(shí)例對(duì)象可被用于 for...in 循環(huán)碑韵,這時(shí)我們需要在類中定義 iter 和 next(在 Python3 中是 next)方法,其中谓着,iter 返回一個(gè)迭代對(duì)象泼诱,next 返回容器的下一個(gè)元素,在沒有后續(xù)元素時(shí)拋出 StopIteration 異常.
看一個(gè)斐波那契數(shù)列的例子:
class Fib(object):
def __init__(self):
self.a, self.b = 0, 1
def __iter__(self): # 返回迭代器對(duì)象本身
return self
def next(self): # 返回容器下一個(gè)元素
self.a, self.b = self.b, self.a + self.b
return self.a
fib = Fib()
for i in fib:
... if i > 10:
... break
... print i
getitem赊锚、setitem治筒、delitem
geitem 用于獲取值,類似地舷蒲,setitem 用于設(shè)置值耸袜,delitem 用于刪除值,讓我們看下面一個(gè)例子:
class Point(object):
def __init__(self):
self.coordinate = {}
def __str__(self):
return "point(%s)" % self.coordinate
def __getitem__(self, key):
return self.coordinate.get(key)
def __setitem__(self, key, value):
self.coordinate[key] = value
def __delitem__(self, key):
del self.coordinate[key]
print 'delete %s' % key
def __len__(self):
return len(self.coordinate)
__repr__ = __str__
在上面牲平,我們定義了一個(gè) Point 類堤框,它有一個(gè)屬性 coordinate(坐標(biāo)),是一個(gè)字典纵柿,讓我們看看使用:
>>> p = Point()
>>> p['x'] = 2 # 對(duì)應(yīng)于 p.__setitem__('x', 2)
>>> p['y'] = 5 # 對(duì)應(yīng)于 p.__setitem__('y', 5)
>>> p # 對(duì)應(yīng)于 __repr__
point({'y': 5, 'x': 2})
>>> len(p) # 對(duì)應(yīng)于 p.__len__
2
>>> p['x'] # 對(duì)應(yīng)于 p.__getitem__('x')
2
>>> p['y'] # 對(duì)應(yīng)于 p.__getitem__('y')
5
>>> del p['x'] # 對(duì)應(yīng)于 p.__delitem__('x')
delete x
>>> p
point({'y': 5})
>>> len(p)
1
getattr蜈抓、setattr、delattr
當(dāng)我們獲取對(duì)象的某個(gè)屬性昂儒,如果該屬性不存在沟使,會(huì)拋出 AttributeError 異常,比如:
class Point(object):
def __init__(self, x=0, y=0):
self.x = x
self.y = y
>>> p = Point(3, 4)
>>> p.x, p.y
(3, 4)
>>> p.z
---------------------------------------------------------------------------
AttributeError Traceback (most recent call last)
<ipython-input-547-6dce4e43e15c> in <module>()
----> 1 p.z
AttributeError: 'Point' object has no attribute 'z'
那有沒有辦法不讓它拋出異常呢渊跋?當(dāng)然有腊嗡,只需在類的定義中加入 getattr 方法,比如:
class Point(object):
def __init__(self, x=0, y=0):
self.x = x
self.y = y
def __getattr__(self, attr):
if attr == 'z':
return 0
>>> p = Point(3, 4)
>>> p.z
0
現(xiàn)在拾酝,當(dāng)我們調(diào)用不存在的屬性(比如 z)時(shí)燕少,解釋器就會(huì)試圖調(diào)用 getattr(self, 'z') 來獲取值,但是蒿囤,上面的實(shí)現(xiàn)還有一個(gè)問題客们,當(dāng)我們調(diào)用其他屬性,比如 w 蟋软,會(huì)返回 None镶摘,因?yàn)?getattr 默認(rèn)返回就是 None,只有當(dāng) attr 等于 'z' 時(shí)才返回 0岳守,如果我們想讓 getattr 只響應(yīng)幾個(gè)特定的屬性,可以加入異常處理碌冶,修改 getattr 方法湿痢,如下:
def __getattr__(self, attr):
if attr == 'z':
return 0
raise AttributeError("Point object has no attribute %s" % attr)
setattr, delattr
class Point(object):
def __init__(self, x=0, y=0):
self.x = x
self.y = y
def __getattr__(self, attr):
if attr == 'z':
return 0
raise AttributeError("Point object has no attribute %s" % attr)
def __setattr__(self, *args, **kwargs):
print 'call func set attr (%s, %s)' % (args, kwargs)
return object.__setattr__(self, *args, **kwargs)
def __delattr__(self, *args, **kwargs):
print 'call func del attr (%s, %s)' % (args, kwargs)
return object.__delattr__(self, *args, **kwargs)
>>> p = Point(3, 4)
call func set attr (('x', 3), {})
call func set attr (('y', 4), {})
>>> p.z
0
>>> p.z = 7
call func set attr (('z', 7), {})
>>> p.z
7
>>> p.w
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "<stdin>", line 8, in __getattr__
AttributeError: Point object has no attribute w
>>> p.w = 8
call func set attr (('w', 8), {})
>>> p.w
8
>>> del p.w
call func del attr (('w',), {})
>>> p.__dict__
{'y': 4, 'x': 3, 'z': 7}
call
我們一般使用 obj.method() 來調(diào)用對(duì)象的方法,那能不能直接在實(shí)例本身上調(diào)用呢?在 Python 中譬重,只要我們?cè)陬愔卸x call 方法拒逮,就可以對(duì)實(shí)例進(jìn)行調(diào)用,比如下面的例子:
class Point(object):
def __init__(self, x, y):
self.x, self.y = x, y
def __call__(self, z):
return self.x + self.y + z
使用如下:
>>> p = Point(3, 4)
>>> callable(p) # 使用 callable 判斷對(duì)象是否能被調(diào)用
True
>>> p(6) # 傳入?yún)?shù)臀规,對(duì)實(shí)例進(jìn)行調(diào)用滩援,對(duì)應(yīng) p.__call__(6)
13 # 3+4+6
slots
在 Python 中,我們?cè)诙x類的時(shí)候可以定義屬性和方法塔嬉。當(dāng)我們創(chuàng)建了一個(gè)類的實(shí)例后玩徊,我們還可以給該實(shí)例綁定任意新的屬性和方法。
看下面一個(gè)簡(jiǎn)單的例子:
class Point(object):
def __init__(self, x=0, y=0):
self.x = x
self.y = y
>>> p = Point(3, 4)
>>> p.z = 5 # 綁定了一個(gè)新的屬性
>>> p.z
5
>>> p.__dict__
{'x': 3, 'y': 4, 'z': 5}
在上面谨究,我們創(chuàng)建了實(shí)例 p 之后恩袱,給它綁定了一個(gè)新的屬性 z,這種動(dòng)態(tài)綁定的功能雖然很有用胶哲,但它的代價(jià)是消耗了更多的內(nèi)存畔塔。
因此,為了不浪費(fèi)內(nèi)存鸯屿,可以使用 slots 來告訴 Python 只給一個(gè)固定集合的屬性分配空間澈吨,對(duì)上面的代碼做一點(diǎn)改進(jìn),如下:
class Point(object):
__slots__ = ('x', 'y') # 只允許使用 x 和 y
def __init__(self, x=0, y=0):
self.x = x
self.y = y
上面寄摆,我們給 slots 設(shè)置了一個(gè)元組谅辣,來限制類能添加的屬性。現(xiàn)在冰肴,如果我們想綁定一個(gè)新的屬性屈藐,比如 z,就會(huì)出錯(cuò)了熙尉,如下:
>>> p = Point(3, 4)
>>> p.z = 5
---------------------------------------------------------------------------
AttributeError Traceback (most recent call last)
<ipython-input-648-625ed954d865> in <module>()
----> 1 p.z = 5
AttributeError: 'Point' object has no attribute 'z'
注意:
使用 slots 有一點(diǎn)需要注意的是联逻,slots 設(shè)置的屬性僅對(duì)當(dāng)前類有效,對(duì)繼承的子類不起效检痰,除非子類也定義了 slots包归,這樣,子類允許定義的屬性就是自身的 slots 加上父類的 slots铅歼。