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

见贤思齐

目录一、概述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、避免过度使用四、魔法方法26、__getstate__方法26-1、语法26-2、参数26-3、功能26-4、返回值26-5、说明26-6、用法27、__gt__方法27-1、语法27-2、参数27-3、功能27-4、返回值27-5、说明27-6、用法28、__setstate__方法28-1、语法28-2、参数28-3、功能28-4、返回值28-5、说明28-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的魔法方法需要不断地学习、实践和总结，只有通过不断地练习和积累经验，你才能更好地掌握这些强大的工具，并在实际项目中灵活运用它们。四、魔法方法26、__getstate__方法26-1、语法__getstate__(self,/)Helperforpickle26-2、参数26-2-1、self(必须)：一个对实例对象本身的引用，在类的所有方法中都会自动传递。 26-2-2、/(可选)：这是从Python3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-onlyparameters)之后的关键字参数(keywordarguments)。26-3、功能    用于返回对象的状态，这样该对象就可以被pickle模块序列化为字节流，以便之后可以通过pickle.loads()反序列化回原始对象。26-4、返回值        返回一个可以被pickle模块序列化的对象，通常是一个字典，其中包含了重构对象所需的所有状态信息。26-5、说明    如果你的类有动态生成的属性或者使用了__slots__来限制实例属性，那么你可能需要更仔细地编写__getstate__和__setstate__方法来确保所有必要的信息都被正确地序列化和反序列化。26-6、用法#026、__getstate__方法：#1、基本示例importpickleclassMyClass:def__init__(self,x,y):self.x=xself.y=ydef__getstate__(self):return{'x':self.x,'y':self.y}def__setstate__(self,state):self.x=state['x']self.y=state['y']if__name__=='__main__':#序列化和反序列化obj=MyClass(10,24)serialized_obj=pickle.dumps(obj)deserialized_obj=pickle.loads(serialized_obj)print(deserialized_obj.x,deserialized_obj.y)#输出:1024#2、忽略某些属性classPerson:def__init__(self,name,age,password):self.name=nameself.age=ageself._password=password#不想在序列化中包含密码def__getstate__(self):return{'name':self.name,'age':self.age}def__setstate__(self,state):self.name=state['name']self.age=state['age']self._password=None#假设在反序列化时重置密码#3、自定义序列化格式classPoint:def__init__(self,x,y):self.x=xself.y=ydef__getstate__(self):return(self.x,self.y)#使用元组而不是字典def__setstate__(self,state):self.x,self.y=state#4、处理不可序列化的属性importsocketclassConnection:def__init__(self,host,port):self.host=hostself.port=portself.socket=socket.socket()#不可序列化def__getstate__(self):#不包括socket对象return{'host':self.host,'port':self.port}def__setstate__(self,state):self.host=state['host']self.port=state['port']self.socket=socket.socket()#在反序列化时重新创建socket#5、序列化和反序列化时执行额外操作classLoggedClass:def__init__(self,data):self.data=datadef__getstate__(self):print("Serializing...",self.data)return{'data':self.data}def__setstate__(self,state):print("Deserializing...",state['data'])self.data=state['data']#6、处理集合类型classSetExample:def__init__(self,items):self.items=set(items)def__getstate__(self):return{'items':list(self.items)}#将集合转换为列表def__setstate__(self,state):self.items=set(state['items'])#将列表转换回集合#7、嵌套对象classInner:def__init__(self,value):self.value=valueclassOuter:def__init__(self,inner):self.inner=innerdef__getstate__(self):return{'inner':self.inner.__getstate__()}#嵌套对象也需要序列化def__setstate__(self,state):self.inner=Inner.__new__(Inner)#创建新实例self.inner.__setstate__(state['inner'])#反序列化嵌套对象#8、带有文件和文件描述符的对象importosclassFileHandler:def__init__(self,filename):self.filename=filenameself.file=open(filename,'rb')def__getstate__(self):#关闭文件描述符，只保存文件名self.file.close()return{'filename':self.filename}def__setstate__(self,state):self.filename=state['filename']self.file=open(self.filename,'rb')#9、带有循环引用的对象classNode:def__init__(self,value,next_node=None):self.value=valueself.next_node=next_nodedef__getstate__(self):#处理循环引用，通常使用弱引用或特殊标记#这里简化处理，只保存值和下一个节点的ID（如果可用）ifself.next_nodeisnotNone:next_id=id(self.next_node)else:next_id=Nonereturn{'value':self.value,'next_id':next_id}def__setstate__(self,state):self.value=state['value']self.next_node=None#初始为空#在这里，你可能需要一个节点ID到节点的映射来恢复循环引用#10、带有线程或进程的对象importthreadingclassThreadedClass:def__init__(self):self.thread=threading.Thread(target=self.run)self.thread.start()defrun(self):#模拟线程运行passdef__getstate__(self):#线程不能序列化，所以只保存其他数据（如果有的话）#这里假设没有其他数据可保存，所以返回空字典return{}def__setstate__(self,state):#在反序列化时，重新创建线程（如果需要的话）#但通常不推荐这样做，因为线程状态难以恢复pass#注意：线程和进程状态通常不能序列化，因为它们与特定执行环境紧密相关27、__gt__方法27-1、语法__gt__(self,other,/)Returnself>other27-2、参数27-2-1、self(必须)：一个对实例对象本身的引用，在类的所有方法中都会自动传递。 27-2-2、other(必须)：表示与self进行比较的另一个对象。27-2-3、/(可选)：这是从Python3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-onlyparameters)之后的关键字参数(keywordarguments)。27-3、功能        用于定义对象之间的“大于”(greaterthan)比较操作。27-4、返回值        返回一个布尔值(True或False)，如果self大于other，则返回True；反之，则返回False。27-5、说明        如果self.value大于other.value，则方法返回True；否则，你可以根据需要选择返回False或者抛出一个异常。27-6、用法#027、__gt__方法：#1、比较两个数字类classNumber:def__init__(self,value):self.value=valuedef__gt__(self,other):ifisinstance(other,Number):returnself.value>other.valuereturnNotImplementedif__name__=='__main__':a=Number(5)b=Number(3)print(a>b)#True#2、比较两个字符串长度classStringLength:def__init__(self,string):self.string=stringdef__gt__(self,other):ifisinstance(other,StringLength):returnlen(self.string)>len(other.string)returnNotImplementedif__name__=='__main__':s1=StringLength("hello")s2=StringLength("world")print(s1>s2)#False#3、比较两个日期对象fromdatetimeimportdateclassDateWrapper:def__init__(self,year,month,day):self.date=date(year,month,day)def__gt__(self,other):ifisinstance(other,DateWrapper):returnself.date>other.datereturnNotImplementedif__name__=='__main__':d1=DateWrapper(2024,3,13)d2=DateWrapper(2024,6,1)print(d1>d2)#False#4、比较两个自定义分数类fromfractionsimportFractionclassMyFraction:def__init__(self,numerator,denominator):self.fraction=Fraction(numerator,denominator)def__gt__(self,other):ifisinstance(other,MyFraction):returnself.fraction>other.fractionreturnNotImplementedif__name__=='__main__':f1=MyFraction(3,2)f2=MyFraction(1,1)print(f1>f2)#True#5、比较两个点的坐标(二维空间)classPoint:def__init__(self,x,y):self.x=xself.y=ydef__gt__(self,other):ifisinstance(other,Point):#比较x坐标，如果相等则比较y坐标ifself.x==other.x:returnself.y>other.yreturnself.x>other.xreturnNotImplementedif__name__=='__main__':p1=Point(3,6)p2=Point(5,11)print(p1>p2)#False#6、比较两个矩形的面积classRectangle:def__init__(self,width,height):self.width=widthself.height=height@propertydefarea(self):returnself.width*self.heightdef__gt__(self,other):ifisinstance(other,Rectangle):returnself.area>other.areareturnNotImplementedif__name__=='__main__':r1=Rectangle(3,6)r2=Rectangle(5,11)print(r1>r2)#False#7、比较两个列表的长度classListWrapper:def__init__(self,lst):self.lst=lstdef__gt__(self,other):ifisinstance(other,ListWrapper):returnlen(self.lst)>len(other.lst)returnNotImplementedif__name__=='__main__':lw1=ListWrapper([1,2,3])lw2=ListWrapper([1,2])print(lw1>lw2)#True#8、比较两个字典的键的数量classDictWrapper:def__init__(self,dct):self.dct=dctdef__gt__(self,other):ifisinstance(other,DictWrapper):returnlen(self.dct.keys())>len(other.dct.keys())returnNotImplementedif__name__=='__main__':dw1=DictWrapper({'a':1,'b':2})dw2=DictWrapper({'a':1})print(dw1>dw2)#True#9、比较两个自定义员工类的薪资classEmployee:def__init__(self,name,salary):self.name=nameself.salary=salarydef__gt__(self,other):ifisinstance(other,Employee):returnself.salary>other.salaryreturnNotImplementedif__name__=='__main__':emp1=Employee('Myelsa',50000)emp2=Employee('Jimmy',48000)print(emp1>emp2)#True#10、比较两个自定义时间段的时长fromdatetimeimporttimedeltaclassTimePeriod:def__init__(self,start,end):self.start=startself.end=end@propertydefduration(self):returnself.end-self.startdef__gt__(self,other):ifisinstance(other,TimePeriod):returnself.duration>other.durationreturnNotImplementedif__name__=='__main__':tp1=TimePeriod(timedelta(hours=2),timedelta(hours=3))tp2=TimePeriod(timedelta(hours=1),timedelta(hours=2))print(tp1>tp2)#False#注意：这里的timedelta对象不能直接相减，这里的示例仅用于展示结构#11、比较两个自定义成绩类的分数classGrade:def__init__(self,score):self.score=scoredef__gt__(self,other):ifisinstance(other,Grade):returnself.score>other.scorereturnNotImplementedif__name__=='__main__':g1=Grade(90)g2=Grade(85)print(g1>g2)#True#12、比较两个自定义商品的价格classProduct:def__init__(self,name,price):self.name=nameself.price=pricedef__gt__(self,other):ifisinstance(other,Product):returnself.price>other.pricereturnNotImplementedif__name__=='__main__':p1=Product('Laptop',1000)p2=Product('Phone',800)print(p1>p2)#True28、__setstate__方法28-1、语法__setstate__(self,state,/)Setstateinformationforunpickling28-2、参数28-2-1、self(必须)：一个对实例对象本身的引用，在类的所有方法中都会自动传递。 28-2-2、state(必须)：一个对象(通常是一个字典)，包含了在序列化时由__getstate__方法返回的状态信息。28-2-3、/(可选)：这是从Python3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-onlyparameters)之后的关键字参数(keywordarguments)。28-3、功能        使用传入的state参数(通常是一个字典或其他数据结构)来重新构造对象的内部状态。28-4、返回值        没有返回值，即返回None。28-5、说明        在__setstate__方法内部，你可以根据state中的数据来设置对象的属性、调用其他方法或执行其他必要的操作，以确保对象在反序列化后具有与序列化时相同的状态。28-6、用法#028、__setstate__方法：#1、基本示例importpickleclassMyClass:def__init__(self,x,y):self.x=xself.y=ydef__getstate__(self):return{'x':self.x,'y':self.y}def__setstate__(self,state):self.x=state['x']self.y=state['y']if__name__=='__main__':#序列化和反序列化obj=MyClass(10,24)serialized_obj=pickle.dumps(obj)deserialized_obj=pickle.loads(serialized_obj)print(deserialized_obj.x,deserialized_obj.y)#输出:1024#2、忽略某些属性classPerson:def__init__(self,name,age,password):self.name=nameself.age=ageself._password=password#不想在序列化中包含密码def__getstate__(self):return{'name':self.name,'age':self.age}def__setstate__(self,state):self.name=state['name']self.age=state['age']self._password=None#假设在反序列化时重置密码#3、自定义序列化格式classPoint:def__init__(self,x,y):self.x=xself.y=ydef__getstate__(self):return(self.x,self.y)#使用元组而不是字典def__setstate__(self,state):self.x,self.y=state#4、处理不可序列化的属性importsocketclassConnection:def__init__(self,host,port):self.host=hostself.port=portself.socket=socket.socket()#不可序列化def__getstate__(self):#不包括socket对象return{'host':self.host,'port':self.port}def__setstate__(self,state):self.host=state['host']self.port=state['port']self.socket=socket.socket()#在反序列化时重新创建socket#5、序列化和反序列化时执行额外操作classLoggedClass:def__init__(self,data):self.data=datadef__getstate__(self):print("Serializing...",self.data)return{'data':self.data}def__setstate__(self,state):print("Deserializing...",state['data'])self.data=state['data']#6、处理集合类型classSetExample:def__init__(self,items):self.items=set(items)def__getstate__(self):return{'items':list(self.items)}#将集合转换为列表def__setstate__(self,state):self.items=set(state['items'])#将列表转换回集合#7、嵌套对象classInner:def__init__(self,value):self.value=valueclassOuter:def__init__(self,inner):self.inner=innerdef__getstate__(self):return{'inner':self.inner.__getstate__()}#嵌套对象也需要序列化def__setstate__(self,state):self.inner=Inner.__new__(Inner)#创建新实例self.inner.__setstate__(state['inner'])#反序列化嵌套对象#8、带有文件和文件描述符的对象importosclassFileHandler:def__init__(self,filename):self.filename=filenameself.file=open(filename,'rb')def__getstate__(self):#关闭文件描述符，只保存文件名self.file.close()return{'filename':self.filename}def__setstate__(self,state):self.filename=state['filename']self.file=open(self.filename,'rb')#9、带有循环引用的对象classNode:def__init__(self,value,next_node=None):self.value=valueself.next_node=next_nodedef__getstate__(self):#处理循环引用，通常使用弱引用或特殊标记#这里简化处理，只保存值和下一个节点的ID（如果可用）ifself.next_nodeisnotNone:next_id=id(self.next_node)else:next_id=Nonereturn{'value':self.value,'next_id':next_id}def__setstate__(self,state):self.value=state['value']self.next_node=None#初始为空#在这里，你可能需要一个节点ID到节点的映射来恢复循环引用#10、带有线程或进程的对象importthreadingclassThreadedClass:def__init__(self):self.thread=threading.Thread(target=self.run)self.thread.start()defrun(self):#模拟线程运行passdef__getstate__(self):#线程不能序列化，所以只保存其他数据（如果有的话）#这里假设没有其他数据可保存，所以返回空字典return{}def__setstate__(self,state):#在反序列化时，重新创建线程（如果需要的话）#但通常不推荐这样做，因为线程状态难以恢复pass#注意：线程和进程状态通常不能序列化，因为它们与特定执行环境紧密相关五、推荐阅读1、Python筑基之旅2、Python函数之旅3、Python算法之旅4、博客个人主页