探索Python魔法方法：定制类的神奇力量-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00935/article/details/148783097

探索Python魔法方法：定制类的神奇力量

explore-python :green_book: The Beauty of Python Programming. 项目地址: https://gitcode.com/gh_mirrors/ex/explore-python

什么是魔法方法

在Python中，魔法方法（Magic Method）是指那些以双下划线__开头和结尾的特殊方法。这些方法为Python类提供了特殊功能，让我们能够定制类的行为。最常见的魔法方法如__init__，用于初始化实例属性。

魔法方法之所以"神奇"，是因为它们会在特定情况下被Python解释器自动调用，而不需要我们显式地去调用它们。这为我们的编程提供了极大的便利和灵活性。

对象创建：`new`与`init`

在Python中，创建一个类的实例时，实际上会经历两个阶段：

__new__方法负责创建实例
__init__方法负责初始化实例

它们的主要区别在于：

__new__是类方法，__init__是实例方法
__new__必须返回创建的实例，__init__不需要返回值
__new__在__init__之前被调用

通常情况下我们不需要重写__new__，但在需要控制实例创建过程时（如实现单例模式），它就派上用场了。

class Singleton:
    _instance = None
    
    def __new__(cls):
        if not cls._instance:
            cls._instance = super().__new__(cls)
        return cls._instance

对象表示：`str`与`repr`

这两个方法都用于对象的字符串表示，但用途不同：

__str__：面向用户的可读性好的描述，用于print()和str()
__repr__：面向开发者的准确描述，用于直接查看对象和repr()

最佳实践是至少实现__repr__，因为它可以作为__str__的备选：

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y
    
    def __repr__(self):
        return f"Point({self.x}, {self.y})"
    
    __str__ = __repr__  # 让str和repr表现一致

使对象可迭代：`iter`与`next`

要让对象支持for...in循环，需要实现迭代器协议：

__iter__方法返回迭代器对象本身
__next__方法返回下一个值，没有值时抛出StopIteration

class CountDown:
    def __init__(self, start):
        self.current = start
    
    def __iter__(self):
        return self
    
    def __next__(self):
        if self.current <= 0:
            raise StopIteration
        num = self.current
        self.current -= 1
        return num

下标访问：`getitem`系列

通过实现__getitem__、__setitem__和__delitem__，可以让对象支持类似字典的下标操作：

class ShoppingCart:
    def __init__(self):
        self.items = {}
    
    def __getitem__(self, product):
        return self.items.get(product, 0)
    
    def __setitem__(self, product, quantity):
        self.items[product] = quantity
    
    def __delitem__(self, product):
        del self.items[product]

属性访问控制：`getattr`系列

当访问不存在的属性时，Python会调用__getattr__。结合__setattr__和__delattr__可以实现属性访问的精细控制：

class DynamicAttributes:
    def __getattr__(self, name):
        print(f"获取不存在的属性: {name}")
        return 0
    
    def __setattr__(self, name, value):
        print(f"设置属性 {name} = {value}")
        super().__setattr__(name, value)

使对象可调用：`call`

实现__call__方法可以让实例像函数一样被调用：

class Adder:
    def __init__(self, n):
        self.n = n
    
    def __call__(self, x):
        return self.n + x

add5 = Adder(5)
print(add5(3))  # 输出8