Python的运算符重载 __iter__()和 __next__()

本文介绍了Python中的运算符重载概念及其实现方法,包括构造函数、加减运算、字符串表达形式、索引取值和赋值等,并通过多个示例展示了如何在自定义类中实现这些重载。

   Python语言提供了运算符重载功能,增强了语言的灵活性,这一点与C++有点类似又有些不同。鉴于它的特殊性,今天就来讨论一下Python运算符重载。

      Python语言本身提供了很多魔法方法,它的运算符重载就是通过重写这些Python内置魔法方法实现的。这些魔法方法都是以双下划线开头和结尾的,类似于__X__的形式,python通过这种特殊的命名方式来拦截操作符,以实现重载。当Python的内置操作运用于类对象时,Python会去搜索并调用对象中指定的方法完成操作。

       类可以重载加减运算、打印、函数调用、索引等内置运算,运算符重载使我们的对象的行为与内置对象的一样。Python在调用操作符时会自动调用这样的方法,例如,如果类实现了__add__方法,当类的对象出现在+运算符中时会调用这个方法。

常见运算符重载方法

方法名

重载说明

运算符调用方式

__init__

构造函数

对象创建: X = Class(args)

__del__

析构函数

X对象收回

__add__/__sub__

加减运算

 X+Y, X+=Y/X-Y, X-=Y

__or__

运算符|

X|Y, X|=Y

_repr__/__str__

打印/转换

print(X)、repr(X)/str(X)

__call__

函数调用

X(*args, **kwargs)

__getattr__

属性引用

X.undefined

__setattr__

属性赋值

X.any=value

__delattr__

属性删除

del X.any

__getattribute__

属性获取

X.any

__getitem__

索引运算

X[key],X[i:j]

__setitem__

索引赋值

X[key],X[i:j]=sequence

__delitem__

索引和分片删除

del X[key],del X[i:j]

__len__

长度

len(X)

__bool__

布尔测试

bool(X)

__lt__, __gt__, 

__le__, __ge__, 

__eq__, __ne__

特定的比较

依次为X<Y,X>Y,X<=Y,X>=Y, 

X==Y,X!=Y 

注释:(lt: less than, gt: greater than, 

  le: less equal, ge: greater equal, 

  eq: equal, ne: not equal 

__radd__

右侧加法

other+X

__iadd__

实地(增强的)加法

X+=Y(or else __add__)

__iter__, __next__

迭代

I=iter(X), next()

__contains__

成员关系测试

item in X(X为任何可迭代对象)

__index__

整数值

hex(X), bin(X),  oct(X)

__enter__, __exit__

环境管理器

with obj as var:

__get__, __set__, 

__delete__

描述符属性

X.attr, X.attr=value, del X.attr

__new__

创建

在__init__之前创建对象


       下面对常用的运算符方法的使用进行一下介绍。

构造函数和析构函数:__init__和__del__

       它们的主要作用是进行对象的创建和回收,当实例创建时,就会调用__init__构造方法。当实例对象被收回时,析构函数__del__会自动执行。

[python]  view plain  copy
  1. >>> class Human():  
  2. ...     def __init__(self, n):  
  3. ...         self.name = n  
  4. ...             print("__init__ ",self.name)  
  5. ...     def __del__(self):  
  6. ...         print("__del__")  
  7. ...   
  8. >>> h = Human('Tim')  
  9. __init__  Tim  
  10. >>> h = 'a'  
  11. __del__  

加减运算:__add__和__sub__

       重载这两个方法就可以在普通的对象上添加+-运算符操作。下面的代码演示了如何使用+-运算符,如果将代码中的__sub__方法去掉,再调用减号运算符就会出错。

[python]  view plain  copy
  1. >>> class Computation():  
  2. ...     def __init__(self,value):  
  3. ...         self.value = value  
  4. ...     def __add__(self,other):  
  5. ...         return self.value + other  
  6. ...     def __sub__(self,other):  
  7. ...         return self.value - other  
  8. ...   
  9. >>> c = Computation(5)  
  10. >>> c + 5  
  11. 10  
  12. >>> c - 3  
  13. 2  

对象的字符串表达形式:__repr__和__str__

       这两个方法都是用来表示对象的字符串表达形式:print()、str()方法会调用到__str__方法,print()、str()和repr()方法会调用__repr__方法。从下面的例子可以看出,当两个方法同时定义时,Python会优先搜索并调用__str__方法。

[python]  view plain  copy
  1. >>> class Str(object):  
  2. ...     def __str__(self):  
  3. ...         return "__str__ called"      
  4. ...     def __repr__(self):  
  5. ...         return "__repr__ called"  
  6. ...   
  7. >>> s = Str()  
  8. >>> print(s)  
  9. __str__ called  
  10. >>> repr(s)  
  11. '__repr__ called'  
  12. >>> str(s)  
  13. '__str__ called'  

索引取值和赋值:__getitem__, __setitem__

       通过实现这两个方法,可以通过诸如 X[i] 的形式对对象进行取值和赋值,还可以对对象使用切片操作。

[python]  view plain  copy
  1. >>> class Indexer:  
  2.     data = [1,2,3,4,5,6]  
  3.     def __getitem__(self,index):  
  4.         return self.data[index]  
  5.     def __setitem__(self,k,v):  
  6.         self.data[k] = v  
  7.         print(self.data)  
  8. >>> i = Indexer()  
  9. >>> i[0]  
  10. 1  
  11. >>> i[1:4]  
  12. [234]  
  13. >>> i[0]=10  
  14. [1023456]  

设置和访问属性:__getattr__、__setattr__

       我们可以通过重载__getattr__和__setattr__来拦截对对象成员的访问。__getattr__在访问对象中不存在的成员时会自动调用。__setattr__方法用于在初始化对象成员的时候调用,即在设置__dict__的item时就会调用__setattr__方法。具体例子如下:

[python]  view plain  copy
  1. class A():  
  2.     def __init__(self,ax,bx):  
  3.         self.a = ax  
  4.         self.b = bx  
  5.     def f(self):  
  6.         print (self.__dict__)  
  7.     def __getattr__(self,name):  
  8.         print ("__getattr__")  
  9.     def __setattr__(self,name,value):  
  10.         print ("__setattr__")  
  11.         self.__dict__[name] = value  
  12.   
  13. a = A(1,2)  
  14. a.f()  
  15. a.x  
  16. a.x = 3  
  17. a.f()  

       上面代码的运行结果如下,从结果可以看出,访问不存在的变量x时会调用__getattr__方法;当__init__被调用的时候,赋值运算也会调用__setattr__方法。

[python]  view plain  copy
  1. __setattr__  
  2. __setattr__  
  3. {'a'1'b'2}  
  4. __getattr__  
  5. __setattr__  
  6. {'a'1'x'3'b'2}  

迭代器对象: __iter__,  __next__

       Python中的迭代,可以直接通过重载__getitem__方法来实现,看下面的例子。

[python]  view plain  copy
  1. >>> class Indexer:  
  2. ...     data = [1,2,3,4,5,6]  
  3. ...     def __getitem__(self,index):  
  4. ...             return self.data[index]  
  5. ...   
  6. >>> x = Indexer()  
  7. >>> for item in x:  
  8. ...     print(item)  
  9. ...   
  10. 1  
  11. 2  
  12. 3  
  13. 4  
  14. 5  
  15. 6  
       通过上面的方法是可以实现迭代,但并不是最好的方式。Python的迭代操作会优先尝试调用__iter__方法,再尝试__getitem__。迭代环境是通过iter去尝试寻找__iter__方法来实现,而这种方法返回一个迭代器对象。如果这个方法已经提供,Python会重复调用迭代器对象的next()方法,直到发生StopIteration异常。如果没有找到__iter__,Python才会尝试使用__getitem__机制。下面看一下迭代器的例子。
[python]  view plain  copy
  1. class Next(object):  
  2.     def __init__(self, data=1):  
  3.         self.data = data  
  4.     def __iter__(self):  
  5.         return self  
  6.     def __next__(self):  
  7.         print("__next__ called")  
  8.         if self.data > 5:  
  9.             raise StopIteration  
  10.         else:  
  11.             self.data += 1  
  12.             return self.data  
  13. for i in Next(3):  
  14.     print(i)  
  15. print("-----------")  
  16. n = Next(3)  
  17. i = iter(n)  
  18. while True:  
  19.     try:  
  20.         print(next(i))  
  21.     except Exception as e:  
  22.         break  
       程序的运行结果如下:

[python]  view plain  copy
  1. __next__ called  
  2. 4  
  3. __next__ called  
  4. 5  
  5. __next__ called  
  6. 6  
  7. __next__ called  
  8. -----------  
  9. __next__ called  
  10. 4  
  11. __next__ called  
  12. 5  
  13. __next__ called  
  14. 6  
  15. __next__ called  
       可见实现了__iter__和__next__方法后,可以通过for in的方式迭代遍历对象,也可以通过iter()和next()方法迭代遍历对象。
<think>我们正在讨论Python中所有双下划线开头结尾的属性方法。这类名称在Python中被称为“魔术方法”(Magic Methods)或“特殊方法”(Special Methods)。它们由Python语言定义,用于实现对象的特定行为。根据引用[1][2][4]的内容,这些方法在特定的操作中被Python解释器自动调用。 关键点: 1. 双下划线开头结尾(如`__init__`, `__str__`)的方法是Python内置的特殊方法,用于重载运算符或定义对象的特定行为。 2. 这些方法不是普通的函数,必须定义在类中。 3. 双下划线开头结尾的变量(属性)也是特殊用途的,但相对较少,通常用于表示一些特殊含义(如模块的`__name__`,类的`__doc__`等)。 我们将从以下几个方面进行说明: 一、常见的特殊方法(魔术方法) 二、特殊属性 三、使用场景注意事项 一、常见的特殊方法(魔术方法) 根据引用[1][4],以下是一些常见的魔术方法: 1. 对象创建初始化: - `__new__(cls, ...)`: 创建实例时调用的静态方法(第一个参数是类),返回实例对象。 - `__init__(self, ...)`: 初始化实例,在`__new__`之后调用。 2. 字符串表示: - `__str__(self)`: 定义对象的“非正式”字符串表示,用于`str(obj)``print(obj)`。 - `__repr__(self)`: 定义对象的“正式”字符串表示,通常用于交互式解释器调试,应尽可能返回一个可以用于重建对象的字符串表达式。 3. 运算符重载: - 算术运算符:`__add__(self, other)`, `__sub__(self, other)`, `__mul__(self, other)`, `__truediv__(self, other)`, `__mod__(self, other)`等。 - 比较运算符:`__eq__(self, other)`, `__ne__(self, other)`, `__lt__(self, other)`, `__le__(self, other)`, `__gt__(self, other)`, `__ge__(self, other)`。 - 其他运算符:`__invert__(self)`(按位取反`~`),`__neg__(self)`(负号`-`),`__pos__(self)`(正号`+`)等。 4. 容器序列操作: - `__len__(self)`: 返回容器长度,用于`len(obj)`。 - `__getitem__(self, key)`: 获取索引对应的元素,用于`obj[key]`。 - `__setitem__(self, key, value)`: 设置索引对应的元素,用于`obj[key]=value`。 - `__delitem__(self, key)`: 删除索引对应的元素,用于`del obj[key]`。 - `__contains__(self, item)`: 定义`in`操作符的行为。 5. 迭代器协议: - `__iter__(self)`: 返回一个迭代器对象,通常用于`for`循环。 - `__next__(self)`: 迭代器对象需要实现的方法,返回下一个元素。 6. 上下文管理(`with`语句): - `__enter__(self)`: 进入上下文时调用,返回的对象赋值给`as`后面的变量。 - `__exit__(self, exc_type, exc_value, traceback)`: 离开上下文时调用,用于处理异常清理资源。 7. 属性访问控制: - `__getattr__(self, name)`: 当访问不存在的属性时调用。 - `__setattr__(self, name, value)`: 设置属性时调用(包括直接赋值`setattr`函数)。 - `__delattr__(self, name)`: 删除属性时调用。 - `__getattribute__(self, name)`: 访问任何属性时都会调用(包括存在的不存在的)。 8. 描述符(Descriptor)协议(用于实现属性、方法绑定等高级特性): - `__get__(self, instance, owner)`: 当描述符被读取时调用。 - `__set__(self, instance, value)`: 当描述符被设置时调用。 - `__delete__(self, instance)`: 当描述符被删除时调用。 二、特殊属性 除了方法,Python也有一些双下划线开头结尾的特殊属性: 1. `__name__`:对象的名字,如模块、类、函数的名字。 2. `__doc__`:对象的文档字符串(docstring)。 3. `__module__`:定义对象的模块名。 4. `__class__`:对象的类。 5. `__dict__`:对象属性的字典(参见之前的问题)。 6. `__slots__`:限制实例可以拥有的属性(用于内存优化)。 7. `__annotations__`:包含类型注解的字典(Python 3.6+)。 8. `__bases__`:类的基类元组。 三、使用场景注意事项 1. 特殊方法通常由Python解释器隐式调用,不建议直接调用(除非你知道自己在做什么)。 2. 特殊属性由Python内部设置,通常只读(除了`__dict__`等少数可写)。 3. 自定义类中实现特殊方法可以实现运算符重载、对象行为定制等高级功能。 4. 引用[3]指出:双下划线开头并结尾的变量(如`__var__`)会继承给子类,类似于普通属性。而双下划线开头但没有结尾(如`__var`)的变量是私有变量,会触发名称修饰(Name Mangling),即变成`_类名__var`的形式,这样可以避免子类中的命名冲突[^3][^4][^5]。 5. 模块级别的特殊属性:模块也有`__name__`、`__file__`、`__package__`等属性。 示例代码: 定义一个类,展示几个特殊方法的使用: ```python class Vector: def __init__(self, x, y): self.x = x self.y = y def __str__(self): return f'Vector({self.x}, {self.y})' def __add__(self, other): return Vector(self.x + other.x, self.y + other.y) def __eq__(self, other): return self.x == other.x and self.y == other.y # 使用 v1 = Vector(2, 4) v2 = Vector(3, 1) print(v1 + v2) # 调用__add__,然后调用__str__:Vector(5, 5) print(v1 == v2) # 调用__eq__:False ``` 关于特殊属性,我们可以查看上面Vector类的属性: ```python print(Vector.__name__) # 输出 'Vector' print(Vector.__module__) # 输出 '__main__'(如果是直接运行) ``` 注意:在模块级别,我们也可以定义一些特殊属性(比如`__doc__`用于模块文档),但通常不建议在模块级别定义太多自己的双下划线属性,以免与Python内置的特殊属性冲突。 总结: 双下划线开头结尾的名称是Python中用于特殊目的的标识符,它们赋予了类特殊的能力,使得自定义类可以像内置类型一样行为。同时,Python也提供了一些特殊属性用于获取对象的元信息。 §§相关问题§§ 1. 名称修饰(Name Mangling)的具体规则是什么?私有变量如何访问? 2. 描述符协议(Descriptor Protocol)在实际开发中有哪些应用场景? 3. 除了常见的魔术方法,Python中还有哪些较少用但功能强大的特殊方法? </think>### Python 双下划线开头结尾的属性方法详解(`__xxx__`) 在 Python 中,以双下划线开头结尾的标识符(如 `__init__`, `__str__`)被称为**特殊方法**或**魔术方法**(Magic Methods)。它们由 Python 语言定义,用于实现对象的特定行为,在特定操作时会被解释器自动调用[^1][^4]。以下是完整分类说明: #### 一、核心功能分类 1. **对象生命周期方法** ```python __new__(cls) # 创建实例时调用(构造函数之前) __init__(self) # 对象初始化(最常用)[^1] __del__(self) # 对象销毁时调用(析构函数) ``` 2. **字符串表示方法** ```python __str__(self) # 定义 print(obj) 的输出[^1] __repr__(self) # 定义解释器直接显示的对象表示 __format__(self) # 定义 format() 函数的格式化行为 ``` 3. **运算符重载方法** ```python __add__(self, other) # 实现 + 运算 (a + b) __sub__(self, other) # 实现 - 运算 (a - b)[^1] __mul__(self, other) # 实现 * 运算 __eq__(self, other) # 实现 == 比较 __lt__(self, other) # 实现 < 比较 ``` 4. **容器类型方法** ```python __len__(self) # 定义 len(obj) 的行为 __getitem__(self, key) # 定义 obj[key] 的访问 __setitem__(self, key, value) # 定义 obj[key]=value __contains__(self, item) # 定义 in 运算符行为 ``` 5. **调用与上下文管理** ```python __call__(self) # 使对象可调用(如 obj()) __enter__(self) # with 语句进入时调用 __exit__(self) # with 语句退出时调用 ``` #### 二、特殊属性(只读) | 属性 | 说明 | |------|------| | `__name__` | 对象名称(函数/类/模块)[^4] | | `__doc__` | 对象的文档字符串 | | `__module__` | 定义对象的模块名 | | `__class__` | 对象所属的类 | | `__dict__` | 对象属性的字典[^4] | | `__slots__` | 限定类允许的属性 | | `__annotations__` | 类型注解字典 | #### 三、关键特性 1. **自动触发机制** 特殊方法由 Python 解释器隐式调用: ```python class Point: def __init__(self, x, y): self.x = x self.y = y def __add__(self, other): return Point(self.x + other.x, self.y + other.y) p1 = Point(1, 2) # 自动调用 __init__ p2 = Point(3, 4) p3 = p1 + p2 # 自动触发 __add__ ``` 2. **命名规范约束** - `__xxx__` 是 Python 保留命名空间[^4] - 自定义属性**禁止**使用此格式(可能导致与未来 Python 特性冲突) 3. **与私有变量的区别** | 类型 | 示例 | 可继承性 | 访问性 | |------|------|----------|--------| | 特殊方法 | `__init__` | 可继承 | 公有 | | 私有变量 | `__name` | 不可继承[^3] | 需通过 `_ClassName__name` 访问[^5] | #### 四、使用示例 ```python class Vector: def __init__(self, x, y): self.x = x self.y = y def __str__(self): return f"Vector({self.x}, {self.y})" # 自定义输出格式 def __add__(self, other): return Vector(self.x + other.x, self.y + other.y) # 向量加法 v1 = Vector(2, 3) v2 = Vector(4, 5) print(v1) # 输出: Vector(2, 3)(调用 __str__) v3 = v1 + v2 # 输出: Vector(6, 8)(调用 __add__) ``` #### 五、注意事项 1. 避免在自定义属性中使用 `__xxx__` 格式 2. 直接调用魔术方法可能破坏封装性(如 `obj.__init__()`) 3. 内置类型(如 `list`, `dict`)已实现大量特殊方法 4. 通过 `dir(obj)` 可查看对象的所有特殊方法 > 特殊方法是 Python **面向对象编程的基石**,它们使得自定义对象能像内置类型一样支持运算符、迭代等核心操作[^1][^4]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值