编程语言
首页 > 编程语言> > Python @property装饰器详解

Python @property装饰器详解

作者:互联网

 

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

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

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

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

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

简洁的说明@property

@property 的语法格式如下:

  1.   @property
  2.   def 方法名(self)
  3.   代码块

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

  1.   class Rect:
  2.   def __init__(self,area):
  3.   self.__area = area
  4.   @property
  5.   def area(self):
  6.   return self.__area
  7.   rect = Rect(30)
  8.   #直接通过方法名来访问 area 方法
  9.   print("矩形的面积是:",rect.area)

运行结果为:

矩形的面积为: 30
 

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

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

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

运行结果为:

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

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

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

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

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

再次运行如下代码:

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

运行结果为:

修改后的面积: 90
 

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

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

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

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

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

然后运行如下代码:

  1.   del rect.area
  2.   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:

  1.   class C:
  2.   def __init__(self):
  3.   self._x = None
  4.    
  5.   def getx(self): # 定义一个方法 getx() 用来访问 _x
  6.   return self._x
  7.    
  8.   def setx(self, value): # 定义一个方法 setx() 用来设置 _x
  9.   self._x = value
  10.    
  11.   def delx(self): # 定义一个方法 delx() 用来删除 _x
  12.   del self._x
  13.   print("完成 _x 或 x 的删除!")
  14.    
  15.   x = property(
  16.   getx,
  17.   setx,
  18.   delx,
  19.   "doc:\nx 是一个托管属性"
  20.   ) # 根据 property() 函数的特点创建一个托管属性 x
  21.    
  22.    
  23.   c = C() # 创建一个实例对象 c
  24.   c.x = "testName" # 实例调用托管属性 x,对 x 赋值就是调用 setx() 方法
  25.   print(c.x) # 实例调用托管属性 x,打印 x 就是调用 getx() 方法
  26.   print(C.x.__doc__) # 类调用托管属性 x,调用 __doc__ 打印 x 的文档字符串
  27.   del c.x # 删除托管属性 x,就是调用 delx() 方法

输出结果为:

  1.   testName
  2.   doc:
  3.   x 是一个托管属性
  4.   完成 _x 或 x 的删除!

@property 装饰器讲解

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

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

运行结果:

  1.   85
  2.   60

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

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

  1.   class C:
  2.   def __init__(self):
  3.   self.score = 85
  4.    
  5.   def get_score(self): # 定义一个方法 get_score() 用来获取分数
  6.   if self.score < 60:
  7.   return "你妹的,不及格!"
  8.   else:
  9.   return self.score
  10.    
  11.   def set_score(self, value): # 定义一个方法 set_score() 用来输入分数
  12.   if 0 <= value <= 100:
  13.   self.score = value
  14.   else:
  15.   print(f"输入的值 {value} 超出范围 0~100 !")
  16.    
  17.   def del_score(self): # 定义一个方法 del_score() 用来删除分数
  18.   del self.score
  19.   print("完成 score 属性的删除!")
  20.    
  21.    
  22.   c = C()
  23.   c.set_score(99) # 通过实例对象调用 set_score() 方法来实现 score 属性的赋值或修改
  24.   print(c.get_score()) # 通过实例对象调用 get_score() 方法来实现 score 属性的访问
  25.   c.del_score() # 通过实例对象调用 del_score() 方法来实现 score 属性的删除

运行结果:

  1.   99
  2.   完成 score 属性的删除!

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

  1.   class C:
  2.   def __init__(self):
  3.   self.score = 85
  4.    
  5.   def get_score(self):
  6.   if self.score < 60:
  7.   return "你妹的,不及格!"
  8.   else:
  9.   return self.score
  10.    
  11.   def set_score(self, value):
  12.   if 0 <= value <= 100:
  13.   self.score = value
  14.   else:
  15.   print(f"输入的值 {value} 超出范围 0~100 !")
  16.    
  17.   def del_score(self):
  18.   del self.score
  19.   print("完成 score 属性的删除!")
  20.    
  21.   score_x = property(fget=get_score, fset=set_score, fdel=del_score, doc="score_x 是 score 的托管属性。")
  22.    
  23.    
  24.   c = C()
  25.   c.score_x = 45 # 直接使用实例对象调用 score_x 进行赋值,背后还是调用了方法实现了过滤
  26.   print(c.score_x) # 获取 score_x 的值
  27.   del c.score_x # 删除 score

运行结果:

  1.   你妹的,不及格!
  2.   完成 score 属性的删除

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

  1.   class C:
  2.   def __init__(self):
  3.   self.score = 85
  4.    
  5.   @property
  6.   def score_x(self):
  7.   """score_x 就相当于一个 score 的托管属性。"""
  8.   return self.score
  9.    
  10.   c = C()
  11.   print(c.score_x) # score_x() 方法被转换为属性后,该属性的值就是方法的返回值
  12.   print(C.score_x.__doc__) # 查看该属性的字符串文档
  13.   c.score_x = 90 # 对 score_x 属性的修改失败,因为它是个只读属性

运行结果:

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

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

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

  1.   class C:
  2.   def __init__(self):
  3.   self.score = 85
  4.    
  5.   @property # @property 装饰器本身就相当于 getter 方法
  6.   def score_x(self):
  7.   if self.score < 60:
  8.   return "你妹的,不及格!"
  9.   else:
  10.   return self.score
  11.    
  12.   @score_x.setter # 给 score_x 属性装饰 setter 方法
  13.   def score_x(self, value): # 附加方法与原始的特征属性相同的名称
  14.   if 0 <= value <= 100:
  15.   self.score = value
  16.   else:
  17.   print(f"输入的值 {value} 超出范围 0~100 !")
  18.    
  19.   @score_x.deleter # 给 score_x 属性装饰 deleter 方法
  20.   def score_x(self): # 附加方法与原始的特征属性相同的名称
  21.   del self.score
  22.    
  23.    
  24.   c = C()
  25.   print(c.score_x)
  26.   c.score_x = 45
  27.   print(c.score_x)

运行结果:

  1.   85
  2.   你妹的,不及格!

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

注意:

  1. @property 装饰的方法对应着 getter 方法,@score_x.setter 装饰的方法对应着 setter 方法,@score_x.deleter 装饰的方法对应着 deleter 方法;
  2. @property、@score_x.setter、@score_x.deleter 装饰的方法的方法名都要相同,这个方法名就相当于托管属性的名称
 

标签:area,Python,self,score,property,方法,详解,属性
来源: https://www.cnblogs.com/jira/p/16574364.html