Python @property|极客教程

Python @property

在 Python 中，@property 装饰器可以将一个方法转化为属性，从而让我们可以像访问属性一样去访问方法。这种装饰器可以将一个方法绑定到一个类的实例的属性上，让该方法可以像属性一样被访问，而不用通过方法调用。

为什么要使用 @property

在 Python 中，有时候我们希望将一个方法当做属性来访问，这时候就可以使用 @property 装饰器。通过将方法转化为属性，我们可以更加简洁、优雅地访问类的内部数据，同时也可以在需要的时候进行额外的处理或者逻辑。

举个示例，假设我们有一个 Person 类，我们希望能够直接通过 person.age 来获取这个人的年龄，并且在设置年龄的时候进行一些额外的逻辑处理，这时就可以使用 @property 装饰器。

class Person:
    def __init__(self, age):
        self._age = age

    @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 > 150:
            raise ValueError("Age must be between 0 and 150.")
        self._age = value

# 创建一个 Person 实例
person = Person(25)

# 获取年龄
print(person.age)  # 输出 25

# 设置年龄
person.age = 30
print(person.age)  # 输出 30

# 尝试设置非整数年龄
person.age = "thirty"  # 报错：ValueError: Age must be an integer.

@property 的使用

@property 装饰器将方法转化为只读属性，即只能进行获取值，不能设置值。
可以配合 @<property_name>.setter 装饰器一起使用，用于设置属性的值。
可以配合 @<property_name>.deleter 装饰器一起使用，用于删除属性。

class Circle:
    def __init__(self, radius):
        self._radius = radius

    @property
    def radius(self):
        return self._radius

    @property
    def diameter(self):
        return self._radius * 2

    @property
    def area(self):
        return 3.14 * self._radius ** 2

    @radius.setter
    def radius(self, value):
        if value < 0:
            raise ValueError("Radius cannot be negative.")
        self._radius = value

    @radius.deleter
    def radius(self):
        del self._radius

# 创建一个 Circle 实例
circle = Circle(5)

# 获取半径、直径和面积
print(circle.radius)   # 输出 5
print(circle.diameter) # 输出 10
print(circle.area)     # 输出 78.5

# 设置半径
circle.radius = 7
print(circle.radius)   # 输出 7

# 尝试设置负半径
circle.radius = -2  # 报错：ValueError: Radius cannot be negative.