Python类的属性检查
在绑定属性时,如果我们直接把属性暴露出去,虽然写起来很简单,但是,没办法检查参数,导致属性可以把随便更改:
class Foo(object):
pass
foo1 = Foo()
foo1.age = 666
这显然不合逻辑。为了限制age的范围,可以通过一个set_age()
方法来设置成绩,再通过一个get_age()
来获取成绩,这样,在set_age()
方法里,就可以检查参数:
class Foo(object):
def get_age(self):
return self._age
def set_age(self, value):
if not isinstance(value, int):
raise ValueError('age must be an integer!')
if value < 0 or value > 130:
raise ValueError('age must between 0 ~ 130!')
self._age = value
现在,对任意的Foo实例进行操作,就不能随心所欲地设置age了:
>>> foo2 = Foo()
>>> foo2.set_age(60) # ok!
>>> foo2.get_age()
60
>>> foo2.set_age(9999)
Traceback (most recent call last):
...
ValueError: age must between 0 ~ 130!
但是,上面的调用方法又略显复杂,没有直接用属性这么直接简单。
有没有既能检查参数,又可以用类似属性这样简单的方式来访问类的变量呢?
Python装饰器(decorator)可以给函数动态加上功能对于类的方法,装饰器一样起作用。Python内置的@property
装饰器就是负责把一个方法变成属性调用的:
class Foo(object):
@property
def age(self):
return self._age
@age.setter
def age(self, value):
if not isinstance(value, int):
raise ValueError('age must be an integer!')
if value < 0 or value > 130:
raise ValueError('age must between 0 ~ 130!')
self._age = value
把一个getter方法变成属性,只需要加上@property
就可以了,此时,@property
本身又创建了另一个装饰器@age.setter
,负责把一个setter方法变成属性赋值,于是,我们就拥有一个可控的属性操作:
>>> foo3 = Foo()
>>> foo3.age = 60 # OK,实际转化为age.set_score(60)
>>> foo3.age # OK,实际转化为age.get_score()
60
>>> foo3.age = 9999
Traceback (most recent call last):
...
ValueError: age must between 0 ~ 130!
注意到这个神奇的@property
,我们在对实例属性操作的时候,就知道该属性很可能不是直接暴露的,而是通过getter和setter方法来实现的。
还可以定义只读属性,只定义getter方法,不定义setter方法就是一个只读属性:
class Foo(object):
@property
def birth(self):
return self._birth
@birth.setter
def birth(self, value):
self._birth = value
@property
def age(self):
return 2017 - self._birth
上面的birth
是可读写属性,而age
就是一个只读属性,因为age
可以根据birth
和当前时间计算出来。
小结
@property
广泛应用在类的定义中,可以让调用者写出简短的代码,同时保证对参数进行必要的检查,这样,程序运行时就减少了出错的可能性。