属性与 @property 方法让你的python更高效
一、用属性替代getter或setter方法
以下代码中包含手动实现的getter(get_ohms)和setter(set_ohms)方法:
classOldResistor(object): def__init__(self,ohms): self._ohms=ohms self.voltage=0 self.current=0 defget_ohms(self): returnself._ohms defset_ohms(self,ohms): self._ohms=ohms r0=OldResistor(50e3) print(f'Before:{r0.get_ohms()}') r0.set_ohms(10e3) print(f'After:{r0.get_ohms()}') #=>Before:50000.0 #=>After:10000.0
这些工具方法有助于定义类的接口,使得开发者可以方便地封装功能、验证用法并限定取值范围。
但是在Python语言中,应尽量从简单的public属性写起:
classResistor(object): def__init__(self,ohms): self.ohms=ohms self.voltage=0 self.current=0 r1=Resistor(50e3) print(f'Before:{r1.ohms}') r1.ohms=10e3 print(f'After:{r1.ohms}') #=>Before:50000.0 #=>After:10000.0
访问实例的属性则可以直接使用instance.property这样的格式。
如果想在设置属性的同时实现其他特殊的行为,如在对上述Resistor类的voltage属性赋值时,需要同时修改其current属性。
可以借助@property装饰器和setter方法实现此类需求:
fromresistorimportResistor classVoltageResistor(Resistor): def__init__(self,ohms): super().__init__(ohms) self._voltage=0 @property defvoltage(self): returnself._voltage @voltage.setter defvoltage(self,voltage): self._voltage=voltage self.current=self._voltage/self.ohms r2=VoltageResistor(1e3) print(f'Before:{r2.current}amps') r2.voltage=10 print(f'After:{r2.current}amps') Before:0amps After:0.01amps
此时设置voltage属性会执行名为voltage的setter方法,更新当前对象的current属性,使得最终的电流值与电压和电阻相匹配。
@property的其他使用场景
属性的setter方法里可以包含类型验证和数值验证的代码:
fromresistorimportResistor classBoundedResistor(Resistor): def__init__(self,ohms): super().__init__(ohms) @property defohms(self): returnself._ohms @ohms.setter defohms(self,ohms): ifohms<=0: raiseValueError('ohmsmustbe>0') self._ohms=ohms r3=BoundedResistor(1e3) r3.ohms=-5 #=>ValueError:ohmsmustbe>0
甚至可以通过@property防止继承自父类的属性被修改:
fromresistorimportResistor classFixedResistance(Resistor): def__init__(self,ohms): super().__init__(ohms) @property defohms(self): returnself._ohms @ohms.setter defohms(self,ohms): ifhasattr(self,'_ohms'): raiseAttributeError("Can'tsetattribute") self._ohms=ohms r4=FixedResistance(1e3) r4.ohms=2e3 #=>AttributeError:Can'tsetattribute
要点
- 优先使用public属性定义类的接口,不手动实现getter或setter方法
- 在访问属性的同时需要表现某些特殊的行为(如类型检查、限定取值)等,使用@property
- @property的使用需遵循ruleofleastsurprise原则,避免不必要的副作用
- 缓慢或复杂的工作,应放在普通方法中
二、需要复用的@property方法
对于如下需求:
编写一个Homework类,其成绩属性在被赋值时需要确保该值大于0且小于100。借助@property方法实现起来非常简单:
classHomework(object): def__init__(self): self._grade=0 @property defgrade(self): returnself._grade @grade.setter defgrade(self,value): ifnot(0<=value<=100): raiseValueError('Grademustbebetween0and100') self._grade=value galileo=Homework() galileo.grade=95 print(galileo.grade) #=>95
假设上述验证逻辑需要用在包含多个科目的考试成绩上,每个科目都需要单独计分。则@property方法及验证代码就要重复编写多次,同时这种写法也不够通用。
采用Python的描述符可以更好地实现上述功能。在下面的代码中,Exam类将几个Grade实例作为自己的类属性,Grade类则通过__get__和__set__方法实现了描述符协议。
classGrade(object): def__init__(self): self._value=0 def__get__(self,instance,instance_type): returnself._value def__set__(self,instance,value): ifnot(0<=value<=100): raiseValueError('Grademustbebetween0and100') self._value=value classExam(object): math_grade=Grade() science_grade=Grade() first_exam=Exam() first_exam.math_grade=82 first_exam.science_grade=99 print('Math',first_exam.math_grade) print('Science',first_exam.science_grade) second_exam=Exam() second_exam.science_grade=75 print('Secondexamsciencegrade',second_exam.science_grade,',right') print('Firstexamsciencegrade',first_exam.science_grade,',wrong') #=>Math82 #=>Science99 #=>Secondexamsciencegrade75,right #=>Firstexamsciencegrade75,wrong
在对exam实例的属性进行赋值操作时:
exam=Exam() exam.math_grade=40
Python会将其转译为如下代码:
Exam.__dict__['math_grade'].__set__(exam,40)
而获取属性值的代码:
print(exam.math_grade)
也会做如下转译:
print(Exam.__dict__['math_grade'].__get__(exam,Exam))
但上述实现方法会导致不符合预期的行为。由于所有的Exam实例都会共享同一份Grade实例,在多个Exam实例上分别操作某一个属性就会出现错误结果。
second_exam=Exam() second_exam.science_grade=75 print('Secondexamsciencegrade',second_exam.science_grade,',right') print('Firstexamsciencegrade',first_exam.science_grade,',wrong') #=>Secondexamsciencegrade75,right #=>Firstexamsciencegrade75,wrong
可以做出如下改动,将每个Exam实例所对应的值依次记录到Grade中,用字典结构保存每个实例的状态:
classGrade(object): def__init__(self): self._values={} def__get__(self,instance,instance_type): ifinstanceisNone: returnself returnself._values.get(instance,0) def__set__(self,instance,value): ifnot(0<=value<=100): raiseValueError('Grademustbebetween0and100') self._values[instance]=value classExam(object): math_grade=Grade() writing_grade=Grade() science_grade=Grade() first_exam=Exam() first_exam.math_grade=82 second_exam=Exam() second_exam.math_grade=75 print('Firstexammathgrade',first_exam.math_grade,',right') print('Secondexammathgrade',second_exam.math_grade,',right') #=>Firstexammathgrade82,right #=>Secondexammathgrade75,right
还有另外一个问题是,在程序的生命周期内,对于传给__set__的每个Exam实例来说,_values字典都会保存指向该实例的一份引用,导致该实例的引用计数无法降为0从而无法被GC回收。
解决方法是将普通字典替换为WeakKeyDictionary:
fromweakrefimportWeakKeyDictionary self._values=WeakKeyDictionary()
参考资料
EffectivePython
以上就是属性与@property方法让你的python更高效的详细内容,更多关于python属性与@property方法的资料请关注毛票票其它相关文章!