Python魔法之旅-魔法方法(01)

见贤思齐

目录一、概述1、定义2、作用二、主要应用场景1、构造和析构2、操作符重载3、字符串和表示4、容器管理5、可调用对象6、上下文管理7、属性访问和描述符8、迭代器和生成器9、数值类型10、复制和序列化11、自定义元类行为12、自定义类行为13、类型检查和转换14、自定义异常三、学习方法1、理解基础2、查阅文档3、编写示例4、实践应用5、阅读他人代码6、参加社区讨论7、持续学习8、练习与总结9、注意兼容性10、避免过度使用四、魔法方法1、__abs__方法1-1、语法1-2、参数1-3、功能1-4、返回值1-5、说明1-6、用法2、__add__方法2-1、语法2-2、参数2-3、功能2-4、返回值2-5、说明2-6、用法3、__and__方法3-1、语法3-2、参数3-3、功能3-4、返回值3-5、说明3-6、用法4、__bool__方法4-1、语法4-2、参数4-3、功能4-4、返回值4-5、说明4-6、用法 5、__call__方法5-1、语法5-2、参数5-3、功能5-4、返回值5-5、说明5-6、用法 五、推荐阅读1、Python筑基之旅2、Python函数之旅3、Python算法之旅4、博客个人主页一、概述1、定义        魔法方法(MagicMethods/SpecialMethods，也称特殊方法或双下划线方法)是Python中一类具有特殊命名规则的方法，它们的名称通常以双下划线(`__`)开头和结尾。        魔法方法用于在特定情况下自动被Python解释器调用，而不需要显式地调用它们，它们提供了一种机制，让你可以定义自定义类时具有与内置类型相似的行为。2、作用        魔法方法允许开发者重载Python中的一些内置操作或函数的行为，从而为自定义的类添加特殊的功能。二、主要应用场景1、构造和析构1-1、__init__(self,[args...])：在创建对象时初始化属性。1-2、__new__(cls,[args...])：在创建对象时控制实例的创建过程(通常与元类一起使用)。1-3、__del__(self)：在对象被销毁前执行清理操作，如关闭文件或释放资源。2、操作符重载2-1、__add__(self,other)、__sub__(self,other)、__mul__(self,other)等：自定义对象之间的算术运算。2-2、__eq__(self,other)、__ne__(self,other)、__lt__(self,other)等：定义对象之间的比较操作。3、字符串和表示3-1、__str__(self)：定义对象的字符串表示，常用于print()函数。3-2、__repr__(self)：定义对象的官方字符串表示，用于repr()函数和交互式解释器。4、容器管理4-1、__getitem__(self,key)、__setitem__(self,key,value)、__delitem__(self,key)：用于实现类似列表或字典的索引访问、设置和删除操作。4-2、__len__(self)：返回对象的长度或元素个数。5、可调用对象5-1、__call__(self,[args...])：允许对象像函数一样被调用。6、上下文管理6-1、__enter__(self)、__exit__(self,exc_type,exc_val,exc_tb)：用于实现上下文管理器，如with语句中的对象。7、属性访问和描述符7-1、__getattr__,__setattr__,__delattr__：这些方法允许对象在访问或修改不存在的属性时执行自定义操作。7-2、描述符(Descriptors)是实现了__get__,__set__,和__delete__方法的对象，它们可以控制对另一个对象属性的访问。8、迭代器和生成器8-1、__iter__和__next__：这些方法允许对象支持迭代操作，如使用for循环遍历对象。8-2、__aiter__,__anext__：这些是异步迭代器的魔法方法，用于支持异步迭代。9、数值类型9-1、__int__(self)、__float__(self)、__complex__(self)：定义对象到数值类型的转换。9-2、__index__(self)：定义对象用于切片时的整数转换。10、复制和序列化10-1、__copy__和__deepcopy__：允许对象支持浅复制和深复制操作。10-2、__getstate__和__setstate__：用于自定义对象的序列化和反序列化过程。11、自定义元类行为11-1、__metaclass__(Python2)或元类本身(Python3)：允许自定义类的创建过程，如动态创建类、修改类的定义等。12、自定义类行为12-1、__init__和__new__：用于初始化对象或控制对象的创建过程。12-2、__init_subclass__：在子类被创建时调用，允许在子类中执行一些额外的操作。13、类型检查和转换13-1、__instancecheck__和__subclasscheck__：用于自定义isinstance()和issubclass()函数的行为。14、自定义异常14-1、你可以通过继承内置的Exception类来创建自定义的异常类，并定义其特定的行为。三、学习方法        要学好Python的魔法方法，你可以遵循以下方法及步骤：1、理解基础        首先确保你对Python的基本语法、数据类型、类和对象等概念有深入的理解，这些是理解魔法方法的基础。2、查阅文档        仔细阅读Python官方文档中关于魔法方法的部分，文档会详细解释每个魔法方法的作用、参数和返回值。你可以通过访问Python的官方网站或使用help()函数在Python解释器中查看文档。3、编写示例        为每个魔法方法编写简单的示例代码，以便更好地理解其用法和效果，通过实际编写和运行代码，你可以更直观地感受到魔法方法如何改变对象的行为。4、实践应用        在实际项目中尝试使用魔法方法。如，你可以创建一个自定义的集合类，使用__getitem__、__setitem__和__delitem__方法来实现索引操作。只有通过实践应用，你才能更深入地理解魔法方法的用途和重要性。5、阅读他人代码        阅读开源项目或他人编写的代码，特别是那些使用了魔法方法的代码，这可以帮助你学习如何在实际项目中使用魔法方法。通过分析他人代码中的魔法方法使用方式，你可以学习到一些新的技巧和最佳实践。6、参加社区讨论        参与Python社区的讨论，与其他开发者交流关于魔法方法的使用经验和技巧，在社区中提问或回答关于魔法方法的问题，这可以帮助你更深入地理解魔法方法并发现新的应用场景。7、持续学习        ython语言和其生态系统不断发展，新的魔法方法和功能可能会不断被引入，保持对Python社区的关注，及时学习新的魔法方法和最佳实践。8、练习与总结        多做练习，通过编写各种使用魔法方法的代码来巩固你的理解，定期总结你学到的知识和经验，形成自己的知识体系。9、注意兼容性        在使用魔法方法时，要注意不同Python版本之间的兼容性差异，确保你的代码在不同版本的Python中都能正常工作。10、避免过度使用        虽然魔法方法非常强大，但过度使用可能会导致代码难以理解和维护，在编写代码时，要权衡使用魔法方法的利弊，避免滥用。        总之，学好Python的魔法方法需要不断地学习、实践和总结，只有通过不断地练习和积累经验，你才能更好地掌握这些强大的工具，并在实际项目中灵活运用它们。四、魔法方法1、__abs__方法1-1、语法__abs__(self,/)abs(self)1-2、参数1-2-1、self(必须)：调用该方法的对象本身。1-2-2、/(可选)：这是从Python3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-onlyparameters)之后的关键字参数(keywordarguments)。1-3、功能        定义当使用内置的abs()函数作用于一个对象时，该对象应该如何计算其绝对值或模(magnitude)。1-4、返回值        返回一个非负值，表示该对象的“大小”或“绝对值”。1-5、说明    该方法通常用于自定义数值类型或需要支持绝对值运算的类。1-6、用法#001、__abs__方法：#1、定义一个简单的数值类classNumber:def__init__(self,value):self.value=valuedef__abs__(self):returnabs(self.value)#使用示例num=Number(-5)print(abs(num))#输出:5，调用了__abs__方法#2、定义一个复数类importmathclassComplexNumber:def__init__(self,real,imag):self.real=realself.imag=imagdef__abs__(self):returnmath.sqrt(self.real**2+self.imag**2)#使用示例cnum=ComplexNumber(3,4)print(abs(cnum))#输出:5.0（因为3^2+4^2=25,sqrt(25)=5）#3、定义一个有理数类classRationalNumber:def__init__(self,numerator,denominator):self.numerator=numeratorself.denominator=denominatorself.reduce()#假设我们有一个reduce方法来简化分数defreduce(self):#这里只是一个简单的示例，真实情况可能需要更复杂的逻辑来简化分数gcd=math.gcd(abs(self.numerator),abs(self.denominator))self.numerator//=gcdself.denominator//=gcddef__abs__(self):returnRationalNumber(abs(self.numerator),self.denominator)def__str__(self):returnf"{self.numerator}/{self.denominator}"#使用示例rat=RationalNumber(-4,2)print(abs(rat))#输出:2/1或2（取决于你如何定义__str__方法）#4、定义一个向量类classVector:def__init__(self,x,y):self.x=xself.y=ydef__abs__(self):return(self.x**2+self.y**2)**0.5#使用示例v=Vector(3,4)print(abs(v))#输出:5.0（向量的模长或绝对值）'运行运行2、__add__方法2-1、语法__add__(self,other,/)Returnself+other2-2、参数2-2-1、self(必须)：表示调用该方法的对象本身。2-2-2、other(必须)：表示与self进行相加操作的对象。2-2-3、/(可选)：这是从Python3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-onlyparameters)之后的关键字参数(keywordarguments)。2-3、功能        用于定义当对象使用“+”运算符进行加法运算时的行为。2-4、返回值        返回一个值，这个值通常表示两个对象相加的结果。2-5、说明        返回值可以是任何类型，但通常它应该是与原始对象类型相同或兼容的类型。2-6、用法#002、__add__方法：#1、整数类的简单加法classInteger:def__init__(self,value):self.value=valuedef__add__(self,other):ifisinstance(other,Integer):returnInteger(self.value+other.value)elifisinstance(other,int):returnInteger(self.value+other)else:raiseTypeError("Unsupportedoperandtypesfor+:'Integer'and'{}'".format(type(other).__name__))def__repr__(self):return"Integer({})".format(self.value)#使用示例a=Integer(5)b=Integer(3)c=a+b#调用a.__add__(b)print(c)#输出:Integer(8)d=a+2#调用a.__add__(2)print(d)#输出:Integer(7)#2、向量类的向量加法classVector:def__init__(self,x,y):self.x=xself.y=ydef__add__(self,other):ifisinstance(other,Vector):returnVector(self.x+other.x,self.y+other.y)else:raiseTypeError("Unsupportedoperandtypesfor+:'Vector'and'{}'".format(type(other).__name__))def__repr__(self):return"Vector({},{})".format(self.x,self.y)#使用示例v1=Vector(1,2)v2=Vector(3,4)v3=v1+v2#调用v1.__add__(v2)print(v3)#输出:Vector(4,6)'运行运行3、__and__方法3-1、语法__and__(self,other,/)Returnself&other3-2、参数3-2-1、self(必须)：表示调用该方法的对象本身。3-2-2、other(必须)：表示与self进行按位与操作的对象。3-2-3、/(可选)：这是从Python3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-onlyparameters)之后的关键字参数(keywordarguments)。3-3、功能        用于定义对象之间按位与(bitwiseAND)操作的行为。3-4、返回值        返回一个值或另一种类型的对象，这个值表示两个操作数按位与的结果。3-5、说明        返回值可以是任何类型，但通常它会返回与操作数相同类型的一个新对象，或者在某些情况下返回另一种类型的对象(只要这个结果是按位与操作的逻辑结果)。3-6、用法#003、__and__方法：classBitField:def__init__(self,value):self.value=valuedef__and__(self,other):#检查other是否为BitField或整数ifisinstance(other,BitField)ther_value=other.valueelifisinstance(other,int)ther_value=otherelse:raiseTypeError(f"Unsupportedoperandtypefor&:'BitField'and'{type(other).__name__}'")#执行按位与操作并返回新的BitField对象returnBitField(self.value&other_value)def__repr__(self):#返回值的二进制表示（仅用于演示）returnf"BitField(binary:{bin(self.value)[2:]},decimal:{self.value})"#使用示例bf1=BitField(60)#60inbinaryis00111100bf2=BitField(13)#13inbinaryis00001101#执行按位与操作result=bf1&bf2print(result)#输出:BitField(binary:1100,decimal:12)#也可以与整数进行按位与操作result_int=bf1&5#5inbinaryis00000101print(result_int)#输出:BitField(binary:100,decimal:4)'运行运行4、__bool__方法4-1、语法__bool__(self,/)TrueifselfelseFalse4-2、参数3-2-1、self(必须)：表示调用该方法的对象本身。3-2-2、/(可选)：这是从Python3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-onlyparameters)之后的关键字参数(keywordarguments)。4-3、功能        允许类的实例在需要布尔值的上下文中(如if语句、while循环的条件、bool()函数调用等)被正确地评估，即需要根据上下文做出正确的评估。4-4、返回值        返回一个布尔值，即True或False。4-5、说明        返回值决定了类的实例在布尔上下文中被视为True还是False。4-6、用法 #004、__bool__方法：#1、基于值的简单示例classSimpleBool:def__init__(self,value):self.value=valuedef__bool__(self):returnbool(self.value)#使用示例s1=SimpleBool(True)s2=SimpleBool(False)s3=SimpleBool(0)s4=SimpleBool(1)print(bool(s1))#输出:Trueprint(bool(s2))#输出:Falseprint(bool(s3))#输出:Falseprint(bool(s4))#输出:Trueifs1:print("s1isTrue")#输出:s1isTrueifnots2:print("s2isFalse")#输出:s2isFalse#2、自定义条件判断classCustomBool:def__init__(self,value):self.value=valuedef__bool__(self):#假设我们想要当value大于0时返回Truereturnself.value>0#使用示例c1=CustomBool(5)c2=CustomBool(-3)c3=CustomBool(0)print(bool(c1))#输出:Trueprint(bool(c2))#输出:Falseprint(bool(c3))#输出:Falseifc1:print("c1isgreaterthan0")#输出:c1isgreaterthan0#3、字符串类，基于内容是否为空classStringWithBool:def__init__(self,content):self.content=contentdef__bool__(self):#如果内容非空，返回Truereturnbool(self.content.strip())#使用示例str1=StringWithBool("Hello,Myelsa!")str2=StringWithBool("")str3=StringWithBool("")#只有空格print(bool(str1))#输出:Trueprint(bool(str2))#输出:Falseprint(bool(str3))#输出:False（因为strip()移除了空格）ifstr1:print("str1isnotempty")#输出:str1isnotempty'运行运行5、__call__方法5-1、语法__call__(*args,**kwargs)Callselfasafunction5-2、参数5-2-1、*args(可变位置参数)：允许你传递任意数量的位置参数给函数。 5-2-2、**kwargs(可变关键字参数)：允许你传递任意数量的关键字参数给函数。 5-3、功能        为类的实例提供函数式调用的能力。5-4、返回值        可以是任何类型，具体取决于你的实现，就像普通的函数一样，你可以从__call__方法中返回任何你想要的值或对象。5-5、说明        当实例被调用时(即使用圆括号和可能的参数)，Python会自动调用该实例的__call__方法，并将括号中的参数传递给该方法。5-6、用法 #005、__call__方法：#1、简单的函数式类classGreeter:def__init__(self,name):self.name=namedef__call__(self,greeting="Hello"):returnf"{greeting},{self.name}!"#使用示例greeter=Greeter("Myelsa")print(greeter("Hi"))#输出:Hi,Myelsa!print(greeter())#输出:Hello,Myelsa!（因为默认参数是"Hello"）#2、计算器类classCalculator:def__init__(self,initial_value=0):self.value=initial_valuedef__call__(self,operand,operation="+"):ifoperation=="+":self.value+=operandelifoperation=="-":self.value-=operand#可以添加更多操作，如乘法、除法等returnself.value#使用示例calc=Calculator(10)print(calc(5))#输出:15（执行加法操作）print(calc(3,"-"))#输出:12（执行减法操作）#3、可调用对象作为装饰器classMyDecorator:def__init__(self,func):self.func=funcdef__call__(self,*args,**kwargs):print("Beforefunctioncall.")result=self.func(*args,**kwargs)print("Afterfunctioncall.")returnresult#使用示例@MyDecoratordefsay_hello(name):print(f"Hello,{name}!")say_hello("Jimmy")#输出:#Beforefunctioncall.#Hello,Jimmy!#Afterfunctioncall.#4、作为装饰器的类classTimer:def__init__(self,func):self.func=funcdef__call__(self,*args,**kwargs):importtimestart_time=time.time()result=self.func(*args,**kwargs)end_time=time.time()print(f"Function{self.func.__name__}took{end_time-start_time:.6f}stoexecute.")returnresult#使用示例@Timerdefslow_function():importtimetime.sleep(1)#模拟耗时操作return"Done"print(slow_function())#输出执行时间以及"Done"#5、具有状态的函数式类classCounter:def__init__(self,start=0):self.count=startdef__call__(self):self.count+=1returnself.count#使用示例counter=Counter(5)print(counter())#输出:6print(counter())#输出:7print(counter())#输出:8'运行运行五、推荐阅读1、Python筑基之旅2、Python函数之旅3、Python算法之旅4、博客个人主页