Python中@property和@*.setter装饰器的详细用法

Python

2023-02-22 13:36:42

有这么个场景：

class result:
    def __init__(self):
        self.data = [11,33,44,55,66]

exam_result = result()
exam_result.data = 1

exam_result.data 可以被随意修改，可我只希望它是一个只读属性，应该怎么做呢？

@property

@property装饰器的作用是，将一个函数装饰成为类的一个属性，当某个属性需要动态的计算时，用@property来装饰函数最好不过了；

了解@函数修饰符的人应该知道property实际上是一个函数。

使用方法：

class result:
    def __init__(self):
        self.__data = [11,33,44,55,66]

    @property
    def data(self):
        return self.__data

这时候再对 exam_result.data进行赋值，就会发生AttributeError: can’t set attribute的错误！

这时候data不仅是一个方法，还是类的一个属性，所以我们可以利用这个特性动态的计算某些结果：

    @property
    def total(self):
        total_ = 0
        for value in self.__data:
            total_ += value
        return total_

为result类添加一个新的值total用于计算总分数。

修改代码，实现一个新的功能，获取分数及格的总数；

        self.__pass_score = 60

添加一个 __pass_score的属性，用于记录及格分数线，暂且初始化为60；

    @property
    def passCount(self):
        count = 0
        for value in self.__data:
            if value >= self.__pass_score:
                count+=1
        return count

添加一个passCount函数，用于获取及格的数量。使用@property修饰。

现在我希望能够设置及格分数线，并要保证其值合法；

@*.setter

@*.setter 允许你对已用@property装饰的函数赋值：

    @passScore.setter
    def passScore(self,value):
        if not 0 < value < 100:
            raise ValueError('必须为1~99的数')
        self.__pass_score=value

需要注意，setter装饰器必须在property的后面，且两个被修饰的属性（函数）名称必须保持一致。

因为属性实际是通过函数执行获得，所以我们可以对值进行判断或实现更为复杂的操作。

完整代码：

class result:
    def __init__(self):
        self.__data = [11,33,44,55,66]
        self.__pass_score = 60
    @property
    def data(self):
        return self.__data
    
    @property
    def total(self):
        total_ = 0
        for value in self.__data:
            total_ += value
        return total_
    @property
    def passCount(self):
        count = 0
        for value in self.__data:
            if value >= self.__pass_score:
                count+=1
        return count
    @property
    def passScore(self):
        return self.__pass_score
    @passScore.setter
    def passScore(self,value):
        if not 0 < value < 100:
            raise ValueError('必须为1~99的数')
        self.__pass_score=value