Justin-刘清政的博客

python/面向对象进阶/8-类的property特性

2020-12-21

一、什么是 property特性

  • property装饰器用于将被装饰的方法伪装成一个数据属性,在使用时可以不用加括号而直接使用
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# ############### 定义 ###############
class Foo:
def func(self):
pass

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


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

如下的例子用于说明如何定一个简单的property属性:

1
2
3
4
5
6
7
8
class Goods(object):
@property
def size(self):
return 100


g = Goods()
print(g.size)
1
100

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

\1. 定义时,在实例方法的基础上添加 @property 装饰器;并且仅有一个self参数

\2. 调用时,无需括号

二、简单示例

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

  1. 根据用户请求的当前页和总数据条数计算出 m 和 n
  2. 根据m 和 n 去数据库中请求数据
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# ############### 定义 ###############
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)
print(p.start) # 就是起始值,即:m
1
0
1
print(p.end)  # 就是结束值,即:n
1
10

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

三、 property属性的两种方式

  1. 装饰器 即:在方法上应用装饰器(推荐使用)
  2. 类属性 即:在类中定义值为property对象的类属性(Python2历史遗留)

3.1 装饰器

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

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

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

1
2
3
4
5
6
7
8
9
10
11
# ############### 定义 ###############
class Goods:
@property
def price(self):
return "laowang"


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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#coding=utf-8
# ############### 定义 ###############
class Goods:
"""python3中默认继承object类
以python2、3执行此程序的结果不同,因为只有在python3中才有@xxx.setter @xxx.deleter
"""

@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()
obj.price # 自动执行 @property 修饰的 price 方法,并获取方法的返回值
1
@property
1
obj.price = 123  # 自动执行 @price.setter 修饰的 price 方法,并将  123 赋值给方法的参数
1
@price.setter
1
del obj.price  # 自动执行 @price.deleter 修饰的 price 方法
1
@price.deleter

注意:

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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):
print('del')
del self.original_price


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

3.2 类属性方式

创建值为property对象的类属性

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

1
2
3
4
5
6
7
8
9
10
class Foo:
def get_bar(self):
return 'laowang'

BAR = property(get_bar)


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

property方法中有个四个参数

  1. 第一个参数是方法名,调用 对象.属性 时自动触发执行方法
  2. 第二个参数是方法名,调用 对象.属性 = XXX 时自动触发执行方法
  3. 第三个参数是方法名,调用 del 对象.属性 时自动触发执行方法
  4. 第四个参数是字符串,调用 对象.属性.doc ,此参数是该属性的描述信息
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#coding=utf-8
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()

obj.BAR # 自动调用第一个参数中定义的方法:get_bar
1
2
3
4
5
6
7
getter...





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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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 # 获取商品价格
1
80.0
1
2
obj.PRICE = 200  # 修改商品原价
print(obj.PRICE)
1
160.0
1
del obj.PRICE  # 删除商品原价

综上所述:

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

四、property+类的封装

1
2
3
4
5
6
7
8
9
10
class People:
def __init__(self, name):
self.__name = name

@property # 查看obj.name
def name(self):
return '<名字是:%s>' % self.__name


peo1 = People('lqz')
1
print(peo1.name)
1
<名字是:lqz>
1
2
3
4
try:
peo1.name = 'EGON'
except Exception as e:
print(e)
1
can't set attribute

五、应用

5.1 私有属性添加getter和setter方法

1
2
3
4
5
6
7
8
9
10
11
12
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:不是整型数字")

5.2 使用property升级getter和setter方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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:不是整型数字")

# 定义一个属性,当对这个money设置值时调用setMoney,当获取值时调用getMoney
money = property(getMoney, setMoney)


a = Money()
a.money = 100 # 调用setMoney方法
print(a.money) # 调用getMoney方法
1
100

5.3 使用property取代getter和setter方法

重新实现一个属性的设置和读取方法,可做边界判定

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
class Money(object):
def __init__(self):
self.__money = 0

# 使用装饰器对money进行装饰,那么会自动添加一个叫money的属性,当调用获取money的值时,调用装饰的方法
@property
def money(self):
return self.__money

# 使用装饰器对money进行装饰,当对money设置值时,调用装饰的方法
@money.setter
def money(self, value):
if isinstance(value, int):
self.__money = value
else:
print("error:不是整型数字")


a = Money()
a.money = 100
print(a.money)
1
100

六、练习

计算圆的周长和面积

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import math


class Circle:
def __init__(self, radius): # 圆的半径radius
self.radius = radius

@property
def area(self):
return math.pi * self.radius**2 # 计算面积

@property
def perimeter(self):
return 2 * math.pi * self.radius # 计算周长


c = Circle(10)
1
print(c.radius)
1
10
1
print(c.area)  # 可以向访问数据属性一样去访问area,会触发一个函数的执行,动态计算出一个值
1
314.1592653589793
1
print(c.perimeter)  # 同上
1
62.83185307179586
使用支付宝打赏
使用微信打赏

点击上方按钮,请我喝杯咖啡!

扫描二维码,分享此文章