property 是用来给 python 中的类增加属性和动作 的
在用C++,Java进行面向对象编程时,我们说不要提供直接对数据成员的访问,应该将数据成员定义为private,并提供public的getter和setter进行访问
这么做的好处在于当我们想要在访问同时做一些其他的处理时(比如日志啊,转换)或者后期需要改动对数据成员的访问过程时,只需要改动类中的getter和setter,而客户代码可以不用改动
但是这么做不可避免地增加代码量,同时这肯定没有采用 obj.member 这样的形式来得简单
Python 就引入Property的概念
假设我们有这么一个简单的类,并打算采用直接访问的方式访问类的数据成员:
class Color:
def __init__(self,rgb_value,name):
self.rgb_value = rgb_value
self.name = name
c = Color("#ff0000","bright red")
print (c.name) #get name
c.name = "red" #set name
现在我们想在set name时增加如下函数的逻辑:
def set_name(self,name):
if not name:
raise Exception("Invalid name")
self.name = name
如果我们还是使用上述Color类的定义,我们的客户代码就要相应地在多处加入类似于 set_name的逻辑,这显然是不合理的
一个解决方案自然是像我们开头说的,把 name 定义为 private的,_name ,(注意python是不存在所谓的private成员的,python的private是非强制的条例,由程序员遵守——
然后定义getter和setter,这是一种传统面向对象的解决办法
但是python使用property,结合了直接访问和getter/setter的优点,来看看怎么做的:
class Color:
def __init__(self,rgb_value,name):
self.rgb_value = rgb_value
self._name = name
def _set_name(self,name):
if not name:
raise Exception("Invalid name")
self._name = name
def _get_name(self,name):
return self._name
name = property(_get_name,_set_name)
使用property指定了name的访问和修改方法,客户可以直接通过这样的方式访问了:
c = Color("#ff0000","bright red")
print (c.name)
c.name = None # 这里会触发raise Exception("Invalid name")