Python魔法方法怎么用_dunder方法实战讲解【教程】

魔法方法是Python对象行为的底层接口,使类支持打印(__str__用户友好、__repr__开发者调试)、运算(__add__等)、比较(__eq__、__lt__等)和迭代等功能。

Python的魔法方法(也叫dunder方法,即双下划线方法)不是炫技工具,而是让你的对象真正“活起来”的底层接口。用对了,类就能像内置类型一样支持加减、打印、比较、迭代甚至上下文管理。

让对象能被print和str()友好显示:__str__ 与 __repr__

默认情况下,打印自定义对象只看到一串内存地址,很不直观。__str__ 控制用户友好的字符串表示,__repr__ 则面向开发者,要求尽可能精确、可调试(理想情况下 eval(repr(obj)) 能重建对象)。

  • __str__:返回易读描述,比如 "Person(name='Alice', age=30)"
  • __repr__:返回带类型信息的明确表达式,比如 "Person('Alice', 30)"
  • 如果没定义 __str__,print 会自动 fallback 到 __repr__;但 __repr__ 建议始终实现,它是调试时的“第一眼信息”

让对象支持 + - * / 运算:__add__、__sub__ 等算术方法

想让两个 Vector 实例直接相加?或让 Money 类支持金额叠加?不用写 add() 方法,直接实现对应 dunder 方法即可。

  • 定义 __add__(self, other),+ 操作就会调用它;注意检查 other 类型,不支持时返回 NotImplemented(不是异常!),让 Python 尝试调用 other.__radd__
  • 常见算术方法:__sub__(-)、__mul__(*)、__truediv__(/)、__floordiv__(//)、__mod__(%)
  • 反向方法如 __radd__10 + obj 这类左操作数不是本类时起作用,避免报错

让对象可比较、可排序:__eq__、__lt__ 等比较方法

默认的 == 只比内存地址,毫无业务意义。重载比较方法后,对象就能放进 set、做字典键、用 sorted 排序。

  • __eq__(self, other) 决定 == 是否成立(记得同时实现 __hash__ 才能进 set 或作 dict 键)
  • 只需实现 __lt__(__le__(__eq__、__ne____gt__(>)、__ge__(>=)中的部分,配合 functools.total_ordering 装饰器,其余会自动补全
  • 例如:给 Card 类按点数比较,card1 就是自然语义,无需 card1.is_less_than(card2)

让对象支持 with 语法和 for 遍历:__enter__/__exit__ 与 __iter__/__next__

资源管理与迭代是高频需求,dunder 方法让语法糖真正落地。

  • __enter__(self) 返回进入 with 块时的值(常是 self),__exit__(self, exc_type, exc_val, exc_tb) 处理退出逻辑(如关闭文件、回滚事务),无论是否异常都会执行
  • 要支持 for 循环,需实现 __iter__(self) 返回一个迭代器(通常返回 self 或新对象),再在该对象中实现 __next__(self) 返回下一个值,抛出 StopIteration 表示结束
  • 小技巧:若迭代逻辑简单,__iter__ 可直接用 yield 写成生成器函数,Python 自动构造迭代器

不复杂但容易忽略。它们不是必须写的装饰,而是让类融入 Python 生态的契约——写得越自然,别人用起来就越顺手。