파이썬 매직 메소드 - 매직 메소드

Shao

Python에서는 클래스 초기화 메소드 __init__과 같이 "__" 이중 밑줄로 묶인 모든 메소드를 총칭하여 "Magic Method"라고 합니다. 문서에는 해당 설명이 있지만 공식적인 설명은 혼란스럽고 느슨하게 구성되어 있습니다. 예를 찾기가 어렵습니다.

구성 및 초기화

모든 Python 사용자는 가장 기본적인 매직 메소드인 __init__ 를 알고 있습니다. 이 방법을 통해 우리는 객체의 초기 동작을 정의할 수 있습니다. 그러나 x = SomeClass()가 호출될 때 __init__는 호출되는 첫 번째 메서드가 아닙니다. 실제로 __new__라는 메서드도 있는데, 이 두 개가 함께 "생성자"를 형성합니다.

__new__는 클래스를 생성하고 이 클래스의 인스턴스를 반환하는 데 사용되는 반면, __init__는 전달된 매개 변수로 인스턴스를 초기화합니다.

객체 수명 주기 호출이 끝나면 __del__ 메서드가 호출되며 __del__은 "소멸자"로 이해될 수 있습니다. 코드를 통해 이 세 가지 방법을 살펴보겠습니다.

from os.path import joinclass 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, value):

__getattr__(self, name)과 달리 __setattr__은 캡슐화된 솔루션입니다. 속성의 존재 여부에 관계없이 속성에 대한 할당 동작을 정의하여 속성 값을 사용자 정의할 수 있습니다. __setattr__을 구현할 때 "무한 재귀" 오류를 방지하세요.

__delattr__:

__setattr__과 동일하지만 속성을 설정하는 대신 삭제하는 기능입니다. 구현 시 무한 재귀를 방지하는 것도 필요합니다.

__getattribute__(self, name):

__getattribute__는 속성에 액세스할 때의 동작을 정의합니다. 이에 비해 __getattr__은 속성이 존재하지 않는 경우에만 작동합니다. 따라서 __getattribute__를 지원하는 Python 버전에서는 __getattr__을 호출하기 전에 __getattribute__를 호출해야 합니다. __getattribute__는 "무한 재귀" 오류도 방지해야 합니다. __getattribute__를 구현하지 않는 것이 가장 좋다는 점을 기억해야 합니다. 왜냐하면 이 접근 방식은 거의 보이지 않고 버그를 일으키기 쉽기 때문입니다.

속성 액세스 제어를 정의할 때 "무한 재귀"가 쉽게 발생할 수 있습니다. 예를 들어, 다음 코드는 다음과 같습니다.

#  错误用法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 클래스가 일반적으로 사용되는 목록, 딕셔너리, 튜플, 문자열 등 내장 컨테이너 유형처럼 동작하도록 만드는 방법은 많습니다. Python의 컨테이너 유형은 변수 유형(예: list, dict)과 불변 유형(예: 문자열, 튜플)으로 구분됩니다. 변수 컨테이너와 불변 컨테이너의 차이점은 일단 값이 불변 컨테이너에 할당되면 그 중 하나는 변경할 수 없다는 것입니다. 수정됩니다. 요소가 수정됩니다.
커스텀 컨테이너 생성에 대해 이야기하기 전에 먼저 프로토콜을 이해해야 합니다. 여기서의 프로토콜은 다른 언어의 소위 "인터페이스" 개념과 매우 유사하며 정의해야 하는 많은 메서드를 제공합니다. 그러나 Python의 프로토콜은 매우 비공식적이며 명시적인 구현 선언이 필요하지 않습니다. 사실 그들은 가이드에 더 가깝습니다.

커스텀 컨테이너의 마법같은 방법

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

__len__(self):

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

__getitem__(self, key):

　　定义当某一项被访问时，使用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 = sizedef __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, exception_type, exception_value, traceback):

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

创建对象描述器

　　描述器是通过获取、设置以及删除的时候被访问的类。当然也可以改变其它的对象。描述器并不是独立的。相反，它意味着被一个所有者类持有。当创建面向对象的数据库或者类，里面含有相互依赖的属相时，描述器将会非常有用。一种典型的使用方法是用不同的单位表示同一个数值，或者表示某个数据的附加属性。
　　为了成为一个描述器，一个类必须至少有__get__，__set__，__delete__方法被实现：

__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.2808class Distance(object):
    """
    用米和英寸来表示两个描述器之间的距离
    """
    meter = Meter(10)
    foot = Foot()

　使用时：

>>>d = Distance()
>>>print d.foot
>>>print d.meter
32.80810.0

复制

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

__copy__(self):

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

__deepcopy__(self, memodict={}):

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

附录

用于比较的魔术方法

数值计算的魔术方法

单目运算符和函数

双目运算符或函数

增量运算

类型转换