一文详述 Python 中的 property 语法


Posted in Python onSeptember 01, 2020

property() 函数的作用是在新式类中返回属性值。

Python中有一个property的语法,它类似于C#的get set语法,其功能有以下两点:

  • 将类方法设置为只读属性;
  • 实现属性的getter和setter方法;

下面开始本文的重点介绍,Python 中的 property 语法介绍,具体内容如下所示:

在大多数语言的程序中,一个类,每有一个属性,就会对应 setter 和 getter,基本都是标配。

示例:

class Money(object):
  def __init__(self):
    self.__money = 0

  def getMoney(self):
    return self.__money

  def setMoney(self, value):
    if isinstance(value, int):
      self.__money = value
    else:
      print("error:不是整型数字")

设置私有属性的目的就是不想让数据被误取出来,增加一个方法去获取私有属性或者设置私有属性,那么就保证将来想获取属性的时候就获取,想设置的时候还可以进行过滤。

其他语言基本都是这么做的,但是 Python 不推荐。 Python 有 property。

一、什么是property属性

一种用起来像是使用的实例属性一样的特殊属性,可以对应于某个方法。

class Foo:
  def func(self):
    pass

  # 定义property属性
  @property
  def prop(self):
    pass

foo_obj = Foo()
foo_obj.func() # 调用实例方法
foo_obj.prop # 调用property属性

示例:

class Goods:
  @property
  def size(self):
    return 100

obj = Goods()
ret = obj.size # 调用属性
print(ret) # 100

obj.size 会自动地去调用 size 方法,返回 size 方法的返回值。

property属性的定义和调用要注意以下几点:

  • 定义时,在实例方法的基础上添加 @property 装饰器;
  • 仅有一个self参数;
  • 调用时,无需括号。

那 property 属性到底是用来干什么的?下面看一个实例。

对于京东商城中显示电脑主机的列表页面,每次请求不可能把数据库中的所有内容都显示到页面上,而是通过分页的功能局部显示,所以在向数据库中请求数据时就要显示的指定获取从第m条到第n条的所有数据,这个分页的功能包括:

  • 根据用户请求的当前页和总数据条数计算出 m 和 n。
  • 根据m 和 n 去数据库中请求数据。
class Pager:
  def __init__(self, current_page):
    # 用户当前请求的页码(第一页、第二页...)
    self.current_page = current_page
    # 每页默认显示10条数据
    self.per_items = 10

  @property
  def start(self):
    val = (self.current_page - 1) * self.per_items
    return val

  @property
  def end(self):
    val = self.current_page * self.per_items
    return val

p = Pager(1)
p.start # 就是起始值,即:m
p.end # 就是结束值,即:n

从上述可见,Python 的 property 属性的功能是:property属性内部进行一系列的逻辑计算,最终将计算结果返回。

二、property属性的有两种方式

  • 装饰器 即:在方法上应用装饰器。
  • 类属性 即:在类中定义值为 property 对象的类属性。

1、装饰器方式

在类的实例方法上应用 @property 装饰器。

Python中的类有经典类和新式类,新式类的属性比经典类的属性丰富。( 如果类继object,那么该类是新式类 )

经典类,具有一种 @property 装饰器。

class Goods:
  @property
  def price(self):
    return "laowang"

obj = Goods()
# 自动执行 @property 修饰的 price 方法,并获取方法的返回值
result = obj.price 
print(result) # laowang

新式类,具有三种@property装饰器。

python3 中默认继承object类,只有在 python3 中才有@xxx.setter @xxx.deleter。

class Goods:
  
  @property
  def price(self):
    print('@property')

  @price.setter
  def price(self, value):
    print('@price.setter')

  @price.deleter
  def price(self):
    print('@price.deleter')

obj = Goods()
# 自动执行 @property 修饰的 price 方法,并获取方法的返回值
obj.price # @property
# 自动执行 @price.setter 修饰的 price 方法,并将 123 赋值给方法的参数
obj.price = 123 # @price.setter
# 自动执行 @price.deleter 修饰的 price 方法
del obj.price # @price.deleter

注意:

  • 经典类中的属性只有一种访问方式,其对应被 @property 修饰的方法。
  • 新式类中的属性有三种访问方式,并分别对应了三个被@property、@方法名.setter、@方法名.deleter修饰的方法。

由于新式类中具有三种访问方式,我们可以根据它们几个属性的访问特点,分别将三个方法定义为对同一个属性:获取、修改、删除。

示例:

class Goods(object):

  def __init__(self):
    # 原价
    self.original_price = 100
    # 折扣
    self.discount = 0.8

  @property
  def price(self):
    # 实际价格 = 原价 * 折扣
    new_price = self.original_price * self.discount
    return new_price

  @price.setter
  def price(self, value):
    self.original_price = value

  @price.deleter
  def price(self):
    del self.original_price

obj = Goods()
obj.price     # 获取商品价格
obj.price = 200  # 修改商品原价
del obj.price   # 删除商品原价

2、类属性方式

创建值为 property 对象的类属性。

当使用类属性的方式创建property属性时,经典类和新式类无区别。

示例:

class Foo:
  def get_bar(self):
    return 'laowang'

  BAR = property(get_bar)

obj = Foo()
reuslt = obj.BAR # 自动调用get_bar方法,并获取方法的返回值
print(reuslt) # laowang

property方法中有个四个参数

  • 第一个参数是方法名,调用 对象.属性 时自动触发执行方法。
  • 第二个参数是方法名,调用 对象.属性 = XXX 时自动触发执行方法。
  • 第三个参数是方法名,调用 del 对象.属性 时自动触发执行方法。第四个参数是字符串,调用 对象.属性.__doc__ ,此参数是该属性的描述信息。

示例:

class Foo(object):
  def get_bar(self):
    print("getter...")
    return 'laowang'

  def set_bar(self, value):
    """必须两个参数"""
    print("setter...")
    return 'set value' + value

  def del_bar(self):
    print("deleter...")
    return 'laowang'

  BAR = property(get_bar, set_bar, del_bar, "description...")

obj = Foo()
# 自动调用第一个参数中定义的方法:get_bar
obj.BAR # getter...
# 自动调用第二个参数中定义的方法:set_bar方法,并将“alex”当作参数传入
obj.BAR = "alex" # setter...
# 自动获取第四个参数中设置的值:description...
desc = Foo.BAR.__doc__
print(desc) # description...
# 自动调用第三个参数中定义的方法:del_bar方法
del obj.BAR # deleter...

由于类属性方式创建 property 属性具有3种访问方式,我们可以根据它们几个属性的访问特点,分别将三个方法定义为对同一个属性:获取、修改、删除。

class Goods(object):

  def __init__(self):
    # 原价
    self.original_price = 100
    # 折扣
    self.discount = 0.8

  def get_price(self):
    # 实际价格 = 原价 * 折扣
    new_price = self.original_price * self.discount
    return new_price

  def set_price(self, value):
    self.original_price = value

  def del_price(self):
    del self.original_price

  PRICE = property(get_price, set_price, del_price, '价格属性描述...')

obj = Goods()
obj.PRICE     # 获取商品价格
obj.PRICE = 200  # 修改商品原价
del obj.PRICE   # 删除商品原价

综上所述:

  • 定义property属性共有两种方式,分别是【装饰器】和【类属性】,而【装饰器】方式针对经典类和新式类又有所不同。
  • 通过使用property属性,能够简化调用者在获取数据的流程。

总结

到此这篇关于一文详述 Python 中的 property 语法的文章就介绍到这了,更多相关Python 中的 property 语法内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
python 简易计算器程序,代码就几行
Aug 29 Python
Python多线程实例教程
Sep 06 Python
python实现多线程的方式及多条命令并发执行
Jun 07 Python
PyCharm设置护眼背景色的方法
Oct 29 Python
Flask框架学习笔记之模板操作实例详解
Aug 15 Python
flask 实现token机制的示例代码
Nov 07 Python
python 实现目录复制的三种小结
Dec 04 Python
python装饰器相当于函数的调用方式
Dec 27 Python
Pytorch.nn.conv2d 过程验证方式(单,多通道卷积过程)
Jan 03 Python
Python requests模块session代码实例
Apr 14 Python
Autopep8的使用(python自动编排工具)
Mar 02 Python
Python中使用tkFileDialog实现文件选择、保存和路径选择
May 20 Python
Python Opencv轮廓常用操作代码实例解析
Sep 01 #Python
聊聊python中的异常嵌套
Sep 01 #Python
理解Django 中Call Stack机制的小Demo
Sep 01 #Python
如何快速理解python的垃圾回收机制
Sep 01 #Python
Python Opencv图像处理基本操作代码详解
Aug 31 #Python
Python Matplotlib绘图基础知识代码解析
Aug 31 #Python
一些关于python 装饰器的个人理解
Aug 31 #Python
You might like
Yii2单元测试用法示例
2016/11/12 PHP
javascript下阻止表单重复提交、防刷新、防后退
2007/08/17 Javascript
javascript form 验证函数 弹出对话框形式
2009/06/23 Javascript
JQuery,Extjs,YUI,Prototype,Dojo 等JS框架的区别和应用场景简述
2010/04/15 Javascript
jquery 添加节点的几种方法介绍
2013/09/04 Javascript
JavaScript笔记之数据属性和存储器属性
2016/03/31 Javascript
Node.js返回JSONP详解
2016/05/18 Javascript
jquery树形菜单效果的简单实例
2016/06/06 Javascript
Node.js中使用jQuery的做法
2016/08/17 Javascript
详解webpack 如何集成第三方js库
2017/06/29 Javascript
JavaScript模块详解
2017/12/18 Javascript
详解iframe跨域的几种常用方法(小结)
2019/04/29 Javascript
Vue 实现前进刷新后退不刷新的效果
2019/06/14 Javascript
ionic4+angular7+cordova上传图片功能的实例代码
2019/06/19 Javascript
JavaScript判断数组类型的方法
2019/10/23 Javascript
Layui实现数据表格默认全部显示(不要分页)
2019/10/26 Javascript
js布局实现单选按钮控件
2020/01/17 Javascript
Python模块学习 re 正则表达式
2011/05/19 Python
python逐行读取文件内容的三种方法
2014/01/20 Python
python访问mysql数据库的实现方法(2则示例)
2016/01/06 Python
Python中常用信号signal类型实例
2018/01/25 Python
java判断三位数的实例讲解
2019/06/10 Python
世界上最大的街头服饰网站:Karmaloop
2017/02/04 全球购物
美国羽绒床上用品第一品牌:Pacific Coast
2018/08/25 全球购物
几个人围成一圈的问题
2013/09/26 面试题
高校毕业生自我鉴定
2013/10/27 职场文书
公司董事长职责
2013/12/12 职场文书
关于赌博的检讨书
2014/01/24 职场文书
数学系个人求职信范文
2014/01/30 职场文书
关于青春的演讲稿500字
2014/08/22 职场文书
2015年万圣节活动总结
2015/03/24 职场文书
认识实习感想
2015/08/10 职场文书
生活小常识广播稿
2015/08/19 职场文书
redis连接被拒绝的解决方案
2021/04/12 Redis
golang json数组拼接的实例
2021/04/28 Golang
一文搞懂Python Sklearn库使用
2021/08/23 Python