魔法方法
据说,Python 的对象天生拥有一些神奇的方法,它们总被双下划线所包围,他们是面向对象的 Python 的一切。
他们是可以给你的类增加魔力的特殊方法,如果你的对象实现(重载)了这些方法中的某一个,那么这个方法就会在特殊的情况下被 Python 所调用,你可以定义自己想要的行为,而这一切都是自动发生的。
Python 的魔术方法非常强大,然而随之而来的则是责任。了解正确的方法去使用非常重要!
基本的魔法方法
- new(cls[, …])
- new 是在一个对象实例化的时候所调用的第一个方法
- 它的第一个参数要实例化的类,此参数在实例化时由 Python 解释器自动提供,后面的参数直接传递给__init__。
- new 对当前类进行了实例化,并将实例返回,传给__init__的self。但是,执行了__new__,并不一定会进入__init__,只有__new__返回了,当前类
cls
的实例,当前类的__init__才会进入。 - 若__new__没有正确返回当前类cls的实例,那__init__是不会被调用的,即使是父类的实例也不行,将没有__init__被调用。
- 利用__new__实现单例模式。
- __new__方法主要是当你继承一些不可变的 class 时(比如int, str, tuple), 提供给你一个自定义这些类的实例化过程的途径。
- init(self[, …]) 构造器,当一个实例被创建的时候调用的初始化方法
- del(self) 析构器,当一个实例被销毁的时候调用的方法
Python 采用自动引用计数(ARC)方式来回收对象所占用的空间,当程序中有一个变量引用该 Python 对象时,Python 会自动保证该对象引用计数为 1;当程序中有两个变量引用该 Python 对象时,Python 会自动保证该对象引用计数为 2,依此类推,如果一个对象的引用计数变成了 0,则说明程序中不再有变量引用该对象,表明程序不再需要该对象,因此 Python 就会回收该对象。
大部分时候,Python 的 ARC 都能准确、高效地回收系统中的每个对象。但如果系统中出现循环引用的情况,比如对象 a 持有一个实例变量引用对象 b,而对象 b 又持有一个实例变量引用对象 a,此时两个对象的引用计数都是 1,而实际上程序已经不再有变量引用它们,系统应该回收它们,此时 Python 的垃圾回收器就可能没那么快,要等专门的循环垃圾回收器(Cyclic Garbage Collector)来检测并回收这种引用循环。
- call(self[, args…]) 允许一个类的实例像函数一样被调用:x(a, b) 调用 x.call(a, b)
- len(self) 定义当被 len() 调用时的行为
- str(self) 定义当被 str() 调用时的行为
- 当你打印一个对象的时候,触发__str__
- 当你使用%s格式化的时候,触发__str__
- str强转数据类型的时候,触发__str__
- repr(self) 定义当被 repr() 调用时的行为
- repr是str的备胎
- 有__str__的时候执行__str__,没有实现__str__的时候,执行__repr__
- repr(obj)内置函数对应的结果是__repr__的返回值
- 当你使用%r格式化的时候 触发__repr__
str(self) 的返回结果可读性强。也就是说,str 的意义是得到便于人们阅读的信息,就像下面的 ‘2019-10-11’ 一样。
repr(self) 的返回结果应更准确。怎么说,repr 存在的目的在于调试,便于开发者使用。
- bytes(self) 定义当被 bytes() 调用时的行为
- hash(self) 定义当被 hash() 调用时的行为
- bool(self) 定义当被 bool() 调用时的行为,应该返回 True 或 False
- format(self, format_spec) 定义当被 format() 调用时的行为
有关属性 - dir(self) 定义当 dir() 被调用时的行为
描述符
- get(self, instance, owner) 定义当描述符的值被取得时的行为
- set(self, instance, value) 定义当描述符的值被改变时的行为
- delete(self, instance) 定义当描述符的值被删除时的行为
属性访问
- getattr(self, name) 定义当用户试图获取一个不存在的属性时的行为
- getattribute(self, name) 定义当该类的属性被访问时的行为
- setattr(self, name, value) 定义当一个属性被设置时的行为
- delattr(self, name) 定义当一个属性被删除时的行为
比较操作符
- lt(self, other) 定义小于号的行为:x < y 调用 x.lt(y)
- le(self, other) 定义小于等于号的行为:x <= y 调用 x.le(y)
- eq(self, other) 定义等于号的行为:x == y 调用 x.eq(y)
- ne(self, other) 定义不等号的行为:x != y 调用 x.ne(y)
- gt(self, other) 定义大于号的行为:x > y 调用 x.gt(y)
- ge(self, other) 定义大于等于号的行为:x >= y 调用 x.ge(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) (与上方相同,当左操作数不支持相应的操作时被调用)
a + b 这里加数是a,被加数是b,因此是a主动,反运算就是如果a对象的__add__()方法没有实现或者不支持相应的操作,那么 Python 就会调用b的__radd__()方法。 - 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) (与上方相同,当左操作数不支持相应的操作时被调用)
- 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) 定义赋值按位或操作的行为:|=
一元操作符
- neg(self) 定义正号的行为:+x
- pos(self) 定义负号的行为:-x
- abs(self) 定义当被 abs() 调用时的行为
- invert(self) 定义按位求反的行为:~x
类型转换
- complex(self) 定义当被 complex() 调用时的行为(需要返回恰当的值)
- int(self) 定义当被 int() 调用时的行为(需要返回恰当的值)
- float(self) 定义当被 float() 调用时的行为(需要返回恰当的值)
- round(self[, n]) 定义当被 round() 调用时的行为(需要返回恰当的值)
- index(self)
- 当对象是被应用在切片表达式中时,实现整形强制转换
- 如果你定义了一个可能在切片时用到的定制的数值型,你应该定义 index
- 如果 index 被定义,则 int 也需要被定义,且返回相同的值
上下文管理(with 语句)
- enter(self)
- 定义当使用 with 语句时的初始化行为
- enter 的返回值被 with 语句的目标或者 as 后的名字绑定
- exit(self, exc_type, exc_value, traceback)
- 定义当一个代码块被执行或者终止后上下文管理器应该做什么
- 一般被用来处理异常,清除工作或者做一些代码块执行完毕之后的日常工作
容器类型
定制序列
协议(Protocols)与其它编程语言中的接口很相似,它规定你哪些方法必须要定义。然而,在 Python 中的协议就显得不那么正式。事实上,在 Python 中,协议更像是一种指南。
容器类型的协议
- 如果说你希望定制的容器是不可变的话,你只需要定义__len__()和__getitem__()方法。
- 如果你希望定制的容器是可变的话,除了__len__()和__getitem__()方法,你还需要定义__setitem__()和__delitem__()两个方法。
- 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)时的行为
迭代器
- 迭代是 Python 最强大的功能之一,是访问集合元素的一种方式。
- 迭代器是一个可以记住遍历的位置的对象。
- 迭代器对象从集合的第一个元素开始访问,直到所有的元素被访问完结束。
- 迭代器只能往前不会后退。
- 字符串,列表或元组对象都可用于创建迭代器
迭代器有两个基本的方法:iter() 和 next():
- iter(object) 函数用来生成迭代器。
- next(iterator[, default]) 返回迭代器的下一个项目。
iterator – 可迭代对象
default – 可选,用于设置在没有下一个元素时返回该默认值,如果不设置,又没有下一个元素则会触发 StopIteration 异常。
把一个类作为一个迭代器使用需要在类中实现两个魔法方法 iter() 与 next() 。
- iter(self)定义当迭代容器中的元素的行为,返回一个特殊的迭代器对象, 这个迭代器对象实现了 next() 方法并通过 StopIteration 异常标识迭代的完成。
- next() 返回下一个迭代器对象。
- StopIteration 异常用于标识迭代的完成,防止出现无限循环的情况,在 next() 方法中我们可以设置在完成指定循环次数后触发 StopIteration 异常来结束迭代。
生成器
- 在 Python 中,使用了 yield 的函数被称为生成器(generator)。
- 跟普通函数不同的是,生成器是一个返回迭代器的函数,只能用于迭代操作,更简单点理解生成器就是一个迭代器。
- 在调用生成器运行的过程中,每次遇到 yield 时函数会暂停并保存当前所有的运行信息,返回 yield 的值, 并在下一次执行 next() 方法时从当前位置继续运行。
- 调用一个生成器函数,返回的是一个迭代器对象。