如何在Python中定义只读属性_使用@property装饰器包装getter方法

老明大大_3688

老明大大_3688

2026-05-06

971人浏览

原创

@property定义的属性默认只读,因未定义setter而赋值会报AttributeError;需显式添加@attr.setter才可写,且真只读应配合私有属性与不可变返回值。

如何在python中定义只读属性_使用@property装饰器包装getter方法

为什么直接赋值会报错:@property 定义的属性没有 setter

当你用 @property 只定义了 getter,Python 就默认该属性“不可写”。尝试执行 obj.attr = value 时,会抛出 AttributeError: can't set attribute。这不是 bug,是设计使然——@property 本身不生成 setter,除非你显式加上 @attr.setter。

常见误操作:以为加了 @property 就自动支持读写,结果在初始化或后续逻辑中赋值失败。

  • 只写 @property → 只读(安全,推荐用于计算属性或封装内部状态)
  • 写了 @attr.setter → 可读可写(需自行控制逻辑,比如校验、缓存失效)
  • 写了 @attr.deleter → 还能支持 del obj.attr(极少用,慎用)

如何真正实现“只读”,而不是“假装只读”

光靠 @property 不够——如果底层数据是公开实例变量(如 self._value),用户仍可绕过 getter 直接修改 obj._value。真只读需要配合命名约定 + 封装意识。

实操建议:

  • 把真实数据存在私有属性(如 self._x 或 self.__x),并在 @property 中返回它的副本或只读视图(比如 tuple(self._items) 而非 self._items)
  • 避免在 getter 中返回可变对象的原始引用,否则外部仍能修改内容(例如返回 list 而不是 tuple 或 copy.copy())
  • 若需彻底禁止访问底层变量,可用 __slots__ 限制属性名,或借助 __getattr__ 拦截未定义属性访问(但会增加复杂度,一般没必要)

什么时候该用 @property,而不是普通方法或公有属性

@property 的核心价值是“接口不变,实现可变”。它适合那些逻辑简单、无副作用、调用开销小的访问场景。

适用情况:

python-parallelization
python-parallelization

将顺序 Python 代码转换为并行/并发实现,用于在需要并行化 Python 代码、提升性能时使用。

下载
  • 需要对字段做简单转换(如单位换算:@property 返回 self._cm / 100.0)
  • 封装计算逻辑(如 full_name 基于 first_name 和 last_name 拼接)
  • 兼容旧代码:把原来公有属性改成带校验或日志的访问器,调用方无需改代码

不适用情况:

  • 耗时操作(如网络请求、文件读取)——应改为显式方法,如 obj.load_data()
  • 有副作用(如修改状态、触发事件)——违反“属性访问应是轻量且无感”的直觉
  • 需要传参——属性不能接收参数,此时必须用方法

一个典型只读属性定义示例

下面是一个带类型检查、防篡改、不暴露底层列表的只读属性定义:

class Box:
    def __init__(self, items):
        self._items = list(items)  # 存为私有可变列表
<pre class="brush:php;toolbar:false;">@property
def items(self):
    return tuple(self._items)  # 返回不可变副本,防止外部修改

使用效果:

  • box.items ✅ 正常返回 tuple
  • box.items = [1, 2] ❌ 报 AttributeError
  • box._items.append(3) ⚠️ 虽然技术上可行,但属于破坏封装,应视为使用者违规

真正的难点不在语法,而在判断哪些数据该暴露、以什么形态暴露、以及是否值得为这点便利增加维护成本。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1751

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4544

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1729

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

26717

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3227

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3247

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1183

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2523

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习