Python @property 装饰器的使用

@property 装饰器

@property 语法糖提供了比 property() 函数更简洁直观的写法。

• 被 @property 装饰的方法是获取属性值的方法，被装饰方法的名字会被用做 属性名。
• 被 @属性名.setter 装饰的方法是设置属性值的方法。
• 被 @属性名.deleter 装饰的方法是删除属性值的方法

以下示例代码与使用 property() 函数版本的代码等价：

class Student:
    def __init__(self):
        self._age = None

    @property
    def age(self):
        print('获取属性时执行的代码')
        return self._age

    @age.setter
    def age(self, age):
        print('设置属性时执行的代码')
        self._age = age

    @age.deleter
    def age(self):
        print('删除属性时执行的代码')
        del self._age


student = Student()

# 设置属性
student.age = 18
"""
设置属性时执行的代码
"""

# 获取属性
print('学生年龄为：' + str(student.age))
"""
获取属性时执行的代码
学生年龄为：18
"""

# 删除属性
del student.age
"""
删除属性时执行的代码
"""

注意事项

• 可以省略设置属性值的方法，此时该属性变成只读属性。如果此时仍然设置属性，会抛出异常 AttributeError: can't set attribute。
• 如果报错 RecursionError: maximum recursion depth exceeded while calling a Python object，很可能是对象属性名和 @property 装饰的方法名重名了，一般会在对象属性名前加一个下划线 _ 避免重名，并且表明这是一个受保护的属性。