Python マジックメソッドの詳細な紹介 Magic Method

はじめに

Pythonでは、クラスの初期化メソッドinitや、Pythonの魔法のメソッド 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, value):

　　与getattr(self, name)不同，setattr 是一个封装的解决方案。无论属性是否存在，它都允许你定义对对属性的赋值行为，以为这你可以对属性的值进行个性定制。实现setattr时要避免"无限递归"的错误。

• delattr:

　　与 setattr 相同，但是功能是删除一个属性而不是设置他们。实现时也要防止无限递归现象发生。

• getattribute(self, name):

　　getattribute定义了你的属性被访问时的行为，相比较，getattr只有该属性不存在时才会起作用。因此，在支持getattribute的Python版本,调用getattr前必定会调用 getattribute。getattribute同样要避免"无限递归"的错误。需要提醒的是，最好不要尝试去实现getattribute はすべて公式ドキュメントに記載されていますが、公式の説明はわかりにくく、整理も大雑把です。例を見つけるのは難しいです。

構築と初期化

すべての Pythoner は、最も基本的なマジック メソッドである init を知っています。このメソッドを通じて、オブジェクト

の初期操作を定義できます。ただし、x = SomeClass

() が呼び出された場合、init は実行されません。最初に呼び出されたメソッドではありません。実際には、<a href="http://www.php.cn/wiki/165.html" target="_blank">new</a>

というメソッドもあり、これらを合わせて " コンストラクター

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

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

#  错误用法
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  # 给类中的属性名分配值
    # 定制特有属性

🎜Control attribute 🎜Access🎜🎜 からの多く他の言語から Python に来た人は、Python にはクラスの真のカプセル化が欠けていると不満を言うでしょう。 (プライベート 変数 🎜 を定義してから、パブリックのゲッターとセッターを定義する方法はありません)。 Python は実際に魔法のメソッドを通じてカプセル化を完了できます。見てみましょう: 🎜

• 🎜getattr(self, name):🎜

🎜 ユーザーがいつ存在しないプロパティを取得するときの動作を試行します。これは、一般的なタイプミスを取得してリダイレクトしたり、非推奨の属性を取得するときに警告を表示したり (必要に応じて値を計算して指定することもできます)、 AttributeError を処理したりする場合に便利です。存在しないプロパティを呼び出した場合にのみ返されます。 🎜

• 🎜setattr(self, name, value):🎜

🎜 および getattr(self 、name) は異なります。setattr はカプセル化されたソリューションです。属性が存在するかどうかに関係なく、属性への割り当て動作を定義できるため、属性の値をカスタマイズできます。 setattr を実装するときは、「無限再帰🎜」のエラーを回避してください。 🎜

• 🎜delattr:🎜

🎜 setattr と同じですが、関数is プロパティを設定する代わりに削除します。実装中に無限再帰を防ぐことも必要です。 🎜

• 🎜getattribute(self, name):🎜

🎜 getattribute 定義対照的に、getattr は属性が存在しない場合にのみ機能します。したがって、getattribute をサポートする Python バージョンでは、getattr を呼び出す前に getattribute を呼び出す必要があります。 getattribute も「無限再帰」エラーを避ける必要があります。 getattribute を実装しようとしないことが最善であることに注意してください。このアプローチはめったに見られず、バグが発生しやすいためです。 🎜🎜 属性アクセス制御を定義すると、「無限再帰」が起こりやすくなります。次のコードのように: 🎜

# -*- 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]

🎜Python のマジックメソッドは非常に強力ですが、使用には注意が必要です。正しい使用方法を理解することが非常に重要です。 🎜🎜カスタム コンテナを作成する🎜🎜 Python クラスを、よく使用されるリスト、辞書、タプル、🎜文字列🎜 などの組み込みコンテナ タイプのように動作させる方法はたくさんあります。 Python のコンテナ タイプは、変数タイプ (リスト、辞書など) と不変タイプ (文字列、タプルなど) に分類されます。要素が変更されます。 🎜 カスタムコンテナの作成について話す前に、まずプロトコルを理解する必要があります。ここでのプロトコルは、他の言語のいわゆる「インターフェイス」の概念に非常に似ており、定義する必要があるメソッドが多数提供されます。ただし、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为第一个参数。

付録

比較のためのマジックメソッド

マジックメソッド	説明
cmp(self, other)cmp(self, other)	是比较方法里面最基本的的魔法方法
eq(self, other)	定义相等符号的行为，==
ne(self,other)	定义不等符号的行为，！=
lt(self,other)	定义小于符号的行为，<
gt(self,other)	定义大于符号的行为，>
le(self,other)	定义小于等于符号的行为，<=
ge(self,other)	定义大于等于符号的行为，>=

数值计算的魔术方法

单目运算符和函数

Magic method	explain
pos(self)	实现一个取正数的操作
neg(self)	实现一个取负数的操作
abs(self)	实现一个内建的abs()函数的行为
invert(self)	实现一个取反操作符（～操作符）的行为
round(self, n)	实现一个内建的round（）函数的行为
floor(self)	实现math.floor()的函数行为
ceil(self)	实现math.ceil()的函数行为
trunc(self)	实现math.trunc()的函数行为

双目运算符或函数

は、比較メソッドの中で最も基本的なマジックです。

Magic method	explain
add(self, other)	实现一个加法
sub(self, other)	实现一个减法
mul(self, other)	实现一个乘法
floorp(self, other)	实现一个“//”操作符产生的整除操作（）
p(self, other)	实现一个“/”操作符代表的除法操作
truep(self, other)	实现真实除法
mod(self, other)	实现一个“%”操作符代表的取模操作
pmod(self, other)	实现一个内建函数pmod（）
pow	实现一个指数操作(“**”操作符）的行为
lshift(self, other)	实现一个位左移操作（<<）的功能
rshift(self, other)	实现一个位右移操作（>>）的功能
and(self, other)	实现一个按位进行与操作（&）的行为
or(self, other)	实现一个按位进行或操作的行为
xor(self, other)	xor(self, other)

eq(self, other)🎜🎜 は、等号記号 ==🎜🎜🎜🎜ne(self, other) の動作を定義します。 code>🎜🎜不等号の動作を定義します! =🎜🎜🎜lt(self,other)🎜🎜は、不等号記号の動作を定義します。<🎜🎜🎜🎜gt(self,other) )</ code>🎜🎜 は大なり記号の動作を定義し、>🎜🎜</tr> <tr class="even">🎜<code>le(self,other)🎜🎜 は小なり記号の動作を定義します以上の記号、<=🎜🎜 🎜🎜ge(self,other)🎜🎜以上の記号の動作を定義します、>=🎜🎜🎜🎜🎜数値のマジック メソッド計算🎜

単眼演算子と関数

🎜🎜🎜🎜マジックメソッド🎜🎜説明します🎜🎜🎜🎜🎜🎜 pos(self)🎜🎜正の数を取る演算を実装します🎜🎜 🎜neg(self)🎜🎜負の数を取る演算を実装します🎜🎜🎜 🎜abs(self)🎜🎜組み込みのabs()関数の動作を実装します🎜🎜 🎜 invert(self)🎜🎜実装 否定の動作演算子 (~operator)🎜🎜🎜🎜round(self, n)🎜🎜組み込みのround()関数の動作を実装します🎜🎜 🎜 Floor(self)🎜🎜は、floor()の関数動作を実装します🎜🎜🎜🎜ceil(self)🎜🎜は、math.ceil()の関数動作を実装します🎜🎜🎜trunc(self) 🎜🎜 math.trunc() の関数の動作を実装します🎜🎜🎜🎜

二項演算子または関数

🎜🎜🎜🎜マジックメソッド🎜🎜説明🎜🎜🎜🎜🎜🎜 add(self, other)🎜🎜加算を実装します🎜🎜 🎜sub(self, other)🎜🎜減算を実装します🎜🎜🎜🎜<code>mul(self, other)🎜🎜乗算を実装します🎜🎜🎜floorp(self, other) 🎜🎜は「//」演算子を実装します 生成された整数除算演算 ()🎜🎜🎜🎜p(self, other)🎜🎜は「/」演算子で表される除算演算を実装します🎜🎜 🎜 truep(self, other)🎜🎜真の除算を実装します🎜🎜🎜🎜mod(self, other)🎜🎜 a を実装します「%」演算子で表されるモジュロ演算🎜🎜 🎜pmod(self, other)🎜🎜組み込み関数 pmod() を実装します🎜🎜🎜🎜pow🎜🎜は指数演算 (" **" 演算子) の動作を実装します🎜🎜 🎜lshift(self, other)🎜🎜 の関数を実装しますビット左シフト演算 (<<)🎜🎜 🎜🎜rshift(self, other)🎜🎜ビット右シフト演算の関数を実装します (>>)🎜🎜 🎜and(self, other )🎜🎜 ビットごとの AND 演算 (&) の動作を実装します🎜🎜🎜🎜or(self, other)🎜 🎜ビット単位の OR 演算の動作を実装します🎜🎜🎜xor(self, other)🎜🎜xor(self, other)🎜🎜 🎜🎜

インクリメント演算

マジックメソッド	explain
iadd(self, other)iadd(self, other)	加法赋值
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)	异或运算符，相当于 ^= 运算符

类型转换

追加代入 isub(self, other)

Magic method	explain
int(self)	转换成整型
long(self)	转换成长整型
float(self)	转换成浮点型
complex(self)	转换成 复数型
oct(self)	转换成八进制
hex(self)	转换成十六进制
index(self)	如果你定义了一个可能被用来做切片操作的数值型，你就应该定义index
trunc(self)	当 math.trunc(self) 使用时被调用trunc返回自身类型的整型截取
coerce(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)🎜🎜XOR 演算子、^= 演算子🎜 🎜🎜🎜🎜型変換🎜🎜🎜🎜🎜マジックメソッド🎜🎜 Explain🎜🎜🎜🎜🎜🎜int (self)🎜🎜整数型に変換🎜🎜 🎜long(self)🎜🎜long整数型に変換🎜🎜🎜🎜float( self)🎜🎜 は 浮動小数点型🎜🎜 🎜complex(self)🎜🎜を複数型に変換🎜🎜🎜🎜oct(self)🎜🎜 octalに変換🎜🎜 🎜hex(self)🎜🎜16 進数に変換します🎜🎜🎜🎜index(self)🎜🎜 スライスに使用できる数値型を定義する場合trunc を使用する場合は、 math.trunc( self) を呼び出すときに、index🎜🎜 🎜trunc(self)🎜🎜 を定義する必要があります。独自の型の整数インターセプトを返します🎜🎜🎜🎜coerce(self, other)🎜🎜混合型演算を実行します🎜🎜🎜🎜

以上がPython マジックメソッドの詳細な紹介 Magic Methodの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。