要了解@property的用途,首先要了解如何创建一个属性。
一般而言,属性都通过__init__方法创建,比如:
1 class Student(object):
2 def __init__(self,name,score):
3 self.name=name
4 self.score=score
创建实例,运行结果:
tim=Student('Tim',97)
tim.score=100
tim.score
100
mary=Student('Mary',90)
mary.score
90
但是这样子有2个坏处:
1.__init__ 中定义的属性是可变的,如果一个系统的开发人员在知道属性名的情况下,就可以进行随意更改(尽管可能是在无意识的情况下),如果一不小心篡改了,后台排查很难!
2.不利于进行参数检查,比如:score属性范围本该是[0,100],但如果输成了1000也不会报错。
因此,一个标准的创建属性流程如下:
1.定义三个跟属性(本例中是score)相关的函数:
get(用于返回score属性)
set(用于设定score属性)
del(用于删除score属性)
在set函数中,可以添加一些取值范围,比如[0,100].此外,为了私有化属性,前面可以加上__。
这样就做到了既能通过创建实例设定属性,又不让开发人员轻易修改score属性。
如下所示:
class Student(object):
def getScore(self):
return self.__score
def setScore(self,score):
if score>100 or score<0:
raise ValueError ('score is out of range.')
else:
self.__score=score
def delScore(self):
del self.__score
这样,一旦score取值不在设定范围内,就会报错!
创建一个实例,能够正常运行:
1 Mary=Student()
2 Mary.setScore(90)
3 Mary.getScore()
4 90
但是,通过方法getScore()查看分数似乎还是有点繁琐,能不能把它当作一个属性去调用呢?至少调用不需要输入()嘛!
当然是可以的。
办法就是通过装饰器:@property
通过给getScore,setScore,delScore三个方法分别添加三个装饰器,就可以直接把这三个方法作为属性去调用了!
如下所示:
class Student(object):
@property
def getScore(self):
return self.__score
@getScore.setter
def setScore(self,score):
if score>100 or score<0:
raise ValueError ('score is out of range.')
else:
self.__score=score
@getScore.deleter
def delScore(self):
del self.__score
1 tim=Student()
2 tim.setScore=90
3 tim.getScore
4 90
非常神奇!方法居然变成了属性,为什么呢?
因为装饰器@property本质上是一个property()函数,property()函数也是一个装饰器。
一般的装饰器是用在普通函数上,而@property是用在类内的方法上。
property()函数包含了三个部分:getter,setter,deleter。
因为setter和deleter是property()的第二和第三个参数,不能直接套用@语法。
因此,本质上@property相当于getter部分,@setScore.setter相当于setter部分,@delScore.deleter相当于deleter部分。
所以,上面的代码本质上等价于:
class Student(object):
def getScore(self):
return self.__score
def setScore(self,score):
if score>100 or score<0:
raise ValueError ('score is out of range.')
else:
self.__score=score
def delScore(self):
del self.__score
score=property(getScore,setScore,delScore,'description')
最后,为了函数名美观,可以把函数名字改成Score():
class Student(object):
@property
def Score(self):
return self.__score
@Score.setter
def Score(self,score):
if score>100 or score<0:
raise ValueError ('score is out of range.')
else:
self.__score=score
@Score.deleter
def delScore(self):
del self.__score
tim=Student()
tim.Score=90
tim.Score
90