概念三 python_类的魔法方法

1. 类的魔法方法命名规则：

在Python中，所有以双下划线__包起来的方法，统称为Magic Method（魔术方法），它是一种的特殊方法，普通方法需要调用，而魔术方法不需要调用就可以自动执行.

类的魔法方法总是被双下划线所包围，一般格式为：“__ 方法名__”， 魔术方法在类或对象的某些事件出发后会自动执行，让类具有神奇的“魔力”。

通过重载，魔法方法的实际功能可以根据实际需要进行更改。如果希望根据自己的程序定制自己特殊功能的类，那么就需要对这些方法进行重写。

例如：
__ init__() 就是一个典型的魔法方法，当创建对象时会被系统调用，
在定义类时，也可以根据需要设置它的实际功能。

__getitem__(self,index) 返回 key 所对应的值, 文章结尾处介绍。

Python中常用的运算符、for循环、以及类操作等都是运行在魔术方法之上的。

2.最基本的三个魔法方法

类的魔法方法实质是 python 的内置方法，不需要主动调用。当我们在进行某种类的运算或操作时，python的解释器会自动调用相应的魔法方法。

2.1最基本的三个魔法方法

1. 初始化方法__init__

触发机制：实例化对象之后立即触发
参数：至少有一个self，接收当前对象，其他参数根据需要进行定义
返回值：无
作用：初始化对象的成员

2. 构造方法__new__

触发时机： 实例化对象时自动触发（在__init__之前触发）
参数：至少一个cls 接收当前类，其他参数根据初始化方法参数决定
返回值：必须返回一个对象实例，没有返回值，则实例化对象的结果为None
作用：实例化对象
注意：实例化对象是Object类底层实现，其他类继承了Object的__new__才能够实现实例化对象。

3. 析构方法__del__

触发时机：当该类对象被销毁时，自动触发
参数：一个self，接受当前对象
返回值：无
作用：关闭或释放对象创建时资源
注意：del不一定会触发当前方法，只有当前对象没有任何变量引用时才会触发

2.2 初始化函数

初始化函数的创建，包含以下三个魔法方法

1. 一个最基本的魔术方法， __ init__() 。通过此方法我们可以定义一个对象的初始操作。然而，当调用 x = SomeClass() 的时候， __ init__() 并不是第一个被调用的方法。

2. 实际上，还有一个叫做__new__ 的方法，两个共同构成了“构造函数”。
   __new__是用来创建类并返回这个类的实例, 而__init__只是将传入的参数来初始化该实例。

3. 在对象生命周期调用结束时，__del__ 方法会被调用，可以将__del__理解为“构析函数”。

from os.path import join
class FileObject:
    '''给文件对象进行包装从而确认在删除时文件流关闭'''
    def __init__(self, filepath='~', filename='sample.txt'):
        #读写模式打开一个文件
        self.file = open(join(filepath, filename), 'r+')
    def __del__(self):
        self.file.close()
        del self.file

魔术方法__init__、new、__del__的应用

class People(object):
    # 创建对象
    def __new__(cls, *args, **kwargs):
        print("触发了构造方法")
        ret = super().__new__(cls) # 调用父类的__new__()方法创建对象
        return ret ## 将对象返
    # 实例化对象
    def __init__(self, name, age):
        self.name = name
        self.age = age
        print("初始化方法")
    #  删除对象
    #   del 对象名或者程序执行结束之后
    def __del__(self):
        print("析构方法，删除对象")


if __name__ == '__main__':
    p1 = People('xiaoming', 16)

输出：
触发了构造方法
初始化方法
析构方法，删除对象

3. 常用魔法方法

3.1 常用的内置魔法方法

__call__

调用对象的魔术方法
触发时机:将对象当作函数调用时触发,方式： 对象()
参数:至少一个self接收对象，其余根据调用时参数决定
返回值：根据情况而定
作用：可以将复杂的步骤进行合并操作，减少调用的步骤，方便使用
注意：无

使用__call__方法实现斐波那契数列

# 斐波那契数列指的是这样一个数列 0, 1, 1, 2, 3, 5, 8, 13
# 特别指出：第0项是0，第1项是第一个1。从第三项开始，每一项都等于前两项之和。
class Fib(object):
    def __init__(self):
        pass
    def __call__(self,num):
        a,b = 0,1;
        self.l=[]

        for i in range (num):
            self.l.append(a)
            a,b= b,a+b
        return self.l
    def __str__(self):
        return str(self.l)
    __rept__=__str__

f = Fib()
print(f(10))
输出：
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34]

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的参数，并且自定义对象格式化的规则
注意：无

4. 与属性操作相关的魔术方法

4.1 内置属性的魔法方法

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
返回值：必须为序列类型（列表，元组，集合等，）
作用：可以自定义成员列表的返回值

4.2 比较运算相关魔术方法

__ 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)

4.3算术运算相关魔术方法

__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)            定义按位或操作的行为：|

4.4赋值运算相关魔术方法

__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)              定义赋值按位或操作的行为：|=

4.5 一元运算相关魔术方法

__pos__(self)      定义正号的行为：+x
__neg__(self)      定义负号的行为：-x
__abs__(self)      定义当被 abs() 调用时的行为
__invert__(self)   定义按位求反的行为：~x

4.6 类型转换相关魔术方法

__complex__(self)      定义当被 complex() 调用时的行为（需要返回恰当的值）
__int__(self)          定义当被 int() 调用时的行为（需要返回恰当的值）
__float__(self)        定义当被 float() 调用时的行为（需要返回恰当的值）
__round__(self[, n])   定义当被 round() 调用时的行为（需要返回恰当的值）
__index(self)__        1. 当对象是被应用在切片表达式中时，实现整形强制转换
                       2. 如果你定义了一个可能在切片时用到的定制的数值型,你应该定义 index
                       3. 如果 index 被定义，则 int 也需要被定义，且返回相同的值

4.7上下文管理相关魔术方法(with)

__enter__ 和 __exit__

__enter__(self)
    1. 定义当使用 with 语句时的初始化行为
    2. enter 的返回值被 with 语句的目标或者 as 后的名字绑定

__exit__(self, exctype, excvalue, traceback)
    1. 定义当一个代码块被执行或者终止后上下文管理器应该做什么
    2. 一般被用来处理异常，清除工作或者做一些代码块执行完毕之后的日常工作

4.8 容器类型相关魔术方法

__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）时的行为

分析这里的__getitem()__ 方法，原因是在 pytroch 中的　Dataset() 继承该父类的子类，都需要重写该魔法方法；

在python中__getitem__(self,key)方法被称为魔法方法，这个方法返回所给键对应的值。当对象是序列时，键是整数。当对象是映射时（字典），键是任意值。。在定义类时，如果希望能按照键取类的值，则需要定义__getitem__方法
如果给类定义了__getitem__方法，则当按照键取值时，可以直接返回__getitem__方法执行的结果。

class Fib():                  #定义类Fib
    def __init__(self,start=0,step=1):
        self.step=step
    def __getitem__(self, key): #定性__getitem__函数，key为类Fib的键
            a = key+self.step
            return a          #当按照键取值时，返回的值为a
 
s=Fib()
s[1]  #返回2 ，因为类有 __getitem__方法，所以可以直接通过键来取对应的值

如果不给类Fib()定义 __getitem__方法，则会无法通过键来获取对应的值；

class Fib():                  #定义类Fib
    def __init__(self,start=0,step=1):
        self.step=step
s=Fib()
s[1] 
返回：TypeError: 'Fib' object does not support indexing

这种方法可以让使用者非常方便的取值，我们经常使用列表和字典，都有该方法。

reference:

https://zhuanlan.zhihu.com/p/329962624