Python @property 修饰方法

说明

《Python 教程》持续更新中，提供建议、纠错、催更等加作者微信: gairuo123（备注：pandas教程）和关注公众号「盖若」ID: gairuo。跟作者学习，请进入 Python学习课程。欢迎关注作者出版的书籍：《深入浅出Pandas》和《Python之光》。

Python 的内置函数（类） property() 一般以装饰器 @property 的形式出现，我们可以使用它来创建只读属性，会将方法转换为相同名称的只读属性,可以与所定义的属性配合使用，这样可以防止属性被修改。同时还可以指定获取、设置、删除的方法。

快速使用

典型用途是定义托管属性 x：

class C(object):
    def getx(self): return self._x
    def setx(self, value): self._x = value
    def delx(self): del self._x
    x = property(getx, setx, delx, "I'm the 'x' property.")

装饰器可以轻松定义新属性或修改现有属性：

class C(object):
    @property
    def x(self):
        "I am the 'x' property."
        return self._x
    @x.setter
    def x(self, value):
        self._x = value
    @x.deleter
    def x(self):
        del self._x

如果 c 为 C 的实例，c.x 将调用 getter，c.x = value 将调用 setter， del c.x 将调用 deleter。

语法

语法如下：

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

参数：

fget：用于获取属性值的函数
fset：用于设置属性值的函数
fdel：用于删除属性的函数
doc：docstring，文档字符串

其中，如果 doc 参数给出，doc 将成为该 property 属性的文档字符串。否则该 property 将拷贝 fget 的文档字符串（如果存在）。这令使用 property() 作为 decorator 来创建只读的特征属性可以很容易地实现:

class Parrot:
    def __init__(self):
        self._voltage = 100000

    @property
    def voltage(self):
        """Get the current voltage."""
        return self._voltage

以上 @property 装饰器会将 voltage() 方法转化为一个具有相同名称的只读属性的 "getter"，并将 voltage 的文档字符串设置为 "Get the current voltage."

特征属性对象具有 getter, setter 以及 deleter 方法，它们可用作装饰器来创建该特征属性的副本，并将相应的访问函数设为所装饰的函数。这最好是用一个例子来解释:

class C:
    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

上述代码与第一个例子完全等价。注意一定要给附加函数与原始的特征属性相同的名称 (在本例中为 x。)

返回的特征属性对象同样具有与构造器参数相对应的属性 fget, fset 和 fdel。

在 3.5 版更改: 特征属性对象的文档字符串现在是可写的。

应用场景

以下是一个设置市斤的例子。

class Shijin:
    def __init__(self, jin, liang):
        self.total_liang = jin * 10 + liang

    # 获取斤
    @property
    def jin(self):
        return self.total_liang // 10

    # 获取和设置两
    @property
    def liang(self):
        return self.total_liang % 10

    @liang.setter
    def liang(self, new_liang):
        self.total_liang = 10 * self.jin + new_liang

    def __repr__(self):
        return "{}斤{}两".format(self.jin, self.liang)

jiaozi = Shijin(3, 2)

jiaozi
# 3斤2两

jiaozi.liang = 4
jiaozi
# 3斤4两

jiaozi.liang += 6

jiaozi
# 4斤0两

jiaozi.jin += 10
# AttributeError: can't set attribute 'jin'

jiaozi.jin
# 4

参考

https://docs.python.org/zh-cn/3/library/functions.html#property
https://www.programiz.com/python-programming/property
https://stackoverflow.com/questions/17330160/how-does-the-property-decorator-work-in-python

< super() 调用超类方法 Python 内置函数 breakpoint() 断点 >

更新时间：2022-05-23 16:09:28 标签：python 类属性