python 魔术方法
常用魔术方法
魔术方法就是一个类的特殊方法,和普通方法唯一的不同时,普通方法需要调用!而魔术方法由系统自动调用。
1.__init__
初始化魔术方法
触发时机:初始化对象时触发(不是实例化触发,但是和实例化在一个操作中)
参数:至少有一个self,接收对象
返回值:无
作用:初始化对象的成员
2.__new__
实例化魔术方法 类方法
触发时机: 在实例化对象时触发
参数:至少一个cls 接收当前类
返回值:必须返回一个对象实例
作用:实例化对象
注意:实例化对象是Object类底层实现,其他类继承了Object的__new__才能够实现实例化对象。
没事别碰这个魔术方法,先触发__new__才会触发__init__
3.__del__
析构魔术方法
触发时机:当对象没有用(没有任何变量引用)的时候被触发
参数:一个self
返回值:无
作用:在销毁对象时回收资源
注意:del不一定会触发当前方法,只有当前对象没有任何变量引用时才会触发
4.__call__
调用对象的魔术方法
触发时机:将对象当作函数调用时触发,方式: 对象()
参数:至少一个self接收对象,其余根据调用时参数决定
返回值:根据情况而定
作用:可以将复杂的步骤进行合并操作,减少调用的步骤,方便使用
注意:无
5.__len__
触发时机:使用len(对象) 的时候触发
参数:一个参数self
返回值:必须是一个整型
作用:可以设置为检测对象成员个数,但是也可以进行其他任意操作
注意:返回值必须必须是整数,否则语法报错,另外该要求是格式要求。
6.__str__
触发时机:使用print(对象)或者str(对象)的时候触发
参数:一个self接收对象
返回值:必须是字符串类型
作用:print(对象时)进行操作,得到字符串,通常用于快捷操作
注意:无
7.__repr__
触发时机:在使用repr(对象)的时候触发
参数:一个self接收对象
返回值:必须是字符串
作用:将对象转使用repr化为字符串时使用,也可以用于快捷操作
8.__bool__
触发时机: 使用bool(对象)的时候触发
参数:一个self接收对象
返回值:必须是布尔值
作用:根据实际情况决定,可以作为快捷方式使用
注意:仅适合于返回布尔值的操作
9.__format__
触发时机:使用字符串.format(对象)时候触发
参数:一个self接收对象,一个参数接收format的{}中的格式,例如:>5
返回值:必须是字符串
作用:设置对象可以作为format的参数,并且自定义对象格式化的规则
注意:无
描述符相关的魔术方法
1.__get__
触发时机:在获取指定描述符操作的成员属性的值的时候触发
参数:1描述符对象本身,2描述符描述的属性所在的对象,描述符描述的对象的类
返回值:必须有,不然无法获取相应属性值
注意:仅在描述符中使用
2.__set__
触发时机:在设置或者添加指定描述符操作的成员属性的时候触发
参数:1描述符对象本身,2描述符描述的属性所在的对象,3要设置的值
返回值:无
注意:仅在描述符中使用
3.__delete__
触发时机:在删除指定描述符操作的成员属性的时候触发
参数:1描述符对象本身,2描述符描述的属性所在的对象
返回值:无
注意:仅在描述符中使用
与属性操作相关的魔术方法
1.__getattr__
触发时机:获取不存在的对象成员时触发
参数:一个是接收当前对象的self,一个是获取成员名称的字符串
返回值:必须有值
作用:为访问不存在的属性设置值
注意:getattribute无论何时都会在getattr之前触发,触发了getattribute就不会在触发getattr了
2.__setattr__
触发时机:设置对象成员值的时候触发
参数:1个当前对象的self,一个是要设置的成员名称字符串,一个是要设置的值
返回值:无 过程操作
作用:接管设置操作,可以在设置前之前进行判断验证等行为
注意:在当前方法中无法使用成员=值的方式直接设置成员,否则会无限递归,必须借助object的设置方法来完成
object.__setattr__(参数1,参数2,参数3)
3.__delattr__
触发时机:删除对象成员时触发
参数:一个当前对象的self
返回值:无
作用:可以在删除成员时进行验证。
4.__getattribute__
触发时机:使用对象成员时触发,无论成员是否存在
参数:1个接收当前对象self,一个是获取的成员的名称字符串
返回值:必须有
作用:在具有封装操作(私有化时),为程序开部分访问权限使用
5.__dir__
触发时机:dir(对象)的时候触发
参数:1个接收当前对象self
返回值:必须为序列类型(列表,元组,集合等,)
作用:可以自定义成员列表的返回值
运算相关魔术方法
比较运算相关魔术方法
1.__lt__
格式:
def __lt__(self,other):
return 数据
特征:
触发时机:进行小于判断时自动触发
参数:2个参数第一个是self,第二个判断的第二个对象
返回值:返回值可以任意类型,推荐布尔值
作用:定义小于号的行为:x < y 调用 x.lt(y)
2.__le__
格式:
def __le__(self):
return bool
特征:
触发时机:进行小于等于判断时自动触发
参数:2个参数第一个是self,第二个判断的第二个对象
返回值:返回值可以任意类型,推荐布尔值
作用:定义小于等于号的行为:x <= y 调用 x.le(y)
3.__gt__
格式:
def __gt__(self):
return bool
特征:
触发时机:进行大于判断时自动触发
参数:2个参数第一个是self,第二个判断的第二个对象
返回值:返回值可以任意类型,推荐布尔值
作用:定义大于号的行为:x > y 调用 x.gt(y)
4.__ge__
格式:
def __ge__(self):
return bool
特征:
触发时机:进行大于等于判断时自动触发
参数:2个参数第一个是self,第二个判断的第二个对象
返回值:返回值可以任意类型,推荐布尔值
作用:定义大于等于号的行为:x >= y 调用 x.ge(y)
5.__eq__
格式:
def __eq__(self):
return bool
特征:
触发时机:进行等于判断时自动触发
参数:2个参数第一个是self,第二个判断的第二个对象
返回值:返回值可以任意类型,推荐布尔值
作用:定义大于等于号的行为:x == y 调用 x.eq(y)
6.__ne__
格式:
def __ne__(self):
return bool
特征:
触发时机:进行不等于判断时自动触发
参数:2个参数第一个是self,第二个判断的第二个对象
返回值:返回值可以任意类型,推荐布尔值
作用:定义不等号的行为:x != y 调用 x.ne(y)
算术运算相关魔术方法
__add__(self, other) 定义加法的行为:+
__sub__(self, other) 定义减法的行为:-
__mul__(self, other) 定义乘法的行为:*
__truediv__(self, other) 定义真除法的行为:/
__floordiv__(self, other) 定义整数除法的行为://
__mod__(self, other) 定义取模算法的行为:%
__divmod__(self, other) 定义当被 divmod() 调用时的行为
__pow__(self, other[, modulo]) 定义当被 power() 调用或 ** 运算时的行为
__lshift__(self, other) 定义按位左移位的行为:<<
__rshift__(self, other) 定义按位右移位的行为:>>
__and__(self, other) 定义按位与操作的行为:&
__xor__(self, other) 定义按位异或操作的行为:^
__or__(self, other) 定义按位或操作的行为:|
反运算相关魔术方法
__radd__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rsub__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rmul__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rtruediv__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rfloordiv__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rmod__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rdivmod__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rpow__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rlshift__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rrshift__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rand__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__rxor__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
__ror__(self, other) 与上方相同,当左操作数不支持相应的操作时被调用
赋值运算相关魔术方法
__iadd__(self, other) 定义赋值加法的行为:+=
__isub__(self, other) 定义赋值减法的行为:-=
__imul__(self, other) 定义赋值乘法的行为:=
__itruediv__(self, other) 定义赋值真除法的行为:/=
__ifloordiv__(self, other) 定义赋值整数除法的行为://=
__imod__(self, other) 定义赋值取模算法的行为:%=
__ipow__(self, other[, modulo]) 定义赋值幂运算的行为:**=
__ilshift__(self, other) 定义赋值按位左移位的行为:<<=
__irshift__(self, other) 定义赋值按位右移位的行为:>>=
__iand__(self, other) 定义赋值按位与操作的行为:&=
__ixor__(self, other) 定义赋值按位异或操作的行为:^=
__ior__(self, other) 定义赋值按位或操作的行为:|=
一元运算相关魔术方法
__pos__(self) 定义正号的行为:+x
__neg__(self) 定义负号的行为:-x
__abs__(self) 定义当被 abs() 调用时的行为
__invert__(self) 定义按位求反的行为:~x
类型转换相关魔术方法
__complex__(self) 定义当被 complex() 调用时的行为(需要返回恰当的值)
__int__(self) 定义当被 int() 调用时的行为(需要返回恰当的值)
__float__(self) 定义当被 float() 调用时的行为(需要返回恰当的值)
__round__(self[, n]) 定义当被 round() 调用时的行为(需要返回恰当的值)
__index(self)__ 1. 当对象是被应用在切片表达式中时,实现整形强制转换
2. 如果你定义了一个可能在切片时用到的定制的数值型,你应该定义 index
3. 如果 index 被定义,则 int 也需要被定义,且返回相同的值
上下文管理相关魔术方法(with)
__enter__
和 __exit__
__enter__(self)
1. 定义当使用 with 语句时的初始化行为
2. enter 的返回值被 with 语句的目标或者 as 后的名字绑定
__exit__(self, exctype, excvalue, traceback)
1. 定义当一个代码块被执行或者终止后上下文管理器应该做什么
2. 一般被用来处理异常,清除工作或者做一些代码块执行完毕之后的日常工作
容器类型相关魔术方法
__len__(self) 定义当被 len() 调用时的行为(返回容器中元素的个数)
__getitem__(self, key) 定义获取容器中指定元素的行为,相当于 self[key]
__setitem__(self, key, value) 定义设置容器中指定元素的行为,相当于 self[key] = value
__delitem__(self, key) 定义删除容器中指定元素的行为,相当于 del self[key]
__iter__(self) 定义当迭代容器中的元素的行为
__reversed__(self) 定义当被 reversed() 调用时的行为
__contains__(self, item) 定义当使用成员测试运算符(in 或 not in)时的行为