Python 类的魔术方法

Python中类的魔术方法

  在Python中以两个下划线开头的方法,__init__、__str__、__doc__、__new__等,被称为"魔术方法"(Magic methods)。魔术方法在类或对象的某些事件出发后会自动执行,如果希望根据自己的程序定制自己特殊功能的类,那么就需要对这些方法进行重写。

  注意: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) (与上方相同,当左操作数不支持相应的操作时被调用)
__rand__(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) 定义赋值按位或操作的行为:|=
 
一元操作符
__pos__(self) 定义正号的行为:+x
__neg__(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)时的行为

Python的魔术方法举例

这里仅针对常用的魔术方法进行举例,便于理解及灵活运用,部分魔术方法已经在:这篇博客中举例说明

小技巧:如果在需要返回对象的魔术方法里面不知道如何返回,可以调用super函数来执行父类的相同方法。

注意:魔法方法必须要使用return进行返回。

基本的魔法方法

__repr__(self):直接执行对象时执行的方法

>>>
>>> class A:
	def __repr__(self):
		return ‘__repr__‘

>>> a = A()
>>> a
__repr__

__bool__(self):判断对象的bool值时执行的方法,返回值只能是bool类型

>>>
>>> class C:
	def __bool__(self):
		return False

>>> c = C()
>>> bool(c)
False
>>>

属性相关的魔术方法

__getattr__(self,name):获取一个不存在的属性时执行的方法。

__setattr__(self,name,value):设置一个属性时执行的方法。

__delattr__(self,name):删除一个属性时执行的方法。

__getattribute__(self,name):当该类的属性被访问时执行的方法。

>>> class A:
	def __getattr__(self,name):
		print(‘__getattr__‘)
	def __setattr__(self,name,value):
		print(‘__setattr__‘)
		super().__setattr__(name,value)
	def __delattr__(self,name):
		print(‘__delattr__‘)
		return super().__delattr__(name)
	def __getattribute__(self,name):
		print(‘__getattribute__‘)
		return super().__getattribute__(name)

>>> a = A()
>>> a.name
__getattribute__
__getattr__
>>> a.name = ‘daxin‘
__setattr__
>>> a.name
__getattribute__
‘daxin‘
>>> del a.name
__delattr__
>>>

注意

  1、__getattribute__,先于__getattr__访问

  2、__getattr__,没有在父类中进行定义,所以不能继承

  3、__setattr__,为设置属性,所以无需return

  3、在__setattr__时,不能直接使用self.name = value ,会造成死循环,因为在执行self.name = value的时候又会调用本身,无限循环下去

小技巧

  在__setattr__的时候,除了使用super的方式设置变量和值以外,还可以使用__dict__来设置。(建议使用super的方法)

>>> class A:
	def __getattr__(self,name):
		print(‘__getattr__‘)
	def __setattr__(self,name,value):
		print(‘__setattr__‘)
		self.__dict__[name] = value
	def __delattr__(self,name):
		print(‘__delattr__‘)
		return super().__delattr__(name)
	def __getattribute__(self,name):
		print(‘__getattribute__‘)
		return super().__getattribute__(name)

>>> a = A()
>>> a.name
__getattribute__
__getattr__
>>> a.name = ‘daxin‘
__setattr__
__getattribute__
>>> a.name
__getattribute__
‘daxin‘
>>>

运算符相关魔术方法  

__add__:在执行加法时执行的方法

>>> class A(int):
	def __add__(self,other):
		print(‘__add__‘)
		return super().__sub__(other)     # 这里改写了 add方法,调用了父类的减法

>>> a = A(8)
>>> a + 6
__add__
2
>>>

__radd__:当左边的对象没有__add__方法时,执行右边对象的__radd__方法

>>> class A:
	pass

>>> class B(int):

	def __radd__(self,other):
		return ‘I am B,because right object not have __add__‘

>>>
>>> a = A()
>>> b = B(12)
>>> a + b
‘I am B,because right object not have __add__‘
>>>

小练习

光看这么多的魔术方法,难免会很头痛,那么就以两个小例子来看下该怎么用

1、写一个矩形的类,那么这个类默认有长和宽两个参数,当传入一个叫square的属性时,值就等于边长,由于是正方形那么长和宽就等于边长。

class Rectangle(object):

    # init object
    def __init__(self,width,height):
        self.width = width
        self.height = height

    def getacreage(self):
        return self.width * self.height

    def __setattr__(self,name,value):
        if name == ‘square‘:
            self.width = value
            self.height = value

        else:
            super().__setattr__(name,value)

  

  

  

原文地址:https://www.cnblogs.com/dachenzi/p/8185792.html

时间: 2024-10-17 03:54:54

Python 类的魔术方法的相关文章

给python类动态添加方法(method)

群里有人问如何做到 def foo(): pass class Bar(object): pass Bar.set_instance_method(foo) b = Bar() b.foo() 这个其实还是比较简单的, 只要写个函数给类设置属性即可, 可根据需求是否用函数包装下, 或者用staticmethod这个decorator: import functools def foo(): print 'hello world' class Bar(object): def __init__(s

python中类的魔术方法

目的:学习python中class的magic methods,提高编程效率. 环境:ubuntu 16.4   python 3.5.2 在学习class是一定会接触到它的magic methods,比如常用__init__,形式都是前后有双下划线.除了这个必须的,还有其他有用的方法,下面大概的介绍一下. 运算魔法方法: __add__ 用作 + __sub__ 用作 - __mul__ 用作 * __truediv__用作/ __floordiv__用作// __mod__用作% __pow

python之使用魔术方法__getitem__和__len__

(1)像__getitem__这种由两个双下划线构成的方法,被称为魔术方法. (2)魔术方法是为了给python解释器用的.当使用len(collection)时,实际上调用的就是collection.__len__方法.而在使用obj[key]的形式来访问元素时,实际上调用的是object.__getitem__(key)方法. (3)魔术方法是属于类的方法,也就是说不需要实例化类就可以访问到该方法,同时,实例化的对象都可以访问到该方法. (4)使用__getitem__和__len__方法,

静态、抽象类、加载类、魔术方法等

静态  static关键字 普通成员普通成员是属于对象的 静态成员静态成员是属于类的 普通方法里面可以调用静态成员静态方法里面不能调用普通成员self关键字 在类里面代表该类 普通类 class Ren { public $name="张三"; public static $zhongzu; //静态成员 普通方法 function Say() { echo self::$zhongzu."你好"; } 静态类 static function Run() { ech

全面解析python类的绑定方法与非绑定方法

类中的方法有两类: 绑定方法 非绑定方法 一.绑定方法 1.对象的绑定方法 首先我们明确一个知识点,凡是类中的方法或函数,默认情况下都是绑定给对象使用的.下面,我们通过实例,来慢慢解析绑定方法的应用. class People: def __init__(self,name,age): self.name = name self.age = age def talk(self): pass p = People('xiaohua',18) print(p.talk) 输出结果: <bound m

流动python - 什么是魔术方法(magic method)

我们经常看到各种各样的方法已经被包围了由双下划线,例如__init__,他们是魔术方法. 魔术方法python语言预订好"协议",在不同情况下不同的魔术方法,是隐式调用.我们重写这些方法,因此,操纵各种行为. class A(object): def __str__(self): return "I am A,2333" def __len__(self): return 42 a = A() print a#输出 "I am A,2333" p

飘逸的python - 什么是魔术方法(magic method)

我们经常看到各种被双下划线环绕的方法,如__init__,它们就是魔术方法. 魔术方法是python语言预定好的"协议",不同魔术方法在不同场景下,会被隐式调用.我们通过重载这些方法,从而操控各种行为. class A(object): def __str__(self): return "I am A,2333" def __len__(self): return 42 a = A() print a#输出 "I am A,2333" prin

Python类的特殊方法

# 特殊方法,也称为魔术方法 # 特殊方法都是使用__开头和结尾的 # 特殊方法一般不需要我们手动调用,需要在一些特殊情况下自动执行 # 定义一个Person类 class Person(object): """人类""" def __init__(self, name , age): self.name = name self.age = age # __str__()这个特殊方法会在尝试将对象转换为字符串的时候调用 # 它的作用可以用来指定对

面向对象【十三】类的魔术方法

一. __getattribute__ class Foo: def __init__(self,x): self.x=x def __getattr__(self, item): print('执行的是我') # return self.__dict__[item] f1=Foo(10) print(f1.x) f1.xxxxxx #不存在的属性访问,触发__getattr__ 回顾__getattr__ 回顾__getattr__ class Foo: def __init__(self,x