【python】@property

在Python中，@property 是一个内置的装饰器，它允许你将一个类的方法转换为相同名称的只读属性。这意味着，你可以像访问数据属性一样访问这些方法，但它们实际上会执行方法中的代码。@property 装饰器提供了一种将类的方法与属性访问结合起来的方式，从而可以在不改变代码外部接口的情况下，对属性的访问进行封装和控制。

在Python中，@property 修饰的函数（即getter方法）本身是不接受额外参数的，除了隐含的 self 参数，它代表类的实例。@property 的设计初衷是为了让方法的调用看起来像是对属性的直接访问，因此它不支持在访问属性时传递额外的参数。

使用 @property 的好处

1. 简化接口：你可以通过属性访问的方式调用方法，而不需要显式地调用方法。
2. 封装：你可以在属性的getter方法中隐藏复杂的计算或逻辑，而外部代码只需要简单地访问属性。
3. 安全性：你可以通过getter和setter方法来控制对属性的访问和修改，从而防止外部代码直接修改类的内部状态。
4. 文档化：使用@property装饰器可以为属性提供文档字符串，这有助于代码的可读性和维护性。

@property 的基本用法

假设你有一个类，它有一个私有属性_age，你希望外部代码能够通过一个只读属性age来访问这个私有属性的值，但不能直接修改它。你可以这样做：

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

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

 

现在，你可以像这样访问age属性：

p = Person(30)
print(p.age)  # 输出: 30

 

注意，尝试直接设置p.age将会引发AttributeError，因为age属性是只读的。

添加 setter 方法

如果你希望允许外部代码修改属性的值，你可以提供一个setter方法。setter方法是通过在@property装饰器下方定义一个同名的方法，并在其上方添加@age.setter装饰器来实现的。

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

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

    @age.setter
    def age(self, value):
        if value < 0:
            raise ValueError("Age must be non-negative")
        self._age = value

 

现在，你可以像这样设置age属性：

p = Person(30)
p.age = 25
print(p.age)  # 输出: 25

# 尝试设置一个非法的值将引发异常
try:
    p.age = -5
except ValueError as e:
    print(e)  # 输出: Age must be non-negative

 

 

总结

@property 装饰器是Python中一个非常有用的特性，它允许你以属性的方式访问类的方法，同时保留了方法的封装性和灵活性。通过使用@property和它的setter方法，你可以更好地控制对类属性的访问和修改，从而提高代码的安全性和可维护性。