Python中的魔法方法

看到類似 __slots__這種形如__xxx__的變量或者函數(shù)名就要注意，這些在Python中是有特殊用途的。

__slots__我們已經(jīng)知道怎么用了，__len__方法我們也知道是為了能讓class作用于 len() 函數(shù)。

這些在Python有另外的一些名稱叫魔術(shù)方法

除此之外，Python的class中還有許多這斜體樣式樣有特殊用途的函數(shù)，可以幫助我們定制！

1.__str__

用于定制對(duì)象的描述信息

我們先定義一個(gè) Student 類，打印一個(gè)實(shí)例：

>>> class Student(object):
?? ?def __init__(self, name):
?? ??? ?self.name = name
>>> print(Student('張三'))
<__main__.Student object at 0x000001AC142D3370>
>>>?

打印出一堆<__main__.Student object at 0x000001AC142D3370>, 不好看。

怎么才能打印得好看呢？只需要定義好 __str__() 方法，返回一個(gè)好看的字符串就可以了：

# -*- coding: utf-8 -*-
class Person(object):
    def __init__(self, name):
        self.name = name
    # 用于定制對(duì)象的描述信息
    def __str__(self):
        return "Person object (name:%s)" % self.name
if __name__ == '__main__':
    p = Person('張三')
    print(p)

這樣打印出來的實(shí)例，不但好看，而且容易看出實(shí)例內(nèi)部重要的數(shù)據(jù)。

2.__iter__

如果一個(gè)類想被用于 for ... in 循環(huán)，類似list或tuple那樣，就必須實(shí)現(xiàn)一個(gè) __iter__()方法，該方法返回一個(gè)迭代對(duì)象，然后，Python的for循環(huán)就會(huì)不斷調(diào)用該迭代對(duì)象的 __next__() 方法拿到循環(huán)的下一個(gè)值，直到遇StopIteration 錯(cuò)誤時(shí)退出循環(huán)。

我們以斐波那契數(shù)列為例，寫一個(gè)Fib類，可以作用于for循環(huán)：

class Fib(object):
    # Fib默認(rèn)不是可迭代對(duì)象，變成一個(gè)可迭代對(duì)象，必須返回一個(gè)迭代器
    def __init__(self):
        self.a, self.b = 0, 1  # 斐波那契數(shù)列前兩個(gè)固定的值
    # 重寫 __iter__方法，F(xiàn)ib變?yōu)榭傻鷮?duì)象
    def __iter__(self):
        return self
    # 重寫__next__方法，F(xiàn)ib就變成一個(gè)迭代器
    def __next__(self):
        self.a, self.b = self.b, self.a + self.b  # 計(jì)算下一個(gè)值
        if self.a > 1000:
            raise StopIteration
        return self.a
if __name__ == '__main__':
    print('小于1000的所有斐波那契數(shù):', end=' ')
    for i in Fib():
        print(i, end=' ')

3.__getitem__

Fib實(shí)例雖然能作用于for循環(huán)，看起來和list有點(diǎn)像，但是，把它當(dāng)成list來使用還是不行，比如，取第5個(gè)元素：

>>> 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)取出元素，需要實(shí)現(xiàn) __getitem__() 方法：

# -*- coding: utf-8 -*-
class Fib(object):
    # 重寫__getitem__,Fib 可以類似于 list
    def __getitem__(self, item):
        a, b = 1, 1
        for x in range(item):
            a, b = b, a+b
        return a

現(xiàn)在，就可以按下標(biāo)訪問數(shù)列的任意一項(xiàng)了

if __name__ == '__main__':
    f = Fib()
    print(f[5])
    print(f[6])
    print(f[10])
    print(f[15]) 

輸出：

但是list有個(gè)神奇的切片方法：

>>> list(range(100)[5:10])
[5, 6, 7, 8, 9]

對(duì)于Fib卻報(bào)錯(cuò)。原因是 __getitem__() 傳入的參數(shù)可能是一個(gè)int，也可能是一個(gè)切片對(duì)象 slice ，所以要做判斷

# -*- coding: utf-8 -*-
class Fib(object):
    def __getitem__(self, item):  # # item是一個(gè)下標(biāo), 也有可能是一個(gè)切片
        if isinstance(item, int):  # item 是一個(gè) int 下標(biāo)
            a, b = 1, 1
            for _ in range(item):   # rage(item) 用作循環(huán)次數(shù)
                a, b = b, a+b
            return a
        elif isinstance(item, slice):  # item 是一個(gè)切片（范圍）
            start = item.start
            stop = item.stop
            if start is None:
                start = 0  # start初始值為 0 
            a, b = 1, 1
            l = []
            for _ in range(stop):
                l.append(a)
                a, b = b, a+b
            return l

現(xiàn)在試試Fib的切片：

if __name__ == '__main__':
    print(Fib()[9])
    print(Fib()[1:10])

輸出：

但是沒有對(duì)step參數(shù)作處理：

>>> f[:10:2]?
[1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

也沒有對(duì)負(fù)數(shù)作處理，所以，要正確實(shí)現(xiàn)一個(gè) __getitem__() 還是有很多工作要做的。

此外，如果把對(duì)象看成 dict ， __getitem__() 的參數(shù)也可能是一個(gè)可以作key的object，例如 str 。

與之對(duì)應(yīng)的是 __setitem__() 方法，把對(duì)象視作list或dict來對(duì)集合賦值。最后，還有一個(gè) __delitem__() 方法，用于刪除某個(gè)元素。

總之，通過上面的方法，我們自己定義的類表現(xiàn)得和Python自帶的list、tuple、dict沒什么區(qū)別，這完全歸功于動(dòng)態(tài)語(yǔ)言的“鴨子類型”，不需要強(qiáng)制繼承某個(gè)接口。

4.__getattr__

正常情況下，當(dāng)我們調(diào)用類的方法或?qū)傩詴r(shí)，如果不存在，就會(huì)報(bào)錯(cuò)。比如定義 Student 類：

class Student(object):
    def __init__(self):
        self.name = 'Michale'

調(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'

錯(cuò)誤信息很清楚地告訴我們，沒有找到 score 這個(gè)attribute。

要避免這個(gè)錯(cuò)誤，除了可以加上一個(gè) score 屬性外，Python還有另一個(gè)機(jī)制，那就是寫一個(gè) __getattr__() 方法，動(dòng)態(tài)返回一個(gè)屬性。修改如下：

class Student(object):
    def __init__(self):
        self.name = 'Michale'
    def __getattr__(self, item):
        if item == 'score':
            return 99     

當(dāng)調(diào)用不存在的屬性時(shí)，比如 score ，Python解釋器會(huì)試圖調(diào)用 __getattr__(self, 'score') 來嘗試獲得屬性，這樣，我們就有機(jī)會(huì)返回 score 的值：

>>> s = Student()?
>>> s.name?
'Michael'?
>>> s.score?
99
>>>

返回函數(shù)也是完全可以的：

class Student(object):
	def __getattr__(self, start):
		if attr == 'age':
			return lambda : 25

只是調(diào)用方法變?yōu)椋?/p>

>>> s,age()
25

注意，只有在沒有找到屬性的情況下，才調(diào)用 __getattr__ ，已有的屬性，比如 name ，不會(huì)在 __getattr__中查找。

此外，注意到任意調(diào)用如 s.abc 都會(huì)返回 None ，這是因?yàn)槲覀兌x的 __getattr__ 默認(rèn)返回就是 None 。要讓class只響應(yīng)特定的幾個(gè)屬性，我們就要按照約定，拋出 AttributeError 的錯(cuò)誤：

class Student(object):
    def __getattr__(self, attr):
        if attr == 'age':
            return lambda: 25
        raise AttributeError('\'Student\' object has no attribute \'%s\'' % attr)

這實(shí)際上可以把一個(gè)類的所有屬性和方法調(diào)用全部動(dòng)態(tài)化處理了，不需要任何特殊手段。

這種完全動(dòng)態(tài)調(diào)用的特性有什么實(shí)際作用呢？作用就是，可以針對(duì)完全動(dòng)態(tài)的情況作調(diào)用。

5.__call__

一個(gè)對(duì)象實(shí)例可以有自己的屬性和方法，當(dāng)我們調(diào)用實(shí)例方法時(shí)，我們用instance.method() 來調(diào)用。

能不能直接在實(shí)例本身上調(diào)用呢？在Python中，答案是肯定的。

任何類，只需要定義一個(gè) __call__() 方法，就可以直接對(duì)實(shí)例進(jìn)行調(diào)用。請(qǐng)看示例：

class Student(object):
    def __init__(self, name):
        self.name = name
    def __call__(self, *args, **kwargs):
        print('My name is %s.' % self.name)   

調(diào)用方式如下：

>>> s = Student('awei')
>>> s() ?# self參數(shù)不要傳入
My name is awei.

__call__() 還可以定義參數(shù)。對(duì)實(shí)例進(jìn)行直接調(diào)用就好比對(duì)一個(gè)函數(shù)進(jìn)行調(diào)用一樣，所以你完全可以把對(duì)象看成函數(shù)，把函數(shù)看成對(duì)象，因?yàn)檫@兩者之間本來就沒啥根本的區(qū)別。

如果你把對(duì)象看成函數(shù)，那么函數(shù)本身其實(shí)也可以在運(yùn)行期動(dòng)態(tài)創(chuàng)建出來，因?yàn)轭惖膶?shí)例都是運(yùn)行期創(chuàng)建出來的，這么一來，我們就模糊了對(duì)象和函數(shù)的界限。

那么，怎么判斷一個(gè)變量是對(duì)象還是函數(shù)呢？其實(shí)，更多的時(shí)候，我們需要判斷一個(gè)對(duì)象是否能被調(diào)用，能被調(diào)用的對(duì)象就是一個(gè) Callable 對(duì)象，比如函數(shù)和我們上面定義的帶有 __call__() 的類實(shí)例：

>>> callable(Student())?
True?
>>> callable(max)?
True?
>>> callable([1, 2, 3])?
False?
>>> callable(None)?
False?
>>> callable('str')?
False

通過 callable() 函數(shù)，我們就可以判斷一個(gè)對(duì)象是否是“可調(diào)用”對(duì)象。