python - @property属性

最新推荐文章于 2025-12-03 08:36:28 发布

原创最新推荐文章于 2025-12-03 08:36:28 发布 · 800 阅读

12 ·

CC 4.0 BY-SA版权

文章标签：

#property

python 同时被 2 个专栏收录

177 篇文章

订阅专栏

linux

120 篇文章

订阅专栏

本文介绍了Python的@property装饰器，它能将方法转换为属性调用，以实现属性的可控操作。通过示例说明了如何使用@property来确保数据的正确性，如在借书系统中防止状态错误。此外，还探讨了@property创建的.setter装饰器，用于属性赋值，并提到了如何创建只读属性。最后，给出了一个关于日期类的源代码范例，展示了year、month和day作为只读属性的应用。

总结：
1). Python内置的@property装饰器就是负责把一个方法变成属性调用的;
2). @property本身又创建了另一个装饰器@state.setter，负责把一个
setter方法变成属性赋值，于是，我们就拥有一个可控的属性操作.
3). @property广泛应用在类的定义中，可以让调用者写出简短的代码，
同时保证对参数进行必要的检查，这样，程序运行时就减少了出错的可能性。

现在模拟一个借书系统，规定0是借出，1是未借出。但是若输入3-100程序不会报错，会导致借书状态错误。这时利用@property就可以解决这个问题。
设置 get_state获取状态、set_state检查状态、del_state删除状态。

from colorFont import  *
class Book(object):
    def __init__(self, name, kind, state):
        self.name = name
        self.kind = kind
        # 0： 借出  1： "未借出"
        # 书的状态只能是0或者1， 如果是其他， 应该报错；
        # 查看书状态， 希望是汉字形式， 有实际意义的；
        self.__state  = 0 # 私有属性

    @property   # 将这个方法转换为类的属性; print(book.state)
    def get_state(self):
        if self.__state == 0:
            return  ERRRED + "借出"
        elif self.__state == 1:
            return  OKGREEN + "未借出"
     
    def set_state(self, value):
        # 检查参数
        if value in (0,1):
            # 更新书状态
            self.__state = value
        else:
            print(ERRRED + "更新错误， 必须是0或者1")

    def del_state(self):
        # 删除书的状态
        del self.__state
        print(OKGREEN + "删除书状态成功!")

if __name__ == "__main__":
    book = Book("python核心编程", 'python', 1)
    book.set_state(3)  # book.state = 3
    print(book.get_state)  # print(book.state)

在这里插入图片描述

但是这样会显得很繁琐。@property创建了另一个装饰器@state.setter负责把一个setter方法变成属性赋值，于是，我们就拥有一个可控的属性操作.

from colorFont import  *
class Book(object):
    def __init__(self, name, kind, state):
        self.name = name
        self.kind = kind
        # 0： 借出  1： "未借出"
        # 书的状态只能是0或者1， 如果是其他， 应该报错；
        # 查看书状态， 希望是汉字形式， 有实际意义的；
        self.__state  = 0 # 私有属性

    @property   # 将这个方法转换为类的属性; print(book.state)
    def state(self):
        if self.__state == 0:
            return  ERRRED + "借出"
        elif self.__state == 1:
            return  OKGREEN + "未借出"

    @state.setter  # book.state = 0
    def state(self, value):
        if value in (0,1):
            # 更新书状态
            self.__state = value
        else:
            print(ERRRED + "更新错误， 必须是0或者1")

    @state.deleter  # del book.state
    def state(self):
        del self.__state
        print(OKGREEN + "删除书状态成功!")

if __name__ == "__main__":
    book = Book("python核心编程", 'python', 1)
	book.state = 1
    print(book.state)
    del book.state

在这里插入图片描述

@property属性还可以定义只读属性(不定义setter方法就是只读属性)
源代码范例：
可以ctrl进入date，我们可以发现year,month,day都为只读属性
在这里插入图片描述

from datetime import  date
#from datetime import  time
#import time
# -datetime.date：表示日期的类。常用的属性有year, month, day；
#-datetime.time：表示时间的类。常用的属性有hour, minute, second, microsecond；

# Read-only field accessors
@property
def year(self):
    # year (1-9999)
    return self._year


@property
def month(self):
    # month (1-12)
    return self._month


@property
def day(self):
    # day (1-31)
    return self._day


if __name__ == '__main__':
    d = date(2019, 10, 10)
    print(d.year)
    print(d.month)
    print(d.day)

输出：
在这里插入图片描述

为了测试是否d是否只读，测试函数写成：

if __name__ == '__main__':
    d = date(2019, 10, 10)
    print(d.year)
    print(d.month)
    print(d.day)


    d.year = 2020     # 此处不成功， year是只读的
    del d.year        # 此处不成功， year是只读的
    print(d.year)

输出报错：

2019
10
10
Traceback (most recent call last):
  File "/home/kiosk/Documents/python/python1230/day13/07_property属性.py", line 68, in <module>
    d.year = 2020     # 此处不成功， year是只读的
AttributeError: attribute 'year' of 'datetime.date' objects is not writable