Python魔術方法Magic Method的詳細介紹

介紹

　　在Python中，所有以「」雙底線包起來的方法，都統稱為「Magic Method」,例如類別的初始化方法init ,Python中所有的魔術方法均在官方文件中有相應描述，但是對於官方的描述比較混亂而且組織比較鬆散。很難找到有一個例子。

建構和初始化

　　每個Pythoner都知道一個最基本的魔術方法， init 。透過此方法我們可以定義一個物件的初始操作。然而，當呼叫 x = SomeClass() 的時候， init 並不是第一個被呼叫的方法。實際上，還有一個叫做<a href="http://www.php.cn/wiki/165.html" target="_blank">new</a> 的方法，兩個共同構成了「建構子」。

　　new是用來建立類別並傳回這個類別的實例, 而init只是將傳入的參數來初始化該實例。

　　在物件生命週期調用結束時，del 方法會被調用，可以將del理解為「構析函數」。下面透過程式碼的看一看這三個方法:

from os.path import join

class FileObject:
    '''给文件对象进行包装从而确认在删除时文件流关闭'''

    def init(self, filepath='~', filename='sample.txt'):
        #读写模式打开一个文件
        self.file = open(join(filepath, filename), 'r+')

    def del(self):
        self.file.close()
        del self.file

控制屬性訪問

　　許多從其他語言轉到Python的人會抱怨它缺乏類別的真正封裝。 (沒有辦法定義私有變數，然後定義公共的getter和setter)。 Python其實可以用魔術方法來完成封裝。我們來看看:

• getattr(self, name):

　　定義當使用者試圖取得一個不存在的屬性時的行為。這適用於對普通拼字錯誤的獲取和重定向，對獲取一些不建議的屬性時候給出警告(如果你願意你也可以計算並且給出一個值)或者處理一個 AttributeError 。只有當呼叫不存在的屬性的時候會被傳回。

• setattr(self, name, 值):

　　與getattr(self, name)不同，setattr 是一個封裝的解決方案。無論屬性是否存在，它都允許你定義對屬性的賦值行為，以為這你可以對屬性的值進行個性自訂。實作setattr時要避免"無限遞迴"的錯誤。

• delattr:

#　　與setattr 相同，但是功能是刪除一個屬性而不是設置他們。實現時也要防止無限遞歸現象發生。

• getattribute(self, name):

　　getattribute定義了你的屬性被訪問時的行為，相比較，getattr只有該屬性不存在時才會起作用。因此，在支援getattribute的Python版本,呼叫getattr前必定會呼叫 getattribute。 getattribute同樣要避免"無限遞迴"的錯誤。需要提醒的是，最好不要嘗試去實作getattribute,因為很少見到這種做法，而且很容易出bug。

　　在進行屬性存取控制定義的時候很可能會很容易引起「無限遞歸」。如下面程式碼:

#  错误用法
def setattr(self, name, value):
    self.name = value
    # 每当属性被赋值的时候(如self.name = value)， ``setattr()`` 会被调用，这样就造成了递归调用。
    # 这意味这会调用 ``self.setattr('name', value)`` ，每次方法会调用自己。这样会造成程序崩溃。

#  正确用法
def setattr(self, name, value):
    self.dict[name] = value  # 给类中的属性名分配值
    # 定制特有属性

Python的魔術方法很強大，但是用時卻需要慎之又慎，了解正確的使用方法非常重要。

建立自訂容器

　　有很多方法可以讓你的Python類別行為向內建容器類型一樣，例如我們常用的list、dict、tuple、string等等。 Python的容器型別分為可變型別(如list、dict)和不可變型別（如string、tuple），可變容器與不可變容器的差別在於，不可變容器一旦賦值後，就不可對其中的某個元素進行修改。
　　在講創建自訂容器之前，應該先了解下協定。這裡的協定跟其他語言中所謂的"介面"概念很像，它給你很多你必須定義的方法。然而在Python中的協議是很不正式的，不需要明確聲明實作。事實上，他們更像一種指南。

自定义容器的magic method

　　下面细致了解下定义容器可能用到的魔术方法。首先，实现不可变容器的话，你只能定义 len 和 getitem (下面会讲更多)。可变容器协议则需要所有不可变容器的所有，另外还需要 setitem 和 delitem 。如果你希望你的对象是可迭代的话，你需要定义 iter 会返回一个迭代器。迭代器必须遵循迭代器协议，需要有 iter(返回它本身) 和 next。

• len(self):

　　返回容器的长度。对于可变和不可变容器的协议，这都是其中的一部分。

• getitem(self, <a href="http://www.php.cn/wiki/1051.html" target="_blank">key</a>):

　　定义当某一项被访问时，使用self[key]所产生的行为。这也是不可变容器和可变容器协议的一部分。如果键的类型错误将产生TypeError；如果key没有合适的值则产生KeyError。

• setitem(self, key, value):

　　当你执行self[key] = value时，调用的是该方法。

• delitem(self, key):

　　定义当一个项目被删除时的行为(比如 del self[key])。这只是可变容器协议中的一部分。当使用一个无效的键时应该抛出适当的异常。

• iter(self):

　　返回一个容器迭代器，很多情况下会返回迭代器，尤其是当内置的iter()方法被调用的时候，以及当使用for x in container:方式循环的时候。迭代器是它们本身的对象，它们必须定义返回self的iter方法。

• reversed(self):

　　实现当reversed()被调用时的行为。应该返回序列反转后的版本。仅当序列可以是有序的时候实现它，例如对于列表或者元组。

• contains(self, item):

　　定义了调用in和not in来测试成员是否存在的时候所产生的行为。你可能会问为什么这个不是序列协议的一部分？因为当contains没有被定义的时候，如果没有定义，那么Python会迭代容器中的元素来一个一个比较，从而决定返回True或者False。

• missing(self, key):

　　dict字典类型会有该方法，它定义了key如果在容器中找不到时触发的行为。比如d = {'a': 1}, 当你执行d[notexist]时，d.missing['notexist']就会被调用。

一个列子

　　下面是书中的例子，用魔术方法来实现Haskell语言中的一个数据结构。

# -*- coding: utf-8 -*-
class FunctionalList:
    ''' 实现了内置类型list的功能,并丰富了一些其他方法: head, tail, init, last, drop, take'''

    def init(self, values=None):
        if values is None:
            self.values = []
        else:
            self.values = values

    def len(self):
        return len(self.values)

    def getitem(self, key):
        return self.values[key]

    def setitem(self, key, value):
        self.values[key] = value

    def delitem(self, key):
        del self.values[key]

    def iter(self):
        return iter(self.values)

    def reversed(self):
        return FunctionalList(reversed(self.values))

    def append(self, value):
        self.values.append(value)
    def head(self):
        # 获取第一个元素
        return self.values[0]
    def tail(self):
        # 获取第一个元素之后的所有元素
        return self.values[1:]
    def init(self):
        # 获取最后一个元素之前的所有元素
        return self.values[:-1]
    def last(self):
        # 获取最后一个元素
        return self.values[-1]
    def drop(self, n):
        # 获取所有元素，除了前N个
        return self.values[n:]
    def take(self, n):
        # 获取前N个元素
        return self.values[:n]

　　
　　其实在collections模块中已经有了很多类似的实现，比如Counter、OrderedDict等等。

反射

　　你也可以控制怎么使用内置在函数sisinstance()和issubclass()方法 反射定义魔术方法. 这个魔术方法是:

• instancecheck(self, instance):

　　检查一个实例是不是你定义的类的实例

• subclasscheck(self, subclass):
  　　检查一个类是不是你定义的类的子类

　　这些魔术方法的用例看起来很小, 并且确实非常实用. 它们反应了关于面向对象程序上一些重要的东西在Python上,并且总的来说Python: 总是一个简单的方法去找某些事情, 即使是没有必要的. 这些魔法方法可能看起来不是很有用, 但是一旦你需要它们，你会感到庆幸它们的存在。

可调用的对象

　　你也许已经知道，在Python中，方法是最高级的对象。这意味着他们也可以被传递到方法中，就像其他对象一样。这是一个非常惊人的特性。

　　在Python中，一个特殊的魔术方法可以让类的实例的行为表现的像函数一样，你可以调用它们，将一个函数当做一个参数传到另外一个函数中等等。这是一个非常强大的特性，其让Python编程更加舒适甜美。

• call(self, [args...]):

　　允许一个类的实例像函数一样被调用。实质上说，这意味着 x() 与 x.call() 是相同的。注意 call 的参数可变。这意味着你可以定义 call 为其他你想要的函数，无论有多少个参数。

　　call 在那些类的实例经常改变状态的时候会非常有效。调用这个实例是一种改变这个对象状态的直接和优雅的做法。用一个实例来表达最好不过了:

# -*- coding: UTF-8 -*-

class Entity:
    """
    调用实体来改变实体的位置
    """

def init(self, size, x, y):
    self.x, self.y = x, y
    self.size = size


def call(self, x, y):
    """
    改变实体的位置
    """
    self.x, self.y = x, y

上下文管理

　　with声明是从Python2.5开始引进的关键词。你应该遇过这样子的代码:

with open('foo.txt') as bar:
    # do something with bar

　　在with声明的代码段中，我们可以做一些对象的开始操作和退出操作,还能对异常进行处理。这需要实现两个魔术方法: enter 和 exit。

• enter(self):

　　定义了当使用with语句的时候，会话管理器在块被初始创建时要产生的行为。请注意，enter的返回值与with语句的目标或者as后的名字绑定。

• exit(self, <a href="http://www.php.cn/wiki/265.html" target="_blank">exception</a>_type, exception_value, traceback):

　　定义了当一个代码块被执行或者终止后，会话管理器应该做什么。它可以被用来处理异常、执行清理工作或做一些代码块执行完毕之后的日常工作。如果代码块执行成功，exception_type，exception_value，和traceback将会为None。否则，你可以选择处理这个异常或者是直接交给用户处理。如果你想处理这个异常的话，请确保exit在所有语句结束之后返回True。如果你想让异常被会话管理器处理的话，那么就让其产生该异常。

创建对象描述器

　　描述器是通过获取、设置以及删除的时候被访问的类。当然也可以改变其它的对象。描述器并不是独立的。相反，它意味着被一个所有者类持有。当创建面向对象的数据库或者类，里面含有相互依赖的属相时，描述器将会非常有用。一种典型的使用方法是用不同的单位表示同一个数值，或者表示某个数据的附加属性。
　　为了成为一个描述器，一个类必须至少有get，set，<a href="http://www.php.cn/wiki/1298.html" target="_blank">delete</a>方法被实现：

• get(self, instance, owner):

  定义了当描述器的值被取得的时候的行为。instance是拥有该描述器对象的一个实例。owner是拥有者本身

• set(self, instance, value):

  定义了当描述器的值被改变的时候的行为。instance是拥有该描述器类的一个实例。value是要设置的值。

• delete(self, instance):

  定义了当描述器的值被删除的时候的行为。instance是拥有该描述器对象的一个实例。

　　下面是一个描述器的实例：单位转换。

# -*- coding: UTF-8 -*-
class Meter(object):
    """
    对于单位"米"的描述器
    """

    def init(self, value=0.0):
        self.value = float(value)

    def get(self, instance, owner):
        return self.value

    def set(self, instance, value):
        self.value = float(value)


class Foot(object):
    """
    对于单位"英尺"的描述器
    """

    def get(self, instance, owner):
        return instance.meter * 3.2808

    def set(self, instance, value):
        instance.meter = float(value) / 3.2808


class Distance(object):
    """
    用米和英寸来表示两个描述器之间的距离
    """
    meter = Meter(10)
    foot = Foot()

　　使用时：

>>>d = Distance()
>>>print d.foot
>>>print d.meter
32.808
10.0

复制

　　有时候，尤其是当你在处理可变对象时，你可能想要复制一个对象，然后对其做出一些改变而不希望影响原来的对象。这就是Python的copy所发挥作用的地方。

• copy(self):

　　定义了当对你的类的实例调用copy.copy()时所产生的行为。copy.copy()返回了你的对象的一个浅拷贝——这意味着，当实例本身是一个新实例时，它的所有数据都被引用了——例如，当一个对象本身被复制了，它的数据仍然是被引用的（因此，对于浅拷贝中数据的更改仍然可能导致数据在原始对象的中的改变）。

• deepcopy(self, memodict={}):

　　定义了当对你的类的实例调用copy.deepcopy()时所产生的行为。copy.deepcopy()返回了你的对象的一个深拷贝——对象和其数据都被拷贝了。memodict是对之前被拷贝的对象的一个缓存——这优化了拷贝过程并且阻止了对递归数据结构拷贝时的无限递归。当你想要进行对一个单独的属性进行深拷贝时，调用copy.deepcopy()，并以memodict为第一个参数。

附錄

用於比較的魔術方法

定義大於符號的行為，>定義小於等於符號的行為，定義大於等於符號的行為，>=

#Magic method	explain
cmp(self, other)	是比較方法裡面最基本的魔法方法
eq(self, other)	定義相等符號的行為，==
ne(self,other)	定義不等符號的行為，！ =
lt(self,other)	#定義小於符號的行為，
##gt(self,other)
le(self,other)
#ge(self,other)

數值計算的魔術方法

單目

運算子和函數

Magic methodexplain實作一個取正數的運算實作一個取負數的運算實作一個內建的abs()函數的行為實作一個取反實作一個內建的round（）函數的行為ceil(self)trunc(self)雙目運算符或函數

#pos(self)
neg(self)
abs(self)
invert( self)	運算子（～運算子）的行為
round(self, n )
#floor(self)##實現math.floor()的函數行為
實作math.ceil()的函數行為
實作math.trunc()的函數行為

Magic method##add( self, other)#sub(self, other)mul(self, other)floorp(self , other)##p(self, other)#truep(self, other)mod(self, other)pmod(self, other)pow#lshift(self, other)rshift(self, other)and(self, other)or(self, other)除法賦值，相當於/= 運算子真除賦值#模賦值，相當於%= 運算子乘方賦值，相當於**= 運算子左移賦值，相當於左移賦值，相當於>>= 運算子與賦值，相當於&= 運算子或賦值異或運算符，相當於^= 運算子

#explain
實作一個加法
實作一個減法
#實作一個乘法
實作一個「//」運算子產生的整除運算（）
實作一個「/」運算子代表的除法運算
實作真實除法
#實作一個「%」運算子代表的取模運算
實作一個內建函數pmod（）
實作一個指數運算(“**”運算子）的行為
實現一個位元左移運算（
實作一個位元右移運算（ >>）的功能
實作一個位元進行與運算（&）的行為
#實作一個位元進行或運算的行為	##xor(self, other)
xor(self, other)	<p>增量運算</p> <table> <thead><tr class="header firstRow"> <th>Magic method</th> <th>#explain</th> </tr></thead> <tbody> <tr class="odd"> <td><code>iadd(self, 其他)	加法賦值
#isub(self, other)	減法賦值
imul(self, other)	#乘法賦值
ifloorp(self , other)	整除賦值，地板除，相當於//= 運算子
##ip(self, other)
itruep(self, other)
imod_(self, other)
ipow
#ilshift(self, other)
#irshift(self, other)
iand(self, other)
ior(self, other)
ixor(self, other)

#型別轉換

Magic methodexplainlong(self)float(self)浮點型#complex(self)oct(self)hex(self)#index(self)#trunc(self)trunccoerce(self, other)#

#int(self)# #轉換成整數
#轉換成長整數
轉換成
轉換成複數型
轉換成八進位
轉換成十六進位
如果你定義了一個可能被用來做切片運算的數值型，你就應該定義index
當math.trunc(self) 使用時被呼叫	傳回自身型別的整數截取
執行混合型別的運算

以上是Python魔術方法Magic Method的詳細介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！