7.1.10 特殊方法：Python中的魔法函数

在Python中，特殊方法（也称为魔法方法或双下划线方法）是一类具有特殊命名约定（以双下划线__开头和结尾）的方法。它们为Python的类提供了丰富的接口，允许对象进行诸如算术运算、属性访问、字符串表示、内存管理、比较、迭代等操作时的自定义行为。理解和掌握这些特殊方法对于编写高效、灵活的Python代码至关重要。本章节将深入探讨几种常见的特殊方法，展示它们如何在Python编程中发挥作用。

1. 构造与析构

__init__(self, ...)

__init__是类的初始化方法，当创建类的新实例时自动调用。它用于设置对象的初始状态或执行任何必要的设置。虽然__init__不是严格意义上的特殊方法（因为它在子类中可以被覆盖），但它是对象创建过程中不可或缺的一部分。

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y
p = Point(3, 4)
print(p.x, p.y)  # 输出: 3 4

__del__(self)

__del__是对象的析构方法，当对象即将被垃圾回收器销毁时调用。它通常用于执行清理操作，如关闭文件或释放非托管资源。但需注意，Python的垃圾回收机制并不保证何时会调用__del__，因此不应依赖它来执行关键资源的释放。

class Resource:
    def __init__(self, name):
        self.name = name
        print(f"{name} allocated.")
    def __del__(self):
        print(f"{self.name} deallocated.")
r = Resource("Resource1")
# 当r对象不再被需要时，Python解释器可能会在某个时间点调用其__del__方法

2. 算术运算符重载

Python允许通过定义特殊方法来重载算术运算符，如加（__add__）、减（__sub__）、乘（__mul__）、除（__truediv__）、取模（__mod__）等。

class Vector2D:
    def __init__(self, x, y):
        self.x = x
        self.y = y
    def __add__(self, other):
        return Vector2D(self.x + other.x, self.y + other.y)
    def __mul__(self, scalar):
        return Vector2D(self.x * scalar, self.y * scalar)
v1 = Vector2D(2, 3)
v2 = Vector2D(4, 5)
print(v1 + v2)  # 输出: Vector2D(x=6, y=8)
print(v1 * 2)   # 输出: Vector2D(x=4, y=6)

3. 字符串与表示

__str__(self)

__str__方法定义了对象的“非正式”字符串表示，即使用print()函数或str()函数时调用的方法。

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    def __str__(self):
        return f"{self.name} is {self.age} years old."
p = Person("Alice", 30)
print(p)  # 输出: Alice is 30 years old.

__repr__(self)

__repr__方法定义了对象的“官方”字符串表示，旨在提供一个明确、无歧义的表示，以便可以通过eval()函数重新创建对象。

class Person:
    # 假设这里也定义了__init__
    def __repr__(self):
        return f"Person(name='{self.name}', age={self.age})"
p = Person("Bob", 25)
print(repr(p))  # 输出: Person(name='Bob', age=25)

4. 属性访问

__getattr__(self, name)

当尝试访问的属性不存在时，Python会调用__getattr__方法。这可以用于实现动态属性或懒加载。

class LazyLoad:
    def __init__(self):
        self.data = None
    def fetch_data(self):
        # 模拟从数据库或其他源加载数据
        self.data = "Loaded data"
    def __getattr__(self, name):
        if name == 'data' and self.data is None:
            self.fetch_data()
        return super().__getattr__(name)
ll = LazyLoad()
print(ll.data)  # 触发__getattr__，加载数据并返回

__setattr__(self, name, value)

每当尝试设置对象的属性时，Python都会调用__setattr__方法。使用时要小心，因为直接调用self.name = value会在__setattr__内部再次触发自身，导致无限递归。

class Validator:
    def __setattr__(self, name, value):
        if name == 'age' and not isinstance(value, int):
            raise ValueError("Age must be an integer.")
        super().__setattr__(name, value)
v = Validator()
v.name = "John"  # 正常
try:
    v.age = "thirty"  # 抛出异常
except ValueError as e:
    print(e)

5. 容器方法

__len__(self)

定义了当对容器对象使用内置len()函数时应该返回什么值。

__getitem__(self, key)

定义了当使用索引、切片或迭代来访问对象元素时的行为。

__setitem__(self, key, value)

定义了当通过索引、切片赋值时应该执行什么操作。

__iter__(self)

定义了对象的迭代行为，必须返回一个迭代器。

__contains__(self, item)

定义了使用in关键字时对象的成员测试行为。

6. 比较运算符

Python通过一系列特殊方法支持对象的比较操作，如__eq__（等于）、__ne__（不等于）、__lt__（小于）、__le__（小于等于）、__gt__（大于）、__ge__（大于等于）。

class Number:
    def __init__(self, value):
        self.value = value
    def __eq__(self, other):
        if isinstance(other, Number):
            return self.value == other.value
        return NotImplemented
    # 可以实现其他比较方法...
n1 = Number(5)
n2 = Number(5)
print(n1 == n2)  # 输出: True

结语

特殊方法是Python面向对象编程中的强大工具，它们允许开发者以直观和Pythonic的方式扩展和定制对象的行为。通过理解和熟练使用这些特殊方法，可以编写出更加灵活、强大且易于维护的Python代码。在本章节中，我们探讨了构造与析构、算术运算符重载、字符串与表示、属性访问、容器方法以及比较运算符等几大类特殊方法，它们仅仅是Python中众多特殊方法的一小部分。随着对Python的深入学习，你将发现更多有用的特殊方法，并能够在你的项目中灵活运用它们。