Python @property装饰器详解

最新推荐文章于 2024-05-08 09:00:00 发布
最新推荐文章于 2024-05-08 09:00:00 发布
阅读量1.8w 收藏 165
点赞数 43
文章标签： python 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yingxuanzhang/article/details/125071269
版权

之前的文章中，我们探究了@后接某个自定义函数的用法，实际上，更常见、完备、简单的应用在于对@和python内置的函数进行结合；这可以避免造轮子的行为。

我们知道， Python 内置了3种函数装饰器，分别是 ＠staticmethod、＠classmethod 和 @property，其中 staticmethod()、classmethod() 和 property() 都是 Python 的内置函数。而本文的目的，是以@property为例，对内置函数的装饰器应用进行探究，以明了其应用范围。

property函数字如其名，其在装饰器的主要应用在于，我们要实现

  1. 保护类的封装特性
  2. 让开发者可以使用“对象.属性”的方式操作操作类属性

的功能，除了使用 property() 函数，还可以使用 @property 装饰器。通过 @property 装饰器，可以直接通过方法名来访问方法，不需要在方法名后添加一对“（）”小括号。

简洁的说明@property

@property 的语法格式如下：

@property
def 方法名(self)
    代码块

例如，定义一个矩形类，并定义用 @property 修饰的方法操作类中的 area 私有属性，代码如下：

class Rect:
    def __init__(self,area):
        self.__area = area
    @property
    def area(self):
        return self.__area
rect = Rect(30)
#直接通过方法名来访问 area 方法
print("矩形的面积是：",rect.area)

运行结果为：

矩形的面积为： 30

上面程序中，使用 ＠property 修饰了 area() 方法，这样就使得该方法变成了 area 属性的 getter 方法。需要注意的是，如果类中只包含该方法，那么 area 属性将是一个只读属性。

也就是说，在使用 Rect 类时，无法对 area 属性重新赋值，即运行如下代码会报错：

rect.area = 90
print("修改后的面积：",rect.area)

运行结果为：

Traceback (most recent call last):
  File "C:\Users\mengma\Desktop\1.py", line 10, in <module>
    rect.area = 90
AttributeError: can't set attribute

而要想实现修改 area 属性的值，还需要为 area 属性添加 setter 方法，就需要用到 setter 装饰器，它的语法格式如下：

@方法名.setter
def 方法名(self, value):
    代码块

例如，为 Rect 类中的 area 方法添加 setter 方法，代码如下：

@area.setter
def area(self, value):
    self.__area = value

再次运行如下代码：

rect.area = 90
print("修改后的面积：",rect.area)

运行结果为：

修改后的面积: 90

这样，area 属性就有了 getter 和 setter 方法，该属性就变成了具有读写功能的属性。

除此之外，还可以使用 deleter 装饰器来删除指定属性，其语法格式为：

@方法名.deleter
def 方法名(self):
    代码块

例如，在 Rect 类中，给 area() 方法添加 deleter 方法，实现代码如下：

@area.deleter
def area(self):
    self.__area = 0

然后运行如下代码：

del rect.area
print("删除后的area值为：",rect.area)

运行结果为：

删除后的area值为： 0

详细的说明@property

以下对property的应用进行详细的描述。事实上，通过查看property函数的定义，可以发现其输入变量一共有四个属性：

class property(fget=None, fset=None, fdel=None, doc=None)

描述：

返回 property 属性。

参数说明：

fget —— 获取属性值的函数。
fset —— 设置属性值的函数。
fdel —— 删除属性值函数。
doc —— property 属性的文档字符串，如果没有给出 doc，则该 property 将拷贝 fget 的文档字符串（如果存在）。

返回值：

property 属性。

注意：

在 3.5 版更改：特征属性对象的文档字符串现在是可写的。

property() 函数是什么

property() 函数是用来创建一个托管属性，对类中定义的属性进行托管操作的。

property() 函数托管了什么

获取属性的值的方法、设置属性的值的方法、删除属性值的方法；

以上对应上述的property函数的代码定义

class property(fget=None, fset=None, fdel=None, doc=None)

实际上，property() 函数将类的某个属性的以上三个方法托管给了新创建的托管属性，在类外通过对托管属性的直接操作，从而实现类中指定属性的访问、设置、删除。

在类外使用托管属性和直接使用指定的属性的区别

当对属性的访问、设置、删除有过滤条件的时候，可以将过滤的条件放在类中的对应方法中，而在类外通过托管属性依旧可以以简洁的方式实现属性的访问、设置、删除。也可以通过托管属性对类中的多个属性同时实现访问、设置、删除。

示例：一个典型的用法

以下定义一个托管属性 x：

class C:
    def __init__(self):
        self._x = None
 
    def getx(self):          # 定义一个方法 getx() 用来访问 _x
        return self._x
 
    def setx(self, value):   # 定义一个方法 setx() 用来设置 _x
        self._x = value
 
    def delx(self):          # 定义一个方法 delx() 用来删除 _x
        del self._x
        print("完成 _x 或 x 的删除！")
 
    x = property(
    getx, 
    setx, 
    delx, 
    "doc：\nx 是一个托管属性"
    )  # 根据 property() 函数的特点创建一个托管属性 x
 
 
c = C()                # 创建一个实例对象 c
c.x = "testName"       # 实例调用托管属性 x，对 x 赋值就是调用 setx() 方法
print(c.x)             # 实例调用托管属性 x，打印 x 就是调用 getx() 方法
print(C.x.__doc__)     # 类调用托管属性 x，调用 __doc__ 打印 x 的文档字符串
del c.x                # 删除托管属性 x，就是调用 delx() 方法

输出结果为：

testName
doc：
x 是一个托管属性
完成 _x 或 x 的删除！

@property 装饰器讲解

首先我们定义一个 C 类，在类中定义一个实例属性 score。如果我们要访问或修改属性 score 时，可以直接在类外通过类的实例进行。如下：

class C:
    def __init__(self):
        self.score = 85          # 默认分数为 85
  
  
c = C()                          # 创建一个 C 类的实例 c
print(c.score)                   # 通过 C 类的实例对象 c，调用 score 属性来实现访问
c.score = 60                     # 通过 C 类的实例对象 c 直接修改属性 score
print(c.score)

运行结果：

85
60

我们发现普通的属性访问、修改、删除这样做是可以的，但是如果我们要在访问、修改、删除时增加过滤条件，那么这样操作显然是不行的。

我们还可以通过在类中定义的方法，在方法中添加过滤条件来实现属性的访问、修改、删除。在类外需要通过实例调用对应方法来实现，如下：

class C:
    def __init__(self):
        self.score = 85
  
    def get_score(self):                 # 定义一个方法 get_score() 用来获取分数
        if self.score < 60:
            return "你妹的，不及格！"
        else:
            return self.score
  
    def set_score(self, value):          # 定义一个方法 set_score() 用来输入分数
        if 0 <= value <= 100:
            self.score = value
        else:
            print(f"输入的值 {value} 超出范围 0~100 ！")
  
    def del_score(self):                 # 定义一个方法 del_score() 用来删除分数
        del self.score
        print("完成 score 属性的删除！")
  
  
c = C()
c.set_score(99)               # 通过实例对象调用 set_score() 方法来实现 score 属性的赋值或修改
print(c.get_score())          # 通过实例对象调用 get_score() 方法来实现 score 属性的访问
c.del_score()                 # 通过实例对象调用 del_score() 方法来实现 score 属性的删除

运行结果：

99
完成 score 属性的删除！

通过上节对 property() 了解，我们发现 property() 函数的参数 fget、fset、fdel 分别对应着 获取属性函数、设置属性函数 和 删除属性函数。如此以来我们就可以将 score 属性通过 property() 函数委托给 score_x，将 get_score()、set_score()、del_score() 方法分别传递给 fget、fset、fdel 参数。利用托管属性 score_x，我们可以以最简单的方式对属性实现有过滤条件访问、赋值、删除。如下：
 

class C:
    def __init__(self):
        self.score = 85
  
    def get_score(self):
        if self.score < 60:
            return "你妹的，不及格！"
        else:
            return self.score
  
    def set_score(self, value):
        if 0 <= value <= 100:
            self.score = value
        else:
            print(f"输入的值 {value} 超出范围 0~100 ！")
  
    def del_score(self):
        del self.score
        print("完成 score 属性的删除！")
  
    score_x = property(fget=get_score, fset=set_score, fdel=del_score, doc="score_x 是 score 的托管属性。")
  
  
c = C()
c.score_x = 45          # 直接使用实例对象调用 score_x 进行赋值，背后还是调用了方法实现了过滤
print(c.score_x)        # 获取 score_x 的值
del c.score_x           # 删除 score

运行结果：

你妹的，不及格！
完成 score 属性的删除

我们再来看看 property() 作为 装饰器 decorator 来使用，@property 装饰器是将被装饰的方法转化为一个同名的只读的特征属性，被装饰方法的文档字符串就是装饰后同名属性的文档字符串：

class C:
    def __init__(self):
        self.score = 85
  
    @property
    def score_x(self):
        """score_x 就相当于一个 score 的托管属性。"""
        return self.score

c = C()
print(c.score_x)                  # score_x() 方法被转换为属性后，该属性的值就是方法的返回值
print(C.score_x.__doc__)          # 查看该属性的字符串文档
c.score_x = 90                    # 对 score_x 属性的修改失败，因为它是个只读属性

运行结果：

85
score_x 就相当于一个 score 的托管属性。
Traceback (most recent call last):
  File "C:\Users\13160\Desktop\Python Exercise\011.py", line 14, in <module>
    c.score_x = 90
AttributeError: can't set attribute

我们发现这样使用 @property 装饰器装饰的方法，只是转变为了只读属性，不能修改也不能删除。这似乎好像与 property() 函数创建托管属性既可以访问又可以修改、删除有些不同。

我们要知道 @property 装饰器的本质是 property() 函数，所以被装饰的方法就相当于 property() 函数创建的托管属性。托管属性对象是具有相应的属性 fget，fset 和 fdel（访问、设置、删除），而被 @property 装饰器装饰的对象同样也具有对应的 getter，setter 以及 deleter 方法。所以要想被 @property 装饰器装饰的函数转换为属性后也可以实现设置、删除操作，可以做如下设置：

class C:
    def __init__(self):
        self.score = 85
  
    @property                           # @property 装饰器本身就相当于 getter 方法
    def score_x(self):
        if self.score < 60:
            return "你妹的，不及格！"
        else:
            return self.score
  
    @score_x.setter                     # 给 score_x 属性装饰 setter 方法
    def score_x(self, value):           # 附加方法与原始的特征属性相同的名称
        if 0 <= value <= 100:
            self.score = value
        else:
            print(f"输入的值 {value} 超出范围 0~100 ！")
  
    @score_x.deleter                    # 给 score_x 属性装饰 deleter 方法
    def score_x(self):                  # 附加方法与原始的特征属性相同的名称
        del self.score
  
  
c = C()
print(c.score_x)
c.score_x = 45
print(c.score_x)

运行结果：

85
你妹的，不及格！

通过上面 @property 装饰器的应用我们可以看出，它和直接使用 property() 函数创建委托属性其实没啥区别。

注意：

  1. @property 装饰的方法对应着 getter 方法，@score_x.setter 装饰的方法对应着 setter 方法，@score_x.deleter 装饰的方法对应着 deleter 方法；
  2. @property、@score_x.setter、@score_x.deleter 装饰的方法的方法名都要相同，这个方法名就相当于托管属性的名称
NickTheRock
关注
  • 43
    点赞
  • 踩
  • 165
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Python 中@property的用法详解
09-18
在Python编程语言中，`@property`装饰器是一种强大的工具，用于封装对象的属性，以实现数据验证、计算属性或隐藏内部实现细节等目的。它允许我们创建getter和setter方法，使得对对象属性的访问看起来像直接操作成员...
Python属性使用@property和不使用@property的差别
大大大大大碗面
12-01 2万+
首先看下属性的分类： 　　1：实例属性： 　　　　最好在__init__(self,...)中初始化 　　　　内部调用时都需要加上self. 　　　　外部调用时用instancename.propertyname 　　2:类属性： 　　　　在__init__()外初始化 　　　　在内部用classname.类属性名调用 　　　　外部既可以用classname.类属性名又可以用ins...
Python @property 装饰器讲解
小皇鱼-的-博客
05-23 4037
property() 函数 与 @property 装饰器讲解
Python中的property装饰器：深入解析与实用示例
最新发布
windowshht的博客
05-08 1628
通过使用getter、setter和deleter方法，我们可以在不破坏封装性的前提下，提供对类内部数据的访问和修改。其中，getter方法用于获取属性值，setter方法用于设置属性值，deleter方法用于删除属性，而doc则是一个可选的文档字符串。装饰器是一个内置的装饰器，用于在新式类中返回属性值。数据验证：在setter方法中，我们可以添加数据验证的逻辑，确保设置给属性的值符合我们的要求。通过这种方式，我们可以确保外部代码只能通过我们提供的接口来访问和修改私有变量的值，从而保持类的封装性和安全性。
【python】 @property属性详解
一个CV小白的博客
09-19 4239
python@property详解
@property 装饰器的作用和用法
weixin_44883789的博客
06-30 1762
在复现别人的代码时看到了在定义方法前一行有一个@property，对此感到很疑惑，于是上网查阅了它的用途,并做出总结。
@property的使用
有关心情
10-04 3万+
文章目录前言普通示例对属性赋值进行约束@property的使用@property原理 前言 手机QQ有一个根据条件查找陌生人的功能。我初中时挺爱玩儿的，也因此在好友列表里添加了不少女生，相隔十年，我不得不感谢当时做出英明决定的自己，因为现在浏览空间总能看到大量的美女自拍，爽歪歪…… ……咳咳！不扯了，进入正题。 普通示例 既然我们要查找符合条件的陌生人，那当然得先构建一个具有这样条件的人出来，再...
Python @property详解及底层实现介绍
weixin_42681866的博客
10-25 3万+
前文   python内置有三大装饰器：@staticmethod(静态方法)、@classmethod(类方法)、@property(描述符)，其中静态方法就是定义在类里的函数，并没有非要定义的必要；类方法则是在调用类属性、传递类对象时使用；而@property则是一个非常好用的语法糖。@property最大的好处就是在类中把一个方法变成属性调用，起到既能检查属性，还能用属性的方式来访问该属性的...
Python @property及getter setter原理详解
09-17
在Python编程语言中，`@property`装饰器和getter、setter方法是面向对象设计中的重要概念，它们允许我们控制类的属性访问，提供了一种优雅的方式来封装数据。下面将详细解释这些概念及其工作原理。 首先，`@...
python装饰器使用实例详解
09-18
4. **内置装饰器**：Python标准库提供了一些内置装饰器，如 `@staticmethod`、`@classmethod`、`@property` 等，它们用于修改类的行为。 5. **装饰器与元类（Metaclasses）**：虽然两者都能修改类的行为，但装饰器...
Python 从attribute到property详解
09-17
在Python中，可以通过`@property`装饰器将数据属性转换为属性，这样就可以添加getter方法来获取值，通过`@<property_name>.setter`装饰器添加setter方法来控制赋值。 例如，如果我们有一个`Person`类，其中包含一个...
CSS @property，让不可能变可能
BASK2311的博客
11-26 805
本文主要讲讲 CSS 非常新的一个特性，CSS @property，它的出现，极大的增强的 CSS 的能力！根据，@property CSS at-rule 是 CSS Houdini API 的一部分, 它允许开发者显式地定义他们的 CSS 自定义属性，允许进行属性类型检查、设定默认值以及定义该自定义属性是否可以被继承。又是什么呢，
CSS @property（CSS 自定义属性）
两个月亮
01-25 2656
@property CSS Houdini API 的一部分，它允许开发者显式地定义他们的 CSS 自定义属性, 允许进行属性类型检查、设定默认值以及定义该自定义属性是否可以被继承。接下来，我们将探索 CSS 变量与自定义属性的区别以及适合使用自定义属性的部分场景。
python中@property的介绍与使用
非晚非晚的博客
02-26 1740
python中的@property是python的一种装饰器，是用来修饰方法的，这种方式可以将方法转化为只读属性，并且可以使用属性的方式调用它。
@property自定义CSS属性，实现不一样的动画效果
梅花寺
12-19 928
property允许开发者显示的定义CSS属性，这些属性允许进行类型检查，以及设置默认值，定义之后的属性，可以直接在css中使用，也可以在JavaScript中使用。@property是一个非常有趣的新特性，它可以实现以前无法实现的动画过渡效果，它的使用也非常简单，只需要定义一个@property，然后在需要使用的地方使用就可以了。当然还有JS操控@property的方法，咱们先将这篇消化完成，后面再来看看JS操控@property的方法。
@property详细解读
njafei的博客
03-04 1225
@property 这个关键字、学过iOS的一定会经常用、但是如果你问一个人、@property是干嘛用的？ 可能就会有人一脸茫然地问你：”不就是声明属性用的么？” 。这话当然对、那么@property的背后的机制是什么？是如果声明属性？做了哪些事情呢？在讨论@property这个关键字之前、我们先说下iOS中、是如何声明变量的。iOS声明变量的方法在ARC下、生命变量有两种比较常用的方法：方法一：
对于Python中@property的理解和使用
热门推荐
张昆
09-02 6万+
重看狗书,看到对User表定义的时候有下面两行 @property def password(self): raise AttributeError('password is not a readable attribute') @password.setter def password(self, password): self.pass
Python 中 property() 函数及 @property 装饰器的使用
团子大圆帅的博客
11-13 3万+
Python 中 property() 函数及 @property 装饰器的使用 文章目录Python 中 property() 函数及 @property 装饰器的使用0. 参考资料1. property 应用场景 0. 参考资料 Python property() 函数 使用@property Python进阶-----property用法(实现了get，set，delete三种方法) ...
python @property
08-19
`@property` 是Python中的一个装饰器，可以用于将类的方法转变为属性。它使得我们能够通过访问属性的方式来调用方法，而不需要使用函数调用的方式。 下面是一个示例，演示了如何使用`@property`装饰器： ```python class Circle: def __init__(self, radius): self.radius = radius @property def area(self): return 3.14 * self.radius * self.radius circle = Circle(5) print(circle.area) # 输出: 78.5 ``` 在上面的示例中，`area`方法被`@property`装饰器修饰，使得它可以像属性一样被访问。当我们通过`circle.area`访问时，实际上会调用`area`方法并返回结果。 使用`@property`装饰器可以提供更简洁和直观的代码，同时提供了对类属性的更加灵活的访问方式。如果你有其他关于`@property`装饰器的问题，请随时提问！
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值