博主写的很详细
https://www.cnblogs.com/hls-code/p/14821055.html?ivk_sa=1024320u
一、@property的介绍与使用
python的@property是python的一种装饰器,是用来修饰方法的。
1、作用
我们可以使用@property装饰器来创建只读属性,@property装饰器会将方法转换为相同名称的只读属性,可以与所定义的属性配合使用,这样可以防止属性被修改。
例如:在绑定属性时,如果我们直接把属性暴露出去,虽然写起来很简单,但是,没办法检查参数,导致可以把成绩随便改:
s = Student() s.score = 9999
这显然不合逻辑。为了限制score的范围,可以通过一个set_score()
方法来设置成绩,再通过一个get_score()
来获取成绩,这样,在set_score()
方法里,就可以检查参数:
![复制代码](https://common.cnblogs.com/images/copycode.gif)
class Student(object): def get_score(self): return self._score def set_score(self, value): if not isinstance(value, int): raise ValueError('score must be an integer!') if value < 0 or value > 100: raise ValueError('score must between 0 ~ 100!') self._score = value
![复制代码](https://common.cnblogs.com/images/copycode.gif)
现在,对任意的Student实例进行操作,就不能随心所欲地设置score了:
![复制代码](https://common.cnblogs.com/images/copycode.gif)
>>> s = Student() >>> s.set_score(60) # ok! >>> s.get_score() 60 >>> s.set_score(9999) Traceback (most recent call last): ... ValueError: score must between 0 ~ 100!
![复制代码](https://common.cnblogs.com/images/copycode.gif)
但是,上面的调用方法又略显复杂,没有直接用属性这么直接简单。
有没有既能检查参数,又可以用类似属性这样简单的方式来访问类的变量呢?
Python内置的@property
装饰器就是负责把一个方法变成属性调用的:
![复制代码](https://common.cnblogs.com/images/copycode.gif)
class Student(object): @property def score(self): return self._score @score.setter def score(self, value): if not isinstance(value, int): raise ValueError('score must be an integer!') if value < 0 or value > 100: raise ValueError('score must between 0 ~ 100!') self._score = value
![复制代码](https://common.cnblogs.com/images/copycode.gif)
@property
的实现比较复杂,我们先考察如何使用。把一个getter方法变成属性,只需要加上@property
就可以了,此时,@property
本身又创建了另一个装饰器@score.setter
,负责把一个setter方法变成属性赋值,于是,我们就拥有一个可控的属性操作:
![复制代码](https://common.cnblogs.com/images/copycode.gif)
>>> s = Student() >>> s.score = 60 # OK,实际转化为s.set_score(60) >>> s.score # OK,实际转化为s.get_score() 60 >>> s.score = 9999 Traceback (most recent call last): ... ValueError: score must between 0 ~ 100!
![复制代码](https://common.cnblogs.com/images/copycode.gif)
注意到这个神奇的@property
,我们在对实例属性操作的时候,就知道该属性很可能不是直接暴露的,而是通过getter和setter方法来实现的。
还可以定义只读属性,只定义getter方法,不定义setter方法就是一个只读属性:
![复制代码](https://common.cnblogs.com/images/copycode.gif)
class Student(object): @property def birth(self): return self._birth @birth.setter def birth(self, value): self._birth = value @property def age(self): return 2014 - self._birth
![复制代码](https://common.cnblogs.com/images/copycode.gif)
上面的birth
是可读写属性,而age
就是一个只读属性,因为age
可以根据birth
和当前时间计算出来。
@property
广泛应用在类的定义中,可以让调用者写出简短的代码,同时保证对参数进行必要的检查,这样,程序运行时就减少了出错的可能性。
2、使用场景
1.修饰方法,是方法可以像属性一样访问。
![复制代码](https://common.cnblogs.com/images/copycode.gif)
class DataSet(object): @property def method_with_property(self): ##含有@property return 15 def method_without_property(self): ##不含@property return 15 l = DataSet() print(l.method_with_property) # 加了@property后,可以用调用属性的形式来调用方法,后面不需要加()。 print(l.method_without_property()) #没有加@property , 必须使用正常的调用方法的形式,即在后面加()
输出结果:
两个都输出为15
![复制代码](https://common.cnblogs.com/images/copycode.gif)
![复制代码](https://common.cnblogs.com/images/copycode.gif)
class DataSet(object): @property def method_with_property(self): ##含有@property return 15 l = DataSet() print(l.method_with_property()) # 加了@property后,可以用调用属性的形式来调用方法,后面不需要加()。
输出结果:
如果使用property进行修饰后,又在调用的时候,方法后面添加了(), 那么就会显示错误信息:TypeError: 'int' object is not callable,
也就是说添加@property 后,这个方法就变成了一个属性,如果后面加入了(),那么就是当作函数来调用,而它却不是callable(可调用)的。
![复制代码](https://common.cnblogs.com/images/copycode.gif)
![复制代码](https://common.cnblogs.com/images/copycode.gif)
class DataSet(object): def method_without_property(self): ##不含@property return 15 l = DataSet() print(l.method_without_property) #没有加@property , 必须使用正常的调用方法的形式,即在后面加()
输出结果:
没有使用property修饰,它是一种方法,如果把括号去掉,不会报错输出的就会是方法存放的内存地址。【相当于对象正常调用函数】
![复制代码](https://common.cnblogs.com/images/copycode.gif)
2.与所定义的属性配合使用,这样可以防止属性被修改。
可以通过@property的方法来进行设置私有属性。这样可以隐藏属性名,让用户进行使用的时候无法随意修改。
![复制代码](https://common.cnblogs.com/images/copycode.gif)
class DataSet(object): def __init__(self): self._images = 1 self._labels = 2 #定义属性的名称 @property def images(self): #方法加入@property后,这个方法相当于一个属性,这个属性可以让用户进行使用,而且用户有没办法随意修改。 return self._images @property def labels(self): return self._labels l = DataSet() #用户进行属性调用的时候,直接调用images即可,而不用知道属性名_images,因此用户无法更改属性,从而保护了类的属性。 print(l.images) # 加了@property后,可以用调用属性的形式来调用方法,后面不需要加()。
![复制代码](https://common.cnblogs.com/images/copycode.gif)