一、Python 的 Magic Method
在 Python 中,所有以 "__" 双下划线包起来的方法,都统称为"魔术方法"。比如我们接触最多的 __init__
。
魔术方法有什么作用呢?
使用这些魔术方法,我们可以构造出优美的代码,将复杂的逻辑封装成简单的方法。
那么一个类中有哪些魔术方法呢?
我们可以使用 Python 内置的方法 dir()
来列出类中所有的魔术方法.示例如下:
#!/usr/bin/env python3 # -*- coding: UTF-8 -*- class User(object): pass if __name__ == '__main__': print(dir(User()))
输出的结果:
['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__']
可以看到,一个类的魔术方法还是挺多的,不过我们只需要了解一些常见和常用的魔术方法就好了。
二、构造(__new__
)和初始化(__init__
)
通过之前的学习,我们已经知道定义一个类时,我们经常会通过 __init__(self)
的方法在实例化对象的时候,对属性进行设置。
比如下面的例子:
#!/usr/bin/env python3 # -*- coding: UTF-8 -*- class User(object): def __init__(self, name, age): self.name = name; self.age = age; user=User('两点水',23)
实际上,创建一个类的过程是分为两步的,一步是创建类的对象,还有一步就是对类进行初始化。
__new__
是用来创建类并返回这个类的实例, 而__init__
只是将传入的参数来初始化该实例.__new__
在创建一个实例的过程中必定会被调用,但 __init__
就不一定,比如通过 pickle.load 的方式反序列化一个实例时就不会调用 __init__
方法。
def __new__(cls)
是在 def __init__(self)
方法之前调用的,作用是返回一个实例对象。还有一点需要注意的是:__new__
方法总是需要返回该类的一个实例,而 __init__
不能返回除了 None
的任何值
具体的示例:
#!/usr/bin/env python3 # -*- coding: UTF-8 -*- class User(object): def __new__(cls, *args, **kwargs): # 打印 __new__方法中的相关信息 print('调用了 def __new__ 方法') print(args) # 最后返回父类的方法 return super(User, cls).__new__(cls) def __init__(self, name, age): print('调用了 def __init__ 方法') self.name = name self.age = age if __name__ == '__main__': usr = User('两点水', 23)
看看输出的结果:
调用了 def __new__ 方法 ('两点水', 23) 调用了 def __init__ 方法
通过打印的结果来看,我们就可以知道一个类创建的过程是怎样的了,先是调用了 __new__
方法来创建一个对象,把参数传给 __init__
方法进行实例化。
其实在实际开发中,很少会用到 __new__
方法,除非你希望能够控制类的创建。通常讲到 __new__
,都是牵扯到 metaclass
(元类)的。
当然当一个对象的生命周期结束的时候,析构函数 __del__
方法会被调用。但是这个方法是 Python 自己对对象进行垃圾回收的。
三、属性的访问控制
之前也有讲到过,Python 没有真正意义上的私有属性。然后这就导致了对 Python 类的封装性比较差。我们有时候会希望 Python 能够定义私有属性,然后提供公共可访问的 get 方法和 set 方法。Python 其实可以通过魔术方法来实现封装。
方法 | 说明 |
---|---|
__getattr__(self, name) | 该方法定义了你试图访问一个不存在的属性时的行为。因此,重载该方法可以实现捕获错误拼写然后进行重定向, 或者对一些废弃的属性进行警告。 |
__setattr__(self, name, value) | 定义了对属性进行赋值和修改操作时的行为。不管对象的某个属性是否存在,都允许为该属性进行赋值.有一点需要注意,实现 __setattr__ 时要避免"无限递归"的错误, |
__delattr__(self, name) | __delattr__ 与 __setattr__ 很像,只是它定义的是你删除属性时的行为。实现 __delattr__ 是同时要避免"无限递归"的错误 |
__getattribute__(self, name) | __getattribute__ 定义了你的属性被访问时的行为,相比较,__getattr__ 只有该属性不存在时才会起作用。因此,在支持 __getattribute__ 的 Python 版本,调用__getattr__ 前必定会调用 __getattribute__``__getattribute__ 同样要避免"无限递归"的错误。 |
通过上面的方法表可以知道,在进行属性访问控制定义的时候你可能会很容易的引起一个错误,可以看看下面的示例:
def __setattr__(self, name, value): self.name = value # 每当属性被赋值的时候, ``__setattr__()`` 会被调用,这样就造成了递归调用。 # 这意味这会调用 ``self.__setattr__('name', value)`` ,每次方法会调用自己。这样会造成程序崩溃。 def __setattr__(self, name, value): # 给类中的属性名分配值 self.__dict__[name] = value # 定制特有属性
上面方法的调用具体示例如下:
#!/usr/bin/env python3 # -*- coding: UTF-8 -*- class User(object): def __getattr__(self, name): print('调用了 __getattr__ 方法') return super(User, self).__getattr__(name) def __setattr__(self, name, value): print('调用了 __setattr__ 方法') return super(User, self).__setattr__(name, value) def __delattr__(self, name): print('调用了 __delattr__ 方法') return super(User, self).__delattr__(name) def __getattribute__(self, name): print('调用了 __getattribute__ 方法') return super(User, self).__getattribute__(name) if __name__ == '__main__': user = User() # 设置属性值,会调用 __setattr__ user.attr1 = True # 属性存在,只有__getattribute__调用 user.attr1 try: # 属性不存在, 先调用__getattribute__, 后调用__getattr__ user.attr2 except AttributeError: pass # __delattr__调用 del user.attr1
输出的结果:
调用了 __setattr__ 方法 调用了 __getattribute__ 方法 调用了 __getattribute__ 方法 调用了 __getattr__ 方法 调用了 __delattr__ 方法