python 魔術方法 : 讓自訂類別更像內建類型

Python的魔術方法是Python中那些預先定義的像__XXX__類型的函數。

使用Python的魔術方法的最大優勢在於python提供了簡單的方法讓物件可以表現得像內建類型一樣。

__str__函數

__str__函數用於處理列印實例本身的時候的輸出內容。如果沒有覆寫函數，則預設輸出一個物件名稱和記憶體位址。

例如：

>>> class Student(object):
...     def __init__(self,name):
...             self._name = name
...
>>> print Student()

輸出：

<__main__.Student 
object at 0x0000000002A929E8>.

那麼我們如何讓輸出的結果可讀性更高一點呢？我們可以覆寫__str__函數。例如

>>> class Student(object):
...     def __init__(self, name):
...             self._name = name
...     def __str__(self):
...             return  "I'm a student, named %s" % self._name
...
>>> print Student("Charlie")

輸出結果就是：

I'm a student, named Charlie.

我們將str()函數作用於此物件的時候，其實是呼叫了該物件的__str__函數。

__repr__ 函數

__repr__也是將物件序列化，但是__repr__更多的是給python編譯器看的。 __str__更多的是可讀性(readable)。

我們將repr()函數作用於摸某一個物件的時候，呼叫的其實就是該函數的__repr__函數。

與repr()成對的是eval()函數。 eval()函數是將序列化後的物件重新轉為物件。前提是該物件實作了__repr__函數。

上面這一段話是基於自己的理解，不知道對錯。

>>> item = [1,2,3]
>>> repr(item)
'[1, 
2, 3]'
>>> other_item = eval(repr(item))
>>> other_item[1]
2

__iter__函數

我們常對list或tuple使用for…in…來迭代。那是list繼承自Iterable。 Iterable實作了__iter__函數。

要想將一個自訂的物件變成一個可迭代的對象，那麼必須實現兩個方法：__iter__和next.

__iter__函數傳回一個物件。迭代的時候則會不斷地呼叫next函數拿到下一個值，直到捕獲到StopIteration停止。

廖雪峰老師教程裡寫的是__next__方法，不知道為啥。

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
        if self.a > 10000:
            raise StopIteration
        return self.a
 
 
for i in Fib():
    print i

__getitem__函數

上面透過實作__iter__函數實現物件的迭代。

那麼如何實現物件按下標取出元素呢。

這是透過實作物件的__getitem__方法。

我們來舉一個