Python 的对象天生拥有一些神奇的方法,它们总被双下划线所包围,他们是面向对象的 Python 的一切,也是python灵活的基础。
他们是可以给你的类增加魔力的特殊方法,如果你的对象实现(重载)了这些方法中的某一个,那么这个方法就会在特殊的情况下被 Python 所调用,你可以定义自己想要的行为,而这一切都是自动发生的。这就像是一种协议,你实现了这些协议之后,那么就可以使你自定义的类和方法,如同内置数据结构或方法一样,有用强大的python特性!
请注意加粗的一些魔法方法,是我们在开发过程中经常使用的。
魔法方法 | 含义 |
基本的魔法方法 | |
__new__(cls[, ...]) | 1. __new__ 是在一个对象实例化的时候所调用的第一个方法 2. 它的第一个参数是这个类,其他的参数是用来直接传递给 __init__ 方法 3. __new__ 决定是否要使用该 __init__ 方法,因为 __new__ 可以调用其他类的构造方法或者直接返回别的实例对象来作为本类的实例,如果 __new__ 没有返回实例对象,则 __init__ 不会被调用 4. __new__ 主要是用于继承一个不可变的类型比如一个 tuple 或者 string |
__init__(self[, ...]) | 构造器,当一个实例被创建的时候调用的初始化方法 |
__del__(self) | 析构器,当一个实例被销毁的时候调用的方法 |
__call__(self[, args...]) | 允许一个类的实例像函数一样被调用:x(a, b) 调用 x.__call__(a, b) |
__len__(self) | 定义当被 len() 调用时的行为 |
__repr__(self) | 定义当被 repr() 调用时的行为 |
__str__(self) | 定义当被 str() 调用时的行为 |
__bytes__(self) | 定义当被 bytes() 调用时的行为 |
__hash__(self) | 定义当被 hash() 调用时的行为 |
__bool__(self) | 定义当被 bool() 调用时的行为,应该返回 True 或 False |
__format__(self, format_spec) | 定义当被 format() 调用时的行为 |
有关属性 | |
__getattr__(self, name) | 定义当用户试图获取一个不存在的属性时的行为 |
__getattribute__(self, name) | 定义当该类的属性被访问时的行为,他拦截所有的属性获取动作 |
__setattr__(self, name, value) | 定义当一个属性被设置时的行为 |
__delattr__(self, name) | 定义当一个属性被删除时的行为 |
__dir__(self) | 定义当 dir() 被调用时的行为 |
__get__(self, instance, owner) | 定义当描述符的值被取得时的行为 |
__set__(self, instance, value) | 定义当描述符的值被改变时的行为 |
__delete__(self, instance) | 定义当描述符的值被删除时的行为 |
比较操作符 | |
__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) | (与上方相同,当左操作数不支持相应的操作时被调用) |
__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) | 1. 当对象是被应用在切片表达式中时,实现整形强制转换 2. 如果你定义了一个可能在切片时用到的定制的数值型,你应该定义 __index__ 3. 如果 __index__ 被定义,则 __int__ 也需要被定义,且返回相同的值 |
上下文管理(with 语句) | |
__enter__(self) | 1. 定义当使用 with 语句时的初始化行为 2. __enter__ 的返回值被 with 语句的目标或者 as 后的名字绑定 |
__exit__(self, exc_type, exc_value, 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)时的行为 |
简要举一些例子:
1)__str__和__repr__:
两个方法均是为了输出更容易理解的类描述,而不是采用默认的输出类名。两者主要的区别是:str是针对于让人更好理解的字符串格式化,而repr是让机器更好理解的字符串格式化。说人话就是,在程序中如果没有使用类似print这类函数时,计算机输出的类型就是__repr__魔法方法定义的方式。
class Test(object):
def __init__(self, world):
self.world = world
def __str__(self):
return 'world is %s str' % self.world
def __repr__(self):
return 'world is %s repr' % self.world
t = Test('world_test')
print ( str(t) )
print ( repr(t) )
output:
world is world_test str
world is world_test repr
2) __getattr__, __setattr__, __delattr__, __getattribute__:
这几个魔法方法在python当中十分重要,python的反射,也是通过这类函数实现的。
__getattr__是一旦我们尝试访问一个并不存在的属性的时候就会调用,而如果这个属性存在则不会调用该方法。一定是不存在改属性的时候,才会调用。
class Test(object):
def __init__(self, world):
self.world = world
def __getattr__(self, item):
return "{}属性不存在".format(item)
x = Test('test')
print( x.test )
output:
test属性不存在
Test类中只有world属性,没有test属性,在没有指定__getattr__这个魔法时,系统将会抛出no attribute的异常。但是我定义了该魔法方法,因此,系统并没有抛异常,而是打印了我们指定的字符串。
class Test(object):
def __init__(self, world):
self.world = world
def __setattr__(self, key, value):
if key == "world":
object.__setattr__(self,key,key+value)
else:
object.__setattr__(self, key,value - 50)
x = Test('init')
print( x.world )
x.setValue = 100
print( x.setValue )
output:
worldinit
50
__setattr__魔法函数,会在设置类属性的时候自动被调用。当我们覆盖这个函数时,他就会按照我们的逻辑对类属性进行赋值。但是有个问题,一定要注意,这个魔法方法有可能会造成死循环,即嵌套调用。我们仔细查看下下面的方式:
class Test(object):
def __init__(self, world):
self.world = world
def __setattr__(self, key, value):
self.test = value
x = Test('init')
output:
RecursionError: maximum recursion depth exceeded
因此,在使用该魔法方法去对属性赋值的时候,一定要调用父类的__setattr__方法,不要想着偷懒而造成循环调用。
而对于__delattr__的使用和__setattr__类似,我就不做例子了。同样,需要注意的是循环调用问题。
__getattribute__和__getattr__方法唯一不同的地方是,上面我们已经介绍了__getattr__方法只能在找不到属性的时候拦截调用,然后进行重载或者加入一些其他操作。但是__getattribute__更加强大,他可以拦截所有的属性获取。所以也容易出现我们上面提到的,循环调用的问题。下面上一个例子来说明这个问题:
class Test(object):
def __init__(self, world):
self.world = world
def __getattribute__(self, item):
return "获取属性 %s" % item
x = Test(123)
print ( x.world )
print ( x.world1 )
output:
获取属性 world
获取属性 word2
不管你Test类中,是否包含要获取的属性,都会调用__getattribute__魔法方法。
3)__get__, __set__, __delete__:
这三个魔法方法是python的属性描述符必备的三个魔法方法。当然,__delete__可以不存在。属性描述符有啥作用呢?如果某个属性被赋予了属性描述的特性,那么在我们设置或者获取该属性时,就会自动调用这几个方法。我们来看一个例子:
class Descrip(object):
def __get__(self, instance, owner):
print("__get__")
def __set__(self, instance, value):
print('__set__')
class TestDesc(object):
x = Descrip()
t = TestDesc()
t.x = 1
t.x
output:
__set__
__get__
其中,在TestDesc类中进行类变量x赋值的时候,赋值了一个属性描述符。在对TestDesc进行实例化后,对类变量进行赋值时,调用了属性描述符Descrip的__set__方法,而在获取x值的时候,则调用了属性描述符Descrip的__get__方法。在此,各位有什么想法没?因为有了这个属性描述符,我们可以做很多事情。比如说:我们有很多数据需要检验,而校验的方式方法又完全一致。这个时候,我们是不是对每一个数据都写一个校验代码呢?或者你写一个校验函数?或许校验函数是一个选择。但是我有这么一个需求,我需要在所有数据中,注入一些通用的属性和方法。这我们又怎么做呢?会不会突然觉得,好像头会麻木?在这个时候,属性描述符其实就会起到很大的作用。著名的python Web框架Django中的ORM还记得吗?他的数据库映射,其实就是采用的这样一个方式。是不是有种明悟的感觉?
—————————————————华丽丽的分割线————————————————————
今天就写到这里了,写得有点差好像,请各位谅解啦,手打很累,以后慢慢改进。