获取更多文章和更新,请关注我的个人主页:www.leiting6.cn

看了很多遍廖雪峰老师的教程,网上也查了很多文章,最终发现,@property的作用就是:把类的方法转化为类的属性(只读)、取代传统的get/set/del方法 — 起码到现在为止我的理解是这样的。具体细节,下面一一道来。

1 转化类方法为类只读属性

废话不多说,首先上代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#!/usr/bin/env python3
# -*- coding: utf-8 -*-


class Computer():
"""
电脑的使用时间,一般我们不愿意外部程序可以直接更改这个参数,
因为我们需要根据这个参数来得知电脑的新旧状况,
当然,随着电脑的继续使用,内部程序是会更新这个参数的,这里先忽略这种情况,
假设电脑已经没有在使用了。
"""
@property
def hours_of_use(self):
return 213


Bob_thinkPad = Computer()
print("\nBob's thinkpad has been used for %d hours!" % Bob_thinkPad.hours_of_use)

print("Can I change the use time of Bob's thinkPad?")
try:
Bob_thinkPad.hours_of_use = 20
except AttributeError as e:
print('Use time of a computer cannot be set to another value!')

执行结果为:(环境为Pycharm Mac, python-3.6)

1
2
3
4
5
6
7
/Library/Frameworks/Python.framework/Versions/3.6/bin/python3.6 /Volumes/文档/Python/test/4.py

Bob's thinkpad has been used for 213 hours!
Can I change the use time of Bob's thinkPad?
Use time of a computer cannot be set to another value!

Process finished with exit code 0

照旧分析一下:

按照之前学习的节奏来看,想要给Computer类增加一个属性hours_of_use,需要构造init方法,然后添加这个属性;但是这里并没有这么做,而是直接构造了一个hours_of_use方法,需要注意的是这个方法前面使用了@property,这就让hours_of_use从一个方法变成了Computer类的属性,而且固定返回213这个数值;外部程序可以很自如地读取这个属性的数值;但如果外部程序想要改动它的数值,结果是不会成功的,也就是说,hours_of_use这个属性到这时为止,是个只读属性。

2 取代get/set/del方法

这里引用http://python.jobbole.com/80955/上的例子

让我们假设我们有一些遗留代码,它们是由一些对Python理解得不够好的人写的。如果你像我一样,你之前已经看到过这类的代码:

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
26
27
from decimal import Decimal

########################################################################
class Fees(object):
""""""

#----------------------------------------------------------------------
def __init__(self):
"""Constructor"""
self._fee = None

#----------------------------------------------------------------------
def get_fee(self):
"""
Return the current fee
"""
return self._fee

#----------------------------------------------------------------------
def set_fee(self, value):
"""
Set the fee
"""
if isinstance(value, str):
self._fee = Decimal(value)
elif isinstance(value, Decimal):
self._fee = value

要使用这个类,我们必须要使用定义的getter和setter方法:

1
2
3
4
>>> f = Fees()
>>> f.set_fee("1")
>>> f.get_fee()
Decimal('1')

如果你想添加可以使用正常点符号访问的属性,而不破坏所有依赖于这段代码的应用程序,你可以通过添加一个属性函数非常简单地改变它:

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
26
27
28
29
from decimal import Decimal

########################################################################
class Fees(object):
""""""

#----------------------------------------------------------------------
def __init__(self):
"""Constructor"""
self._fee = None

#----------------------------------------------------------------------
def get_fee(self):
"""
Return the current fee
"""
return self._fee

#----------------------------------------------------------------------
def set_fee(self, value):
"""
Set the fee
"""
if isinstance(value, str):
self._fee = Decimal(value)
elif isinstance(value, Decimal):
self._fee = value

fee = property(get_fee, set_fee)

我们在这段代码的末尾添加了一行。现在我们可以这样做:

1
2
3
4
5
6
7
>>> f = Fees()
>>> f.set_fee("1")
>>> f.fee
Decimal('1')
>>> f.fee = "2"
>>> f.get_fee()
Decimal('2')

正如你所看到的,当我们以这种方式使用属性函数时,它允许fee属性设置并获取值本身而不破坏原有代码。让我们使用属性装饰器来重写这段代码,看看我们是否能得到一个允许设置的属性值。

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
26
27
28
29
30
31
32
33
from decimal import Decimal

########################################################################
class Fees(object):
""""""

#----------------------------------------------------------------------
def __init__(self):
"""Constructor"""
self._fee = None

#----------------------------------------------------------------------
@property
def fee(self):
"""
The fee property - the getter
"""
return self._fee

#----------------------------------------------------------------------
@fee.setter
def fee(self, value):
"""
The setter of the fee property
"""
if isinstance(value, str):
self._fee = Decimal(value)
elif isinstance(value, Decimal):
self._fee = value

#----------------------------------------------------------------------
if __name__ == "__main__":
f = Fees()

上面的代码演示了如何为fee属性创建一个setter方法。你可以用一个名为@fee.setter的装饰器装饰第二个方法名也为fee的方法来实现这个。当你如下所做时,setter被调用:

1
2
>>> f = Fees()
>>> f.fee = "1"

如果你看属性函数的说明,它有fget, fset, fdel和doc几个参数。如果你想对属性使用del命令,你可以使用@fee.deleter创建另一个装饰器来装饰相同名字的函数从而实现删除的同样效果。

除此之外,还有一篇帖子对于@property装饰器的解释也比较透彻:
http://www.jb51.net/article/86970.htm