Python property() 函数

描述

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

语法

以下是 property() 方法的语法:

  1. class property([fget[, fset[, fdel[, doc]]]])

参数

  • fget：获取属性值的函数
  • fset：设置属性值的函数
  • fdel：删除属性值函数
  • doc：属性描述信息

返回值

返回新式类属性。

实例

定义一个可控属性值 x

  1. class C(object):
  2. def __init__(self):
  3. self._x = None
  4. def getx(self):
  5. return self._x
  6. def setx(self, value):
  7. self._x = value
  8. def delx(self):
  9. del self._x
  10. x = property(getx, setx, delx, "I'm the 'x' property.")

如果 c 是 C 的实例化，c.x 将触发 getter,c.x = value 将触发 setter，del c.x 触发 deleter。

如果给定 doc 参数，其将成为这个属性值的 docstring，否则 property 函数就会复制 fget 函数的 docstring（如果有的话）。

将 property 函数用作装饰器可以很方便的创建只读属性：

  1. class Parrot(object):
  2. def __init__(self):
  3. self._voltage = 100000
  4. @property
  5. def voltage(self):
  6. """Get the current voltage."""
  7. return self._voltage

上面的代码将 voltage() 方法转化成同名只读属性的 getter 方法。

property 的 getter，setter 和 deleter 方法同样可以用作装饰器：

  1. class C(object):
  2. def __init__(self):
  3. self._x = None
  4. @property
  5. def x(self):
  6. """I'm the 'x' property."""
  7. return self._x
  8. @x.setter
  9. def x(self, value):
  10. self._x = value
  11. @x.deleter
  12. def x(self):
  13. del self._x

这个代码和第一个例子完全相同，但要注意这些额外函数的名字和 property 下的一样，例如这里的 x。