python内置装饰器@property

前言

今天来说一下@property装饰器，这是个python内置的装饰器，主要是作用是把类中的一个方法变为类中的一个属性，并且使定义属性和修改现有属性变的更容易

我们可以看一下@property源码中给的实例和解释

 1 Decorators make defining new properties or modifying existing ones easy:
 2
 3
 4 class C(object):
 5     @property
 6     def x(self):
 7         "I am the ‘x‘ property."
 8         return self._x
 9
10     @x.setter
11     def x(self, value):
12         self._x = value
13
14     @x.deleter
15     def x(self):
16         del self._x

没错，龟叔给的解释就是这个装饰器会把定义新属性和对现有的属性的修改变的更简单，那么传统的方法在绑定属性和访问属性时是什么样的呢？

实例

 1 """
 2 ------------------------------------
 3 @Time : 2019/7/4 20:57
 4 @Auth : linux超
 5 @File : python_property.py
 6 @IDE  : PyCharm
 7 @Motto: Real warriors,dare to face the bleak warning,dare to face the incisive error!
 8 @QQ   : [email protected]
 9 @GROUP: 878565760
10 ------------------------------------
11 """
12
13
14 class UserInfo(object):
15
16     def get_name(self):
17         """通过类的方法访问类中的属性"""
18         return self.__name
19
20     def set_name(self, name):
21         """通过外部传参的方式绑定属性"""
22         self.__name = name
23
24
25 if __name__ == ‘__main__‘:
26     user = UserInfo()
27     # 绑定name属性
28     user.set_name(["超哥", "linux超"])
29     print("我的名字是：", user.get_name())

执行结果

我的名字是： [’超哥’, ‘linux超’]

Process finished with exit code 0

这种方式在绑定属性，获取属性时显的很是繁琐，而且无法保证数据的准确性，从执行结果看来，名字应该是个字符串才对，然而输出结果却是个列表，这并不符合实际规则

而且也没有通过直接访问属性，修改属性的方式那么直观

我们对代码稍作改动，并使用@property装饰器来实现

 1 """
 2 ------------------------------------
 3 @Time : 2019/7/4 22:02
 4 @Auth : linux超
 5 @File : python_class.py
 6 @IDE  : PyCharm
 7 @Motto: Real warriors,dare to face the bleak warning,dare to face the incisive error!
 8 @QQ   : [email protected]
 9 @GROUP: 878565760
10 ------------------------------------
11 """
12
13
14 class UserInfo(object):
15     @property
16     def name(self):
17         return self.__name
18
19     @name.setter
20     def name(self, name):
21         if isinstance(name, str):
22             self.__name = name
23         else:
24             raise TypeError("The name must be str")
25
26
27 if __name__ == ‘__main__‘:
28     user = UserInfo()
29     # 绑定属性
30     user.name = "linux超"
31     print("我的名字是", user.name)
32     user.name = ["linux超", "超哥"]
33     print("我的名字是", user.name)

执行结果

我的名字是 linux超
Traceback (most recent call last):
  File "D:/LingMengPython16/LingMengPython16/cnblogs/python_class.py", line 32, in <module>
    user.name = ["linux超", "超哥"]
  File "D:/LingMengPython16/LingMengPython16/cnblogs/python_class.py", line 24, in name
    raise TypeError("The name must be str")
TypeError: The name must be str

Process finished with exit code 1

经过优化后的代码我们可以看到当绑定的属性并非是一个字符串类型时，就会报错，而且我们可以直接通过类似访问属性的方式来绑定属性，访问属性，这样就更加直观了

这里有个点需要注意，@name.setter中name这个名字极其被他修饰的方法名字与@property修改的方法名必须保持一致，否则会报错

其中@name.setter装饰器是因为使用了@property后他本身创建的装饰器

其实呢，我觉得@perproty装饰器并不仅仅只用来绑定属性和访问属性，还可以用来在类的外部访问私有成员属性

先来看个类的外部直接访问私有成员的实例

 1 """
 2 ------------------------------------
 3 @Time : 2019/7/4 20:57
 4 @Auth : linux超
 5 @File : python_property.py
 6 @IDE  : PyCharm
 7 @Motto: Real warriors,dare to face the bleak warning,dare to face the incisive error!
 8 @QQ   : [email protected]
 9 @GROUP: 878565760
10 ------------------------------------
11 """
12
13
14 class UserInfo(object):
15
16     def __init__(self, name, age):
17         self.__name = name
18         self.__age = age
19
20 if __name__ == ‘__main__‘:
21     user = UserInfo(‘linux超‘, 18)
22     print(user.__name)

执行结果

Traceback (most recent call last):
  File "D:/LingMengPython16/LingMengPython16/cnblogs/python_property.py", line 22, in <module>
    print(user.__name)
AttributeError: ‘UserInfo‘ object has no attribute ‘__name‘

Process finished with exit code 1

没错，程序是没办法运行成功的，因为python不允许你在类的外部访问类中的私有成员，这么做其实是为了保护数据的安全性

那么这时候我们也可以使用@property装饰器来访问类的属性

 1 """
 2 ------------------------------------
 3 @Time : 2019/7/4 20:57
 4 @Auth : linux超
 5 @File : python_property.py
 6 @IDE  : PyCharm
 7 @Motto: Real warriors,dare to face the bleak warning,dare to face the incisive error!
 8 @QQ   : [email protected]
 9 @GROUP: 878565760
10 ------------------------------------
11 """
12
13
14 class UserInfo(object):
15
16     def __init__(self, name):
17         self.__name = name
18
19     @property
20     def name(self):
21         """通过类的方法访问类中的私有属性"""
22         return self.__name
23
24 if __name__ == ‘__main__‘:
25     user = UserInfo(‘linux超‘)
26     print("获取name属性：", user.name)

执行结果

获取name属性： linux超

Process finished with exit code 0

这样就能访问类的私有成员属性了

那么其实我个人认为，相对于绑定属性来说这种方式用的比较多，当你不想子类继承父类时，防止子类修改父类的属性，那么你完全就可以使用这种方法来避免属性被修改，而且在子类和类的外部还可以正常访问这个私有属性

总结

@property装饰器主要用来改变一个方法为一个属性，且需要注意几点

1. 被此装饰器装饰的方法不能传递任何除self外的其他参数

2.当同时使用@property和@x.setter时需要保证x以及被@x.setter修改的方法名字与@property修改的方法名字必须保持一致

原文地址：https://www.cnblogs.com/linuxchao/p/linuxchao-property.html

时间： 2024-08-02 23:37:33

python内置装饰器@property的相关文章

Python 内置装饰器

1 def deco(func): 2 def _deco(): 3 print("Before") 4 func() 5 print("End") 6 #return func 这里不需要返回 7 return _deco#这里不是_deco() 8 9 @deco 10 def myfunc(): 11 print("Clled") 12 13 myfunc() 带参数的 def deco(func): def _deco(a,b): pri

property内置装饰器函数和@name.setter、@name.deleter

# property # 内置装饰器函数只在面向对象中使用 # 装饰后效果:将类的方法伪装成属性 # 被property装饰后的方法,不能带除了self外的任何参数 from math import pi class Circle: def __init__(self, r): self.r = r def perimeter(self): return 2 * pi * self.r def area(self): return pi * self.r**2 * pi c1 = Circle

python之内置装饰器（property/staticmethod/classmethod）

python内置了property.staticmethod.classmethod三个装饰器,有时候我们也会用到,这里简单说明下 1.property 作用:顾名思义把函数装饰成属性一般我们调用类方法成员,都是如下写法: class propertyTest(): def __init__(self,x,y): self.x = x self.y = y def square(self): return self.x * self.y pt = propertyTest(3,5) print

python基础--定义装饰器(内置装饰器)

装饰器的定义: 装饰器本质上就是一个python函数,它可以让其它函数在不需要做任何代码改动的前提下增加额外的功能,装饰器的返回值也是一个函数对象.它经常用于有切面需求的场景中,比如-- >插入日志.性能测试.事务处理.缓存.权限校验等场景.装饰器是解决这类问题的绝佳设计,有了装饰器,我们就可以抽离出大量与函数功能本身无关的雷同的代码并且可以重复使用. 装饰器的作用: 就是为已经存在的函数或者对象添加额外的功能装饰器的写法: (无参装饰器) def wrapper(func): def inn

python 之用装饰器@property，把方法变成一个特性

# -*- coding: utf-8 -*- """ Created on Sun Nov 13 23:19:03 2016 @author: toby """ #知识点:用装饰器@property,把方法变成一个特性 class Province: memo = 'One of China\'s 23 provinces' #静态字段 def __init__(self,name,capital,leadership

十、PYTHON 学习之装饰器加深理解

在第六章已经有所介绍,这里看到一篇比较好的文章转过来. 基本概念装饰器是23z种设计模式之一,经常被用于有切面需求的场景,较为经典的有插入日志.性能测试.事务处理, Web权限校验, Cache等. 很有名的例子来理解,咖啡,加糖的咖啡,加牛奶的咖啡. 本质上,还是咖啡,只是在原有的东西上,做了"装饰",使之附加一些功能或特性. 例如记录日志,需要对某些函数进行记录笨的办法,每个函数加入代码,如果代码变了,就悲催了装饰器的办法,定义一个专门日志记录的装饰器,对需要的函数进行装饰.

【Python基础】装饰器的解释和用法

装饰器的用法比较简单,但是理解装饰器的原理还是比较复杂的,考虑到接下来的爬虫框架中很多用到装饰器的地方,我们先来讲解一下. 函数我们定义了一个函数,没有什么具体操作,只是返回一个固定值请注意一下缩进 def sample(): return 1 print(sample()) 作用域函数内部的变量和函数外的变量是不同的我们看一下下面的例子,locals()和globals()方法会得到局部变量和全局变量我们可以在函数中调用全局变量,但是无法在函数中改变全局变量的值 global_str

Python 3 之装饰器详解

------------ 装饰器 ----------------------------------------------------- 什么是装饰器装饰器是为函数和类指定管理代码的一种方式.装饰器本身的形式是处理其他的可调用对象的可调用对象(如函数).正如我们在本书前面所见到过的,Python装饰器以两种相关形式呈现: 函数装饰器在函数定义的时候进行名称重绑定,提供一个逻辑层来管理函数和方法或随后对它们调用. 类装饰器在类定义的时候进行名称重绑定,提供给一个逻辑层来管理类,或管理随后调用

五、python函数、装饰器、内置函数、json及模块

一.递归调用 1.一个函数自己调用自己就是递归调用,最多一个函数递归调用自己999次,超过就会出错2.递归必须有一个明确的结束条件3.每次进入更深一层递归时,问题规模相比上次递归都应有所减少4.递归效率不高,少用递归 eg:def test1(): num = int(input('please enter a number:')) if num%2==0:#判断输入的数字是不是偶数 return True #如果是偶数的话,程序就退出了,返回true print('不是偶数请重新输入!') r