Python 基础知识：property

2016-06-11

property 本身是一个内置函数，一般用作装饰器（@property），使得我们使用类方法时可以像使用类属性一样简单。如对于下边一个简单的例子，

class Person(object):

    def __init__(self, value):
        self._age = value

    @property
    def age(self):
        return self._age

    @age.setter
    def age(self, value):
        if not isinstance(value, int):
            raise ValueError('age must be an integer!')
        if value < 0 or value > 120:
            raise ValueError('age must between 0 ~ 120!')
        self._age = value

我们可以这样使用类方法：

p = Person(20)
print p.age	# 20
p.age = 30
print p.age	# 30

对于它的作用，正如博文 Python进阶之“属性（property）”详解所提到的，property 主要能够做到以下两点：

将类方法转换为只读属性（非常有用）
重新实现一个属性的 setter 和 getter 方法

本文会主要围绕这两点进行阐述及拓展。

将类方法转换为只读属性

接着文章的开头，我们将类 Person 改造成如下所示：

class Person(object):

    def __init__(self, value):
        self._age = value

    @property
    def age(self):
        return self._age

如果我们对类方法 age 进行赋值操作，则会提示：

# p = Person(20)
# p.age = 30
Traceback (most recent call last):
  File "D:/TestProjects/PyProjects/Test/testproperty.py", line 36, in <module>
    p.age = 30
AttributeError: can't set attribute

这就保证了类方法 age 是只读的，不能被赋值（除了构造函数中的赋值）。这个特性被应用的非常广泛。

重新实现一个属性的 setter 和 getter 方法

property 函数

学习过 C++、Java 等语言我们知道，对类成员变量的访问和设置一般会单独提供 get 和 set 函数。在 Python 中我们同样可以这样子做：

class Person(object):

    def __init__(self, value):
        self._age = value

    def get_age(self):
        return self._age

    def set_age(self, value):
        if not isinstance(value, int):
            raise ValueError('score must be an integer!')
        if value < 0 or value > 120:
            raise ValueError('score must between 0 ~ 120!')
        self._age = value

这个例子的效果跟我们本文开头的例子的效果是一样的，但我们就无法像使用类属性一样去使用类方法。不过，我们只需在源代码中添加一句，就可以像使用类属性一样使用类方法：

class Person(object):

    def __init__(self, value):
        self._age = value

    def get_age(self):
        return self._age

    def set_age(self, value):
        if not isinstance(value, int):
            raise ValueError('score must be an integer!')
        if value < 0 or value > 120:
            raise ValueError('score must between 0 ~ 120!')
        self._age = value

    age = property(get_age, set_age)

实际上，perperty 函数的原型为：

1	property(fget=None, fset=None, fdel=None, doc=None)

关于 property 的使用，官方给了这样一个例子：

class C(object):
    def __init__(self): 
        self._x = None

    @property
    def x(self):
        """I'm the 'x' property."""
        return self._x

    @x.setter
    def x(self, value):
        self._x = value

    @x.deleter
    def x(self):
        del self._x

多参数情况

上边我们用到的 setter 函数都是只有一个参数（除了 self），但如果有多个参数呢？我们可以将多个参数组合成一个 list 或者 tuple，然后再分别赋值给单独的变量。一个简单的例子如下：

class Person(object):

    def __init__(self, first_name, last_name):
        self._first_name = first_name
        self._last_name = last_name

    @property
    def full_name(self):
        return "%s %s" % (self._first_name, self._last_name)

    @full_name.setter
    def full_name(self, name):
        self._first_name, self._last_name = name

p = Person('first_name_1', 'last_name_1')
print p.full_name
p.full_name = ['first_name_2', 'last_name_2'] # 组合为一个 list
print p.full_name
p.full_name = ('first_name_3', 'last_name_3') # 组合为一个 tuple
print p.full_name

参考资料

本文会主要参考以下三篇博文：