python教程系列（二.2、魔法函数）

目录

Python进阶之路我觉得有两个东西一定要了解，一个是魔法函数，一个是鸭子类型！Python之所以这么灵活，这么优美，跟这两大特性有很大的关系，今天我们来看看神秘的魔法函数

1 什么是魔法函数

• 听名字感觉很神秘，确实魔法函数之所以这么叫，确实是特别之处，一旦类里面加上这些特殊的函数，整个类就被附加了一些特定的功能.

• Python里面的魔法函数，是以带双下划线开头和结尾，可以帮助类增强一些功能。这样方法可以在特定的情况下被Python调用,而几乎不用直接调用。

• 魔法函数和本身的类没有关系，和类的父类，object也没有关系。魔法函数可以写到任意一个类中，跟继不继承没有必然的关系。

• 魔法函数定义了，我们不需要显式的调用它，Python解释器自己会知道什么情况下会调用，我们只需要在使用相应的语法的时候就会调用。

2 快速上手魔法函数

Python里的魔法函数分2大类，一类是非数学运算相关的，一类是数学运算相关的，我们来看一下脑图：

1.非数学运算

我列出了一些常见的非数值运算的魔法函数，比如我们字符串类型的，集合序列类型的，迭代类型的，还有with属性相关的，加入这些函数就相当于注入了魔法，不信我们后面来看看实例。

1).比如有一个简单的类

一个Employee类，用来记录员工的信息

>>

Leo

Jack

Sam

2).利用魔法函数__getitem__

如果我们加上了魔法函数会怎么样，比如我们加上__getitem__看看，这个类会发现什么变化：

>>

Leo

Jack

Sam

• Employee这个类加上了__getitem__魔法函数之后，这个类就变成了带有序列相关属性，也就是说这个类有了list功能。

• 当我们for循环的时候，可以直接调用类里面的__getitem__函数，而且这一切都内置在Python解析器内自动完成，太酷了。

• 厉害吧，什么都不用加，如果按照以前静态代码的思路，我们需要多继承，或者增加interface才行。

• 而Python只要增加一个魔法函数就可以让这个类变成有其他的额外功能,神奇！

甚至你可以这样使用这个类：

print (ems[0])

>>Leo

print (ems[:2])

>>[‘Leo’, ‘Jack’]

3).利用__str__魔法函数

我们看最开始的Employee类，这个类直接打印的话:

>>

如果我们加上了魔法函数__str__会变成怎么样？

>>This is Employee class

直接print 之后，会调用类里面的__str__方便我输入这个类的内容

2.数值相关的魔法函数

数值相关的魔法函数没有上面的那么常用，但在在一些特殊的场景里面会遇到。我们下看一下脑图：

1).比如绝对值

比如我们取一个数的绝对值：

print (abs(-100))

那么如果类里面也想有这样的功能，应该怎么办呢？

>>10

神奇吧，这样也行，直接对类取绝对值，就返回了10。相当于是abs(对象)的时候，直接调用类里面的__abs__函数

2).比如向量运算

还记得贪吃蛇的游戏吗(太酷了，Python66行代码，写一个贪吃蛇游戏)，里面需要对坐标进行运算,这样的类，如果用上魔法函数，会大大简化我的代码:

我们要自定义一个向量类，我们希望这个类有运算功能，比如加，减这样的功能.

我们加上了__add__魔法函数之后，这个类就是想数值一样相加，相减。

v1=Vector(1,1)

v2=Vector(10,10)

print (v1+v2)

>>x:11,y:11

---

看这个类有了计算的功能，是不是很方便，类似的魔法函数还有很多，尤其是迭代器，序列类型和with类型是我们经常用的。

有同学可能会说，我平时写代码似乎也不需要用带魔法函数呀，是的，如果你只是写几百行上千行的代码确实不需要。但是如果你的代码变大，需要扩展，需要更灵活，或者你的代码要给别人当库，这个时候就需要仔细的考虑代码的架构了。

所以你一旦掌握了魔法函数，你就能写出让别人眼前一亮的代码，哇原来Python可以这样玩.

基本魔法方法

基本魔法方法	功能
__new__(cls[, ...])	1.new是在一个对象实例化的时候所调用的第一个方法 2. 它的第一个参数是这个类，其他的参数是用来直接传递给init方法 3.new决定是否要使用该init方法，因为new可以调用其他类的构造方法或者直接返回别的实例对象来作为本类的实例，如果new没有返回实例对象，则init不会被调用new主要是用于继承一个不可变的类型比如一个 tuple 或者 string
__init__(self[, ...])	构造器，当一个实例被创建的时候调用的初始化方法
__del__(self)	析构器，当一个实例被销毁的时候调用的方法
__call__(self[, args...])	允许一个类的实例像函数一样被调用：x(a, b) 调用 x.call(a, b)
__len__(self)	定义当被 len() 调用时的行为
__repr__(self)	定义当被 repr() 调用时的行为
__bytes__(self)	定义当被 bytes() 调用时的行为
__str__(self)	定义当被 str() 调用时的行为
__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, instence, owner)	定义当描述符的值被取得时的行为
__set__(self, instence, value)	定义当描述符的值被改变时的行为
__delete__(self, instence)	定义当描述符的值被删除时的行为

比较操作符魔法方法	功能
__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)	定义赋值幂运算的行为：**=
__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)	当对象是被应用在切片表达式中时，实现×××强制转换 2. 如果你定义了一个可能在切片时用到的定制的数值型,你应该定义index3. 如果index被定义，则int也需要被定义，且返回相同的值

上下文管理（with 语句）相关魔法方法	功能
__enter__(self)	1.定义当使用 with 语句时的初始化行为 2.enter的返回值被 with 语句的目标或者 as 后的名字绑定
__exit__(self, exc_type, exc_value, traceback)	1.定义当一个代码块被执行或者终止后上下文管理器应该做什么 2. 一般被用来处理异常，清除工作或者做一些代码块执行完毕之后的日常工作

容器相关魔法方法	功能
__len__(self)	定义当被 len() 调用时的行为（返回容器中元素的个数）
__getitiem__(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）时的行为