# 定制类和é”法方法
在 Python ä¸ï¼Œæˆ‘们å¯ä»¥ç»å¸¸çœ‹åˆ°ä»¥åŒä¸‹åˆ’线 `__` 包裹起æ¥çš„方法，比如最常è§çš„ `__init__`，这些方法被称为**é”法方法（magic method）或特殊方法（special method）**。简å•åœ°è¯´ï¼Œè¿™äº›æ–¹æ³•å¯ä»¥ç»™ Python çš„ç±»æ供特殊功能，方便我们定制一个类，比如 `__init__` 方法å¯ä»¥å¯¹å®žä¾‹å±žæ€§è¿›è¡Œåˆå§‹åŒ–。
完整的特殊方法列表å¯åœ¨[这里](https://docs.python.org/2/reference/datamodel.html#special-method-names)查看，本文介ç»éƒ¨åˆ†å¸¸ç”¨çš„特殊方法：
- `__new__`
- `__str__` , `__repr__`
- `__iter__`
- `__getitem__` , `__setitem__` , `__delitem__`
- `__getattr__` , `__setattr__` , `__delattr__`
- `__call__`
# new
在 Python ä¸ï¼Œå½“我们创建一个类的实例时，类会先调用 `__new__(cls[, ...])` æ¥åˆ›å»ºå®žä¾‹ï¼Œç„¶åŽ `__init__` 方法å†å¯¹è¯¥å®žä¾‹ï¼ˆself）进行åˆå§‹åŒ–。
关于 `__new__` å’Œ `__init__` æœ‰å‡ ç‚¹éœ€è¦æ³¨æ„：
- `__new__` 是在 `__init__` 之å‰è¢«è°ƒç”¨çš„ï¼›
- `__new__` 是类方法，`__init__` 是实例方法；
- é‡è½½ `__new__` 方法，需è¦è¿”回类的实例；
一般情况下，我们ä¸éœ€è¦é‡è½½ `__new__` 方法。但在æŸäº›æƒ…况下，我们想**控制实例的创建过程**，这时å¯ä»¥é€šè¿‡é‡è½½ `__new_` 方法æ¥å®žçŽ°ã€‚
让我们看一个例å：
```python
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
```
在上é¢ï¼Œæˆ‘们定义了一个类 `A`，并é‡è½½äº† `__new__` 方法：当 `key` 在 `A._dict` ä¸æ—¶ï¼Œç›´æŽ¥è¿”回 `A._dict['key']`，å¦åˆ™åˆ›å»ºå®žä¾‹ã€‚
执行情况：
```
>>> a1 = A()
NEW
INIT
>>> a2 = A()
EXISTS
INIT
>>> a3 = A()
EXISTS
INIT
```
# str & repr
先看一个简å•çš„例å：
```python
class Foo(object):
def __init__(self, name):
self.name = name
>>> print Foo('ethan')
<__main__.Foo object at 0x10c37aa50>
```
在上é¢ï¼Œæˆ‘们使用 print 打å°ä¸€ä¸ªå®žä¾‹å¯¹è±¡ï¼Œä½†å¦‚果我们想打å°æ›´å¤šä¿¡æ¯å‘¢ï¼Œæ¯”如把 name 也打å°å‡ºæ¥ï¼Œè¿™æ—¶ï¼Œæˆ‘们å¯ä»¥åœ¨ç±»ä¸åŠ å…¥ `__str__` 方法，如下：
```python
class Foo(object):
def __init__(self, name):
self.name = name
def __str__(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>
```
å¯ä»¥çœ‹åˆ°ï¼Œä½¿ç”¨ print å’Œ str 输出的是 `__str__` 方法返回的内容，但如果直接显示则ä¸æ˜¯ï¼Œé‚£èƒ½ä¸èƒ½ä¿®æ”¹å®ƒçš„输出呢？当然å¯ä»¥ï¼Œæˆ‘们åªéœ€åœ¨ç±»ä¸åŠ å…¥ `__repr__` 方法，比如：
```python
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
>>> Foo('ethan')
'Foo object (name: ethan)'
```
å¯ä»¥çœ‹åˆ°ï¼ŒçŽ°åœ¨ç›´æŽ¥ä½¿ç”¨ `Foo('ethan')` 也å¯ä»¥æ˜¾ç¤ºæˆ‘们想è¦çš„结果了，然而，我们å‘现上é¢çš„代ç ä¸ï¼Œ`__str__` å’Œ `__repr__` 方法的代ç æ˜¯ä¸€æ ·çš„ï¼Œèƒ½ä¸èƒ½ç²¾ç®€ä¸€ç‚¹å‘¢ï¼Œå½“然å¯ä»¥ï¼Œå¦‚下：
```python
class Foo(object):
def __init__(self, name):
self.name = name
def __str__(self):
return 'Foo object (name: %s)' % self.name
__repr__ = __str__
```
# iter
在æŸäº›æƒ…况下，我们希望实例对象å¯è¢«ç”¨äºŽ `for...in` 循环，这时我们需è¦åœ¨ç±»ä¸å®šä¹‰ `__iter__` å’Œ `next`（在 Python3 ä¸æ˜¯ `__next__`）方法，其ä¸ï¼Œ`__iter__` 返回一个è¿ä»£å¯¹è±¡ï¼Œ`next` è¿”å›žå®¹å™¨çš„ä¸‹ä¸€ä¸ªå…ƒç´ ï¼Œåœ¨æ²¡æœ‰åŽç»å…ƒç´ 时抛出 `StopIteration` 异常。
看一个æ–波那契数列的例å：
```python
class Fib(object):
def __init__(self):
self.a, self.b = 0, 1
def __iter__(self): # 返回è¿ä»£å™¨å¯¹è±¡æœ¬èº«
return self
def next(self): # 返回容器下一个元ç´
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
...
1
1
2
3
5
8
```
# getitem
有时，我们希望å¯ä»¥ä½¿ç”¨ `obj[n]` è¿™ç§æ–¹å¼å¯¹å®žä¾‹å¯¹è±¡è¿›è¡Œå–值，比如对æ–波那契数列，我们希望å¯ä»¥å–出其ä¸çš„æŸä¸€é¡¹ï¼Œè¿™æ—¶æˆ‘们需è¦åœ¨ç±»ä¸å®žçŽ° `__getitem__` 方法，比如下é¢çš„例å：
```python
class Fib(object):
def __getitem__(self, n):
a, b = 1, 1
for x in xrange(n):
a, b = b, a + b
return a
>>> fib = Fib()
>>> fib[0], fib[1], fib[2], fib[3], fib[4], fib[5]
(1, 1, 2, 3, 5, 8)
```
我们还想更进一æ¥ï¼Œå¸Œæœ›æ”¯æŒ `obj[1:3]` è¿™ç§åˆ‡ç‰‡æ–¹æ³•æ¥å–值，这时 `__getitem__` æ–¹æ³•ä¼ å…¥çš„å‚æ•°å¯èƒ½æ˜¯ä¸€ä¸ªæ•´æ•°ï¼Œä¹Ÿå¯èƒ½æ˜¯ä¸€ä¸ªåˆ‡ç‰‡å¯¹è±¡ sliceï¼Œå› æ¤ï¼Œæˆ‘们需è¦å¯¹ä¼ 入的å‚数进行判æ–，å¯ä»¥ä½¿ç”¨ `isinstance` 进行判æ–，改åŽçš„代ç 如下：
```python
class Fib(object):
def __getitem__(self, n):
if isinstance(n, slice): # 如果 n 是 slice 对象
a, b = 1, 1
start, stop = n.start, n.stop
L = []
for i in xrange(stop):
if i >= start:
L.append(a)
a, b = b, a + b
return L
if isinstance(n, int): # 如果 n 是 int 型
a, b = 1, 1
for i in xrange(n):
a, b = b, a + b
return a
```
现在，我们试试用切片方法：
```python
>>> fib = Fib()
>>> fib[0:3]
[1, 1, 2]
>>> fib[2:6]
[2, 3, 5, 8]
```
上é¢ï¼Œæˆ‘们åªæ˜¯ç®€å•åœ°æ¼”示了 getitem çš„æ“作，但是它还很ä¸å®Œå–„，比如没有对负数处ç†ï¼Œä¸æ”¯æŒå¸¦ step å‚数的切片æ“作 `obj[1:2:5]` ç‰ç‰ï¼Œè¯»è€…有兴趣的è¯å¯ä»¥è‡ªå·±å®žçŽ°çœ‹çœ‹ã€‚
`__geitem__` 用于获å–值，类似地，`__setitem__` 用于设置值，`__delitem__` ç”¨äºŽåˆ é™¤å€¼ï¼Œè®©æˆ‘ä»¬çœ‹ä¸‹é¢ä¸€ä¸ªä¾‹å：
```python
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__
```
在上é¢ï¼Œæˆ‘们定义了一个 Point 类，它有一个属性 coordinate（åæ ‡ï¼‰ï¼Œæ˜¯ä¸€ä¸ªå—典，让我们看看使用：
```python
>>> p = Point()
>>> p['x'] = 2 # 对应于 p.__setitem__('x', 2)
>>> p['y'] = 5 # 对应于 p.__setitem__('y', 5)
>>> p # 对应于 __repr__
point({'y': 5, 'x': 2})
>>> len(p) # 对应于 p.__len__
2
>>> p['x'] # 对应于 p.__getitem__('x')
2
>>> p['y'] # 对应于 p.__getitem__('y')
5
>>> del p['x'] # 对应于 p.__delitem__('x')
delete x
>>> p
point({'y': 5})
>>> len(p)
1
```
# getattr
当我们获å–对象的æŸä¸ªå±žæ€§ï¼Œå¦‚果该属性ä¸å˜åœ¨ï¼Œä¼šæŠ›å‡º AttributeError 异常，比如：
```python
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)