当前位置：首页 > article >正文

Python 中的魔法方法有哪些？

article 2025/3/5 6:12:57

在Python中，魔法方法（也称为特殊方法或魔术方法）是带有双下划线前缀和后缀的方法。

这些方法允许你定义对象的行为，比如如何响应特定的操作符或内置函数调用。

它们对于实现面向对象编程中的高级功能非常重要，例如自定义容器、迭代器、上下文管理器等。

以下是一些常见的魔法方法及其用途，并附有代码示例。

我们将以一个简单的Vector类为例，展示如何使用这些魔法方法来创建更加直观和功能丰富的类。

1. `init`

构造函数，当创建一个新的类实例时自动调用。

class Vector:
    def __init__(self, x=0, y=0):
        self.x = x
        self.y = y

2. `str` 和 `repr`

用于定义对象的字符串表示形式，分别对应于用户友好的输出和调试信息。

    def __str__(self):
        return f'Vector({self.x}, {self.y})'

    def __repr__(self):
        return f'Vector(x={self.x}, y={self.y})'

3. `add`, `sub`, `mul`, `truediv`

定义了二元操作符的行为，如加法、减法、乘法和除法。

    def __add__(self, other):
        return Vector(self.x + other.x, self.y + other.y)

    def __sub__(self, other):
        return Vector(self.x - other.x, self.y - other.y)

    def __mul__(self, scalar):
        return Vector(self.x * scalar, self.y * scalar)

    def __truediv__(self, scalar):
        if scalar != 0:
            return Vector(self.x / scalar, self.y / scalar)
        else:
            raise ValueError("Cannot divide by zero")

4. `eq`, `lt`, `gt`

用于比较两个对象。

    def __eq__(self, other):
        return self.x == other.x and self.y == other.y

    def __lt__(self, other):
        return (self.x**2 + self.y**2) < (other.x**2 + other.y**2)

    def __gt__(self, other):
        return (self.x**2 + self.y**2) > (other.x**2 + other.y**2)

5. `getitem` 和 `setitem`

允许对象像列表或字典一样被索引。

    def __getitem__(self, index):
        if index == 0: return self.x
        elif index == 1: return self.y
        else: raise IndexError("Index out of range")

    def __setitem__(self, index, value):
        if index == 0: self.x = value
        elif index == 1: self.y = value
        else: raise IndexError("Index out of range")

6. `len`

返回对象的长度，适用于需要长度概念的对象。

    def __len__(self):
        return 2  # Since our vector is always a 2D vector

7. `iter` 和 `next`

使得对象可以迭代，通常与生成器一起使用。

    def __iter__(self):
        yield self.x
        yield self.y

8. `enter` 和 `exit`

实现了上下文管理协议，允许对象在with语句中使用。

    def __enter__(self):
        print("Entering context")
        return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        print("Exiting context")
        # Handle exception if any, cleanup resources, etc.