Python property

Python 的 property 是一个内置的装饰器，用于简化属性的访问和管理。通过 property，您可以为对象的属性创建 getter 和 setter 方法，从而在访问和修改属性时添加额外的逻辑。这种方式能够保护属性的设定和获取，使代码更具可读性和可维护性。

什么是 property

property 使您能够控制属性的访问。类似于在其他编程语言中常见的访问器（getter）和设置器（setter），property 允许您在类中定义这些方法，使得代码的使用方式更简洁。

定义和使用 property

您可以使用 property 装饰器来创建一个属性，下面是一个简单的示例。

class Person:
    def __init__(self, name):
        self._name = name  # 私有属性，使用下划线前缀
    
    @property
    def name(self):
        """获取名字"""
        return self._name
    
    @name.setter
    def name(self, value):
        """设置名字"""
        if not value:
            raise ValueError("名字不能为空")
        self._name = value

# 使用示例
person = Person("Alice")
print(person.name)  # 获取名字，输出: Alice

person.name = "Bob"  # 设置名字
print(person.name)  # 输出: Bob

# person.name = ""  # 这会引发 ValueError: 名字不能为空

下面是一个更复杂的示例，展示了如何使用 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:
            raise ValueError("半径不能为负数")
        self._radius = value

    @property
    def area(self):
        """计算圆的面积"""
        import math
        return math.pi * (self._radius ** 2)

# 使用示例
circle = Circle(5)
print(circle.radius)  # 输出: 5
print(circle.area)  # 输出: 78.53981633974483

circle.radius = 10  # 修改半径
print(circle.area)  # 输出: 314.1592653589793

# circle.radius = -3  # 这将引发 ValueError: 半径不能为负数

使用property与传统不使用对比

假设我们有一个表示矩形的类 Rectangle，它有 width 和 height 属性。我们希望能够获取和设置这些属性，同时确保在设置时它们不能为负值。我们将展示在不使用 property 时如何编写代码，然后展示使用 property 的方法。

1. 不使用 property

在不使用 property 的情况下，我们可能会直接使用属性的 getter 和 setter 方法，并手动调用这些方法来进行属性的更新和检索：

class Rectangle:
    def __init__(self, width, height):
        self.set_width(width)
        self.set_height(height)
    
    def set_width(self, width):
        if width < 0:
            raise ValueError("宽度不能为负数")
        self._width = width

    def get_width(self):
        return self._width

    def set_height(self, height):
        if height < 0:
            raise ValueError("高度不能为负数")
        self._height = height

    def get_height(self):
        return self._height

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


# 使用方式
rect = Rectangle(5, 10)
print(rect.get_width())  # 输出: 5
print(rect.get_height())  # 输出: 10
print(rect.area())  # 输出: 50

rect.set_width(20)  # 调用 setter
print(rect.get_width())  # 输出: 20

# rect.set_width(-5)  # 这会引发 ValueError

在这种实现方式中，我们需要：

始终使用 set_width() 和 set_height() 方法来设置属性，不能直接赋值。
使用 get_width() 和 get_height() 方法来获取属性，也不能直接访问它们。

2. 使用 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:
            raise ValueError("宽度不能为负数")
        self._width = value

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

    @height.setter
    def height(self, value):
        if value < 0:
            raise ValueError("高度不能为负数")
        self._height = value

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


# 使用方式
rect = Rectangle(5, 10)
print(rect.width)  # 输出: 5
print(rect.height)  # 输出: 10
print(rect.area())  # 输出: 50

rect.width = 20  # 直接赋值
print(rect.width)  # 输出: 20

# rect.width = -5  # 这会引发 ValueError

在使用 property 时，我们可以：