Python中的魔法方法

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

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

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

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

1.__str__

用于定制對象的描述信息

我們先定義一個 Student 類，打印一個實例：

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

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

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

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

這樣打印出來的實例，不但好看，而且容易看出實例內部重要的數據。

2.__iter__

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

我們以斐波那契數列為例，寫一個Fib類，可以作用于for循環：

class Fib(object):
    # Fib默認不是可迭代對象，變成一個可迭代對象，必須返回一個迭代器
    def __init__(self):
        self.a, self.b = 0, 1  # 斐波那契數列前兩個固定的值
    # 重寫 __iter__方法，Fib變為可迭代對象
    def __iter__(self):
        return self
    # 重寫__next__方法，Fib就變成一個迭代器
    def __next__(self):
        self.a, self.b = self.b, self.a + self.b  # 計算下一個值
        if self.a > 1000:
            raise StopIteration
        return self.a
if __name__ == '__main__':
    print('小于1000的所有斐波那契數:', end=' ')
    for i in Fib():
        print(i, end=' ')

3.__getitem__

Fib實例雖然能作用于for循環，看起來和list有點像，但是，把它當成list來使用還是不行，比如，取第5個元素：

>>> Fib()[5]
Traceback (most recent call last):?
?? ?File "<stdin>", line 1, in <module>?
TypeError: 'Fib' object does not support indexing
>>>

要表現得像list那樣按照下標取出元素，需要實現 __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

現在，就可以按下標訪問數列的任意一項了

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

輸出：

但是list有個神奇的切片方法：

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

對于Fib卻報錯。原因是 __getitem__() 傳入的參數可能是一個int，也可能是一個切片對象 slice ，所以要做判斷

# -*- coding: utf-8 -*-
class Fib(object):
    def __getitem__(self, item):  # # item是一個下標, 也有可能是一個切片
        if isinstance(item, int):  # item 是一個 int 下標
            a, b = 1, 1
            for _ in range(item):   # rage(item) 用作循環次數
                a, b = b, a+b
            return a
        elif isinstance(item, slice):  # item 是一個切片（范圍）
            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

現在試試Fib的切片：

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

輸出：

但是沒有對step參數作處理：

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

也沒有對負數作處理，所以，要正確實現一個 __getitem__() 還是有很多工作要做的。

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

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

總之，通過上面的方法，我們自己定義的類表現得和Python自帶的list、tuple、dict沒什么區別，這完全歸功于動態語言的“鴨子類型”，不需要強制繼承某個接口。

4.__getattr__

正常情況下，當我們調用類的方法或屬性時，如果不存在，就會報錯。比如定義 Student 類：

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

調用 name 屬性，沒問題，但是，調用不存在的 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__() 方法，動態返回一個屬性。修改如下：

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

當調用不存在的屬性時，比如 score ，Python解釋器會試圖調用 __getattr__(self, 'score') 來嘗試獲得屬性，這樣，我們就有機會返回 score 的值：

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

返回函數也是完全可以的：

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

只是調用方法變為：

>>> s,age()
25

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

此外，注意到任意調用如 s.abc 都會返回 None ，這是因為我們定義的 __getattr__ 默認返回就是 None 。要讓class只響應特定的幾個屬性，我們就要按照約定，拋出 AttributeError 的錯誤：

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

這實際上可以把一個類的所有屬性和方法調用全部動態化處理了，不需要任何特殊手段。

這種完全動態調用的特性有什么實際作用呢？作用就是，可以針對完全動態的情況作調用。

5.__call__

一個對象實例可以有自己的屬性和方法，當我們調用實例方法時，我們用instance.method() 來調用。

能不能直接在實例本身上調用呢？在Python中，答案是肯定的。

任何類，只需要定義一個 __call__() 方法，就可以直接對實例進行調用。請看示例：

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

調用方式如下：

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

__call__() 還可以定義參數。對實例進行直接調用就好比對一個函數進行調用一樣，所以你完全可以把對象看成函數，把函數看成對象，因為這兩者之間本來就沒啥根本的區別。

如果你把對象看成函數，那么函數本身其實也可以在運行期動態創建出來，因為類的實例都是運行期創建出來的，這么一來，我們就模糊了對象和函數的界限。

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

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

通過 callable() 函數，我們就可以判斷一個對象是否是“可調用”對象。