Python 内置的@property装饰器

1. 引言

Python 是一种简单而强大的面向对象的编程语言，拥有丰富的标准库和第三方库，可用于解决各种问题和开发各种应用程序。在 Python 中，我们可以使用装饰器来修改或扩展类的行为，使代码更加高效和可读性更强。

@property 装饰器是 Python 内置的一个特殊装饰器，用于将类的方法定义为属性访问。它提供了一种简洁的方式来定义类的属性，并且可以在访问属性时执行额外的操作。本文将详细介绍@property 装饰器的使用方法和效果。

2. @property 装饰器的基本用法

@property 装饰器是一个内置的装饰器，用于将方法定义为属性。通过将该装饰器应用到方法上，我们可以在访问属性时执行额外的代码逻辑。

下面是一个使用@property 装饰器的简单示例代码：

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

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

    @radius.setter
    def radius(self, value):
        if value >= 0:
            self._radius = value
        else:
            raise ValueError("Radius must be a non-negative number.")

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

    @diameter.setter
    def diameter(self, value):
        if value >= 0:
            self._radius = value / 2
        else:
            raise ValueError("Diameter must be a non-negative number.")

circle = Circle(5)
print(circle.radius)  # Output: 5
print(circle.diameter)  # Output: 10

circle.radius = 7
print(circle.radius)  # Output: 7
print(circle.diameter)  # Output: 14

circle.diameter = 8
print(circle.radius)  # Output: 4.0
print(circle.diameter)  # Output: 8

在上面的代码中，我们定义了一个名为 Circle 的类，它具有 radius 和 diameter 两个属性。通过使用 @property 装饰器，我们将两个方法定义为属性，从而可以像访问普通属性一样访问它们。

radius 方法使用 @property 装饰器进行修饰，这使得 radius 方法成为一个只读属性。在访问 radius 属性时，会执行方法内的逻辑，并返回 _radius 属性的值。
radius.setter 方法使用 @radius.setter 装饰器进行修饰，这使得 radius 方法成为一个可写属性。在设置 radius 属性时，会执行方法内的逻辑，并修改 _radius 属性的值。
diameter 方法与 radius 方法类似，只是对 _radius 属性做了不同的计算。

通过上述的代码运行结果可以看到，我们可以通过直接访问属性的方式来获取和设置属性的值。属性的访问和设置都会执行相应方法内的逻辑。

3. 各种属性的使用场景

@property 装饰器不仅可以用于简单的属性访问，还可以在属性访问时执行更复杂的逻辑。下面我们将介绍几种常见的属性使用场景。

3.1 属性计算

@property 装饰器可以用于对属性的计算，使得通过访问属性时能够返回计算后的结果。

class Rectangle:
    def __init__(self, width, height):
        self._width = width
        self._height = height

    @property
    def width(self):
        return self._width

    @width.setter
    def width(self, value):
        if value >= 0:
            self._width = value
        else:
            raise ValueError("Width must be a non-negative number.")

    @property
    def height(self):
        return self._height

    @height.setter
    def height(self, value):
        if value >= 0:
            self._height = value
        else:
            raise ValueError("Height must be a non-negative number.")

    @property
    def area(self):
        return self._width * self._height

    @property
    def perimeter(self):
        return 2 * (self._width + self._height)

rectangle = Rectangle(4, 5)
print(rectangle.width)  # Output: 4
print(rectangle.height)  # Output: 5
print(rectangle.area)  # Output: 20
print(rectangle.perimeter)  # Output: 18

rectangle.width = 6
rectangle.height = 8
print(rectangle.width)  # Output: 6
print(rectangle.height)  # Output: 8
print(rectangle.area)  # Output: 48
print(rectangle.perimeter)  # Output: 28

在上面的代码中，我们定义了一个名为 Rectangle 的类，它具有 width、height、area 和 perimeter 四个属性。面积和周长是通过 width 和 height 属性的计算得到的，通过使用 @property 装饰器，我们将这两个方法定义为属性。

通过上述的代码运行结果可以看到，我们可以直接通过访问属性的方式来获取计算后的结果。

3.2 只读属性

@property 装饰器还可以用于定义只读属性，即属性只能获取而无法设置。

class Student:
    def __init__(self, name, age):
        self._name = name
        self._age = age

    @property
    def name(self):
        return self._name

    @property
    def age(self):
        return self._age

student = Student('Alice', 18)
print(student.name)  # Output: Alice
print(student.age)  # Output: 18

student.name = 'Bob'  # Error: AttributeError: can't set attribute
student.age = 20  # Error: AttributeError: can't set attribute

在上面的代码中，我们定义了一个名为 Student 的类，它具有 name 和 age 两个只读属性。通过使用 @property 装饰器，我们将这两个方法定义为只读属性，使其只能获取而无法设置。

通过上述的代码运行结果可以看到，我们尝试设置只读属性时会抛出 AttributeError。

3.3 属性删除

@property 装饰器还可以用于定义删除属性时的操作。通过使用 @property 装饰器，我们可以在属性被删除时执行额外的逻辑。

class Person:
    def __init__(self, name):
        self._name = name

    @property
    def name(self):
        return self._name

    @name.deleter
    def name(self):
        del self._name

person = Person('Alice')
print(person.name)  # Output: Alice

del person.name
print(person.name)  # Output: AttributeError: 'Person' object has no attribute '_name'

在上面的代码中，我们定义了一个名为 Person 的类，它具有一个 name 属性。通过使用 @property 装饰器，我们将 name 方法定义为一个只读属性。并且通过 @name.deleter 装饰器，我们定义了在属性被删除时执行的操作。

通过上述的代码运行结果可以看到，当我们尝试删除属性时会执行相应的操作。