Python @property

本文介绍如何使用Python的@property装饰器实现对类属性的有效性和访问控制,通过实例演示如何避免直接修改属性带来的问题。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

考察 Student 类:

class Student(object):
    def __init__(self, name, score):
        self.name = name
        self.score = score

当我们想要修改一个 Student 的 scroe 属性时,可以这么写:

s = Student('Bob', 59)
s.score = 60
但是也可以这么写:

s.score = 1000

显然,直接给属性赋值无法检查分数的有效性。

如果利用两个方法:

class Student(object):
    def __init__(self, name, score):
        self.name = name
        self.__score = score
    def get_score(self):
        return self.__score
    def set_score(self, score):
        if score < 0 or score > 100:
            raise ValueError('invalid score')
        self.__score = score

这样一来,s.set_score(1000) 就会报错。

这种使用 get/set 方法来封装对一个属性的访问在许多面向对象编程的语言中都很常见。

但是写 s.get_score() 和 s.set_score() 没有直接写 s.score 来得直接。

有没有两全其美的方法?----有。

因为Python支持高阶函数,在函数式编程中我们介绍了装饰器函数,可以用装饰器函数把 get/set 方法“装饰”成属性调用:

class Student(object):
    def __init__(self, name, score):
        self.name = name
        self.__score = score
    @property
    def score(self):
        return self.__score
    @score.setter
    def score(self, score):
        if score < 0 or score > 100:
            raise ValueError('invalid score')
        self.__score = score

注意: 第一个score(self)是get方法,用@property装饰,第二个score(self, score)是set方法,用@score.setter装饰,@score.setter是前一个@property装饰后的副产品。

现在,就可以像使用属性一样设置score了:

>>> s = Student('Bob', 59)
>>> s.score = 60
>>> print s.score
60
>>> s.score = 1000
Traceback (most recent call last):
  ...
ValueError: invalid score

说明对 score 赋值实际调用的是 set方法

### Python中`@property`装饰器的用法和实现方式 #### 1. `@property`装饰器的基本概念 `@property`装饰器用于将类中的方法转换为只读属性[^1]。通过这种方式,可以像访问普通属性一样调用方法,而无需显式地使用括号。 #### 2. 使用`@property`创建只读属性 以下是一个示例,展示如何使用`@property`装饰器创建只读属性: ```python class Human(object): def __init__(self, value): self._age = value @property def age(self): return self._age if __name__ == '__main__': peter = Human(18) print("The age of Peter is {}".format(peter.age)) # 输出:The age of Peter is 18 # peter.age = 20 # 如果尝试修改age属性,将会抛出 AttributeError ``` 在此示例中,`age`方法被`@property`装饰器修饰后,可以通过`peter.age`的方式访问,而无需使用`peter.age()`的形式[^1]。 #### 3. 使用`@property`实现可写属性 除了创建只读属性外,`@property`还可以与`@<attribute>.setter`结合使用,以实现可写属性。以下是一个示例: ```python class Human(object): def __init__(self, value): self._age = value @property def age(self): return self._age @age.setter def age(self, value): if value < 0: raise ValueError("Age cannot be negative") self._age = value if __name__ == '__main__': peter = Human(18) print("The age of Peter is {}".format(peter.age)) # 输出:The age of Peter is 18 peter.age = 25 # 修改年龄 print("The new age of Peter is {}".format(peter.age)) # 输出:The new age of Peter is 25 # peter.age = -5 # 尝试设置负值将抛出 ValueError ``` 在此示例中,`@age.setter`定义了`age`属性的设置逻辑,确保只能设置非负值[^1]。 #### 4. 使用`@property`实现删除属性功能 通过`@<attribute>.deleter`,可以定义删除属性时的行为。以下是一个示例: ```python class Human(object): def __init__(self, value): self._age = value @property def age(self): return self._age @age.setter def age(self, value): if value < 0: raise ValueError("Age cannot be negative") self._age = value @age.deleter def age(self): del self._age if __name__ == '__main__': peter = Human(18) print("The age of Peter is {}".format(peter.age)) # 输出:The age of Peter is 18 del peter.age # 删除 age 属性 # print(peter.age) # 尝试访问已删除的属性将抛出 AttributeError ``` 在此示例中,`@age.deleter`定义了删除`age`属性时的行为[^1]。 #### 5. `@property`装饰器的实现原理 `@property`装饰器本质上是一个描述符(descriptor),它通过重载`__get__`、`__set__`和`__delete__`方法来实现对属性的访问控制。当一个方法被`@property`装饰时,它会被替换为一个`property`对象,该对象管理对底层私有属性的访问[^1]。 以下是一个简单的`property`实现示例: ```python class Property: def __init__(self, fget=None, fset=None, fdel=None): self.fget = fget self.fset = fset self.fdel = fdel def __get__(self, instance, owner): if instance is None: return self if self.fget is None: raise AttributeError("unreadable attribute") return self.fget(instance) def __set__(self, instance, value): if self.fset is None: raise AttributeError("can't set attribute") self.fset(instance, value) def __delete__(self, instance): if self.fdel is None: raise AttributeError("can't delete attribute") self.fdel(instance) ``` 在这个实现中,`Property`类通过`__get__`、`__set__`和`__delete__`方法分别实现了对属性的获取、设置和删除操作[^1]。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值