blogs

32 面向对象高级编程使用_使用@property

在绑定属性时,如果我们直接把属性暴露出去,虽然写起来很简单,但是,没办法检查参数,导致可以把成绩随便改:

class Student(object):
    pass
    
s = Student()
s.score = 9999

这显然不合逻辑。为了限制score的范围,可以通过一个set_score()方法来设置成绩,再通过一个get_score()来获取成绩,这样,在set_score()方法里,就可以检查参数:

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 interger!')
        if value < 0 or value > 100:
            raise ValueError('score must between 0-100!')
        self._score = value

现在,对任意的Student实例进行操作,就不能随心所欲地设置score了:

s = Student()
s.set_score(69)
s.get_score()
69
s.set_score(101)
---------------------------------------------------------------------------

ValueError                                Traceback (most recent call last)

<ipython-input-9-9468edff851e> in <module>
----> 1 s.set_score(101)


<ipython-input-5-c36d34d34c1f> in set_score(self, value)
      8             raise ValueError('score must be an interger!')
      9         if value < 0 or value > 100:
---> 10             raise ValueError('score must between 0-100!')
     11         self._score = value


ValueError: score must between 0-100!

但是,上面的调用方法又略显复杂,没有直接用属性这么直接简单。

有没有既能检查参数,又可以用类似属性这样简单的方式来访问类的变量呢?对于追求完美的Python程序员来说,这是必须要做到的!

还记得装饰器(decorator)可以给函数动态加上功能吗?对于类的方法,装饰器一样起作用。Python内置的@property装饰器就是负责把一个方法变成属性调用的:

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 interger!')
        if value < 0 or value > 100:
            raise ValueError('score must between 0-100!')
            self._score = value
s = Student()
s.score = 60
s.score
60
s.score = 101
---------------------------------------------------------------------------

ValueError                                Traceback (most recent call last)

<ipython-input-14-d2ccd1397820> in <module>
----> 1 s.score = 101


<ipython-input-11-a316a67efe83> in score(self, value)
     10             raise ValueError('score must be an interger!')
     11         if value < 0 or value > 100:
---> 12             raise ValueError('score must between 0-100!')
     13         self._score = value


ValueError: score must between 0-100!

注意到这个神奇的@property,我们在对实例属性操作的时候,就知道该属性很可能不是直接暴露的,而是通过getter和setter方法来实现的。

还可以定义只读属性,只定义getter方法,不定义setter方法就是一个只读属性:

class Student(object):

    @property
    def birth(self):
        return self._birth

    @birth.setter
    def birth(self, value):
        self._birth = value

    @property
    def age(self):
        return 2015 - self._birth
s2 = Student()
s2.birth = 1999
s2.birth
1999
s2.age
16

面的birth是可读写属性,而age就是一个只读属性,因为age可以根据birth和当前时间计算出来。

小结

@property广泛应用在类的定义中,可以让调用者写出简短的代码,同时保证对参数进行必要的检查,这样,程序运行时就减少了出错的可能性。

练习

请利用@property给一个Screen对象加上width和height属性,以及一个只读属性resolution:

# -*- coding: utf-8 -*-
class Screen(object):
    @property
    def width(self):
        return self._width
    
    @width.setter
    def width(self, value):
        self._widht = value
        
    @property
    def height(self):
        return self._width
    
    @width.setter
    def height(self, value):
        self._height = value
    
    @property
    def resolution(self):
        return self._widht * self._height
# 测试:
s = Screen()
s.width = 1024
s.height = 768
print('resolution =', s.resolution)
if s.resolution == 786432:
    print('测试通过!')
else:
    print('测试失败!')
resolution = 786432
测试通过!