讲师中心 微信公众号
AI工具推荐 视频效率加速

Python 中实现只读属性的 Descriptor 教程

夜强大大_4230

夜强大大_4230

发布时间:2026-11-08 20:56:03

|

304人浏览过

|

来源于php中文网

原创

Python 中实现只读属性的 Descriptor 教程

本文详解如何用自定义 descriptor 正确实现真正可初始化、不可篡改的只读属性,并解决嵌套可变对象(如列表)的深层修改问题。

本文详解如何用自定义 descriptor 正确实现真正可初始化、不可篡改的只读属性,并解决嵌套可变对象(如列表)的深层修改问题。

在 Python 中,@property 是实现只读属性最常用的方式,但当项目中存在大量类似逻辑(如多个类需统一管理只读字段)时,重复编写 @property 显得冗余且难以维护。此时,使用 descriptor 封装只读行为是更优雅、可复用的方案。然而,直接照搬 property 的语义到 descriptor 并不简单——常见误区是让 __set__ 无条件抛出异常,导致 __init__ 初始化失败。

✅ 正确的只读 descriptor 实现

核心原则:允许首次赋值(即初始化),禁止后续修改。这要求 __set__ 方法区分“首次设置”与“重复赋值”:

class ReadOnly:
    def __set_name__(self, owner, name):
        # 使用私有名称存储实际值,避免 descriptor 自身被实例属性覆盖
        self._name = f"_{name}"

    def __get__(self, instance, owner):
        if instance is None:
            return self
        return getattr(instance, self._name, None)

    def __set__(self, instance, value):
        # 若私有属性已存在,说明已被初始化过 → 禁止修改
        if hasattr(instance, self._name):
            raise AttributeError(f"Cannot modify read-only attribute '{self._name[1:]}'")
        # 否则允许初始化(如 __init__ 中首次赋值)
        setattr(instance, self._name, value)

    def __delete__(self, instance):
        raise AttributeError(f"Cannot delete read-only attribute '{self._name[1:]}'")

? 关键点:__set_name__ 中将底层存储名设为 _name(如 top → _top),确保 descriptor 不与实例属性同名冲突;__set__ 通过 hasattr(instance, self._name) 判断是否已初始化,而非检查 instance.__dict__(更健壮,兼容 __slots__ 类)。

使用示例:

立即学习“Python免费学习笔记(深入)”;

class A:
    n = ReadOnly()
    top = ReadOnly()

    def __init__(self, n):
        self.n = n      # ✅ 首次赋值成功
        self.top = -1   # ✅ 首次赋值成功

    def increase(self):
        # 注意:此处 self.top += 1 实际触发 __get__ + __set__ → 会报错!
        # 正确做法是直接操作底层属性:
        self._top += 1  # ✅ 允许内部修改

a = A(7)
print(a.top)     # → -1
a.increase()
print(a.top)     # → 0
a.top = 100      # ❌ AttributeError: Cannot modify read-only attribute 'top'

⚠️ 注意:self.top += 1 等价于 self.top = self.top + 1,会触发 __set__ → 报错。因此,只读 descriptor 仅约束外部访问,内部逻辑仍需直接操作底层私有属性(如 self._top)。

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载

?️ 进阶:防止可变对象(如 list)的深层修改

只读 descriptor 能阻止 s.S = [...],但无法阻止 s.S[0] = x —— 因为 s.S 返回的是原列表对象引用,其内部修改不经过 descriptor 的 __set__。

若需彻底冻结可变对象,有以下两种策略:

方案一:返回不可变代理(推荐)

使用 types.MappingProxyType(仅适用于 dict)或自定义只读包装器。对列表,可返回 tuple 或封装为只读视图:

from collections.abc import Sequence

class ReadOnlyList(Sequence):
    def __init__(self, data):
        self._data = list(data)  # 深拷贝防御原始引用

    def __getitem__(self, index):
        return self._data[index]

    def __len__(self):
        return len(self._data)

    def __repr__(self):
        return f"ReadOnlyList({self._data!r})"

# 在 descriptor 中返回只读视图
class ReadOnly:
    # ... __get__, __set__ 同上 ...
    def __get__(self, instance, owner):
        if instance is None:
            return self
        value = getattr(instance, self._name, None)
        # 对 list 类型自动包装为只读视图
        if isinstance(value, list):
            return ReadOnlyList(value)
        return value

方案二:深度冻结(谨慎使用)

初始化时对可变对象做深拷贝并转为不可变类型(如 tuple),适合数据量小、结构简单的场景:

import copy

def __set__(self, instance, value):
    if hasattr(instance, self._name):
        raise AttributeError(f"Cannot modify read-only attribute '{self._name[1:]}'")
    # 若是 list/dict,存为不可变副本
    if isinstance(value, list):
        value = tuple(value)
    elif isinstance(value, dict):
        value = frozenset(value.items())
    setattr(instance, self._name, value)

? 提示:方案一更灵活,保留原始类型接口;方案二更彻底但牺牲了可变性,需按业务权衡。

✅ 总结

  • 只读 descriptor 的 __set__ 必须区分 初始化 与 重赋值,利用 hasattr(instance, private_name) 判断;
  • 底层存储名应与 descriptor 名不同(如 _n vs n),避免命名冲突;
  • __get__ 应支持 None 实例(类访问)和正常实例访问;
  • 对可变对象的“只读”,需额外封装(如只读代理)或冻结(如转 tuple),descriptor 本身无法拦截其内部操作;
  • 最终目标:对外提供安全的只读接口,对内保留必要的可变能力,兼顾安全性与实用性。

通过以上设计,你不仅能替代 @property 实现统一的只读逻辑,还能构建出可扩展、易维护的属性管控体系。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

相关专题

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

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

1891

2023.07.20

python能做什么
python能做什么

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

5204

2023.07.25

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

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

1829

2023.07.31

python教程
python教程

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

31477

2023.08.03

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

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

3727

2023.08.04

python eval
python eval

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

3747

2023.08.04

scratch和python区别
scratch和python区别

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

1263

2023.08.11

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

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

616

2023.08.10

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn