Pythonのマジックメソッドを詳しく解説-Python チュートリアル-php.cn

はじめに

Pythonでは、二重アンダースコア「__」で囲まれたメソッドを総称して「マジックメソッド」と呼びます。たとえば、クラスの初期化メソッド__init__など、Pythonのすべてのマジックメソッドが存在します。は公式ドキュメントの対応する説明ですが、公式の説明はわかりにくく、大まかに整理されています。例を見つけるのは難しいです。

構築と初期化

すべての Pythoner は、最も基本的なマジックメソッドの 1 つである __init__ を知っています。このメソッドを通じて、オブジェクトの初期操作を定義できます。ただし、x = SomeClass() が呼び出されるとき、__init__ は最初に呼び出されるメソッドではありません。実際には __new__ というメソッドもあり、この 2 つを合わせて「コンストラクター」を構成します。

__new__ はクラスを作成し、このクラスのインスタンスを返すために使用されますが、__init__ は渡されたパラメーターでインスタンスを初期化するだけです。

オブジェクトのライフサイクル呼び出しの最後に、__del__ メソッドが呼び出され、__del__ は「デストラクター」として理解できます。これら 3 つのメソッドをコードを通して見てみましょう:

from os.path import join
class FileObject:
    &#39;&#39;&#39;给文件对象进行包装从而确认在删除时文件流关闭&#39;&#39;&#39;
    def __init__(self, filepath=&#39;~&#39;, filename=&#39;sample.txt&#39;):
        #读写模式打开一个文件
        self.file = open(join(filepath, filename), &#39;r+&#39;)
    def __del__(self):
        self.file.close()
        del self.file

ログイン後にコピー

属性アクセスの制御

他の言語から Python に乗り換えた多くの人は、Python には実際のクラスのカプセル化が欠けていると不満を言うでしょう。 (プライベート変数を定義してからパブリックのゲッターとセッターを定義する方法はありません)。 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__(&#39;name&#39;, value)`` ，每次方法会调用自己。这样会造成程序崩溃。
#  正确用法
def __setattr__(self, name, value):
    self.__dict__[name] = value  # 给类中的属性名分配值
    # 定制特有属性

ログイン後にコピー

Python のマジックメソッドは非常に強力ですが、使用には注意が必要です。正しい使用方法を理解することが非常に重要です。

カスタムコンテナを作成する

よく使用されるリスト、辞書、タプル、文字列など、Python クラスを組み込みのコンテナタイプのように動作させる方法はたくさんあります。 Python のコンテナータイプは、変数タイプ (リスト、辞書など) と不変タイプ (文字列、タプルなど) に分けられます。変数コンテナーと不変コンテナーの違いは、値が不変コンテナーに割り当てられると、そのうちの 1 つは変更できないことです。要素が変更されます。

カスタムコンテナの作成について話す前に、まずプロトコルを理解する必要があります。ここでのプロトコルは、他の言語のいわゆる「インターフェイス」の概念に非常に似ており、定義する必要があるメソッドが多数提供されます。ただし、Python のプロトコルは非常に非公式であり、明示的な実装宣言は必要ありません。実際、それらはガイドに似ています。

カスタムコンテナのマジックメソッド

コンテナの定義に使用できるマジックメソッドを詳しく見てみましょう。まず、不変コンテナを実装する場合、定義できるのは __len__ と __getitem__ のみです (詳細は後述します)。可変コンテナープロトコルには、すべての不変コンテナーに加えて、 __setitem__ および __delitem__ が必要です。オブジェクトを反復可能にしたい場合は、反復子を返す __iter__ を定義する必要があります。イテレータは、__iter__ (それ自体を返す) と next を必要とするイテレータプロトコルに従う必要があります。

__len__(self):

ログイン後にコピー

コンテナの長さを返します。これはすべて、変更可能コンテナと不変更コンテナの両方のプロトコルの一部です。

__getitem__(self, key):

ログイン後にコピー

アイテムにアクセスしたときにself[key]を使って生成される動作を定義します。これは、不変コンテナと可変コンテナのプロトコルの一部でもあります。キーのタイプが間違っている場合は TypeError が発生し、キーに適切な値がない場合は KeyError が発生します。

__setitem__(self, key, value):

ログイン後にコピー

self[key] = valueを実行すると、このメソッドが呼び出されます。

__delitem__(self, key):

ログイン後にコピー

アイテムが削除されたときの動作を定義します（del self[key]など）。これは可変コンテナープロトコルの一部にすぎません。無効なキーが使用された場合は、適切な例外がスローされる必要があります。

__iter__(self):

ログイン後にコピー

コンテナイテレータを返す多くの場合、特に組み込みの iter() メソッドが呼び出されたとき、および for x incontainer: メソッドがループに使用されたときに、イテレータが返されます。イテレータはそれ自体がオブジェクトであり、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:
    &#39;&#39;&#39; 实现了内置类型list的功能,并丰富了一些其他方法: head, tail, init, last, drop, take&#39;&#39;&#39;
    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(&#39;foo.txt&#39;) 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.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为第一个参数。