python中的property()
笔者在初次接触property的时候被它弄的晕头转向,查阅网上很多资料包括官方文档后仍然搞不清楚它是什么东西,后面才慢慢摸出它的门道,因此在这里谈谈我对property函数的心得。
首先带大家看看网上对它的解释
描述
property()函数的作用是在新式类中返回属性值
语法
class property(fget,fset,fdel,doc)
- fget: 获取属性值
- fset:设置属性值
- fdel:删除属性值
- doc:属性描述信息
实例
class C(object):
def __init__(self):
self._x = None
def getx(self):
return self._x
def setx(self, value):
self._x = value
def delx(self):
del self._x
x = property(getx, setx, delx, "I'm the x property")
如果 c 是 C 的实例化, c.x 将触发 getter,c.x = value 将触发 setter , del c.x 触发 deleter,也就是说,python可以自动识别并且完成这一转换,从而达到用我们习惯的方式来调用他们的效果。
如果给定 doc 参数,其将成为这个属性值的 docstring,否则 property 函数就会复制 fget 函数的 docstring(如果有的话)。
那么有人会问了,既然直接可以显示地用原来地方法比如c.x,x = 10来完成对它地调用和赋值,又为什么要大费周章地用property()来调用它呢,这不是多此一举吗?注意,我们在赋值地时候很可能会超出变量的合理范围,而property()实际调用的是函数,这样就可以在函数中对传入的参数进行判断,如果不满足要求便提出错误信息,这是单纯的赋值所做不到的。
另外,将 property 函数用作装饰器可以很方便的创建只读属性,下面让我们看看这是怎么做到的
修饰器语法@property
@property装饰器负责把一个方法变成属性调用,原来需要写C.x(), 加上它以后只要写C.x,这和调用属性一样。
比如:
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
这样子score = 10,会自动调用它的setter属性。
但是大家有没有注意到,类中的实际变量名是 _score,而函数的变量名是score,这少掉的一横便是它的精妙所在,因为我们习惯命名变量的时候是不会写这一横的,也就是说你在写score = 10的时候并不是直接给类的变量赋值,而是通过score()函数间接赋值,这是一种迷惑性的做法,这就意味着如果只定义getter方法,不定义setter方法就是一个只读属性,然而你如果写 _score = 10,仍然可以赋值的,这是一种伪封装,然而调用函数的人是不知道这一点的。
注意,有@property时候下面的函数名不能和变量名一样,要不然调用的时候会引起二义性,比如写C.x,python无法识别你是在调用它的变量还是它的函数C.x(),没有@property的时候是可以的