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

Python 中实现只读属性的描述符(Descriptor)完整教程

云晨君_6428

云晨君_6428

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

|

687人浏览过

|

来源于php中文网

原创

Python 中实现只读属性的描述符(Descriptor)完整教程

本文详解如何用 python 描述符正确实现真正可初始化、不可篡改的只读属性,并解决底层可变对象(如列表)被意外修改的问题。

本文详解如何用 python 描述符正确实现真正可初始化、不可篡改的只读属性,并解决底层可变对象(如列表)被意外修改的问题。

在 Python 中,@property 是实现只读属性最直观的方式,但当项目中存在大量类似字段(如配置类、数据容器、栈结构等)时,重复编写 @property 会显著降低可维护性。此时,使用描述符(Descriptor) 封装只读逻辑是更优雅、更符合 DRY 原则的方案。然而,直接照搬 property 的语义到描述符中容易踩坑——典型问题就是:初始化失败(__set__ 在 __init__ 中即被调用并抛出异常),以及可变对象内容仍可被原地修改(如 obj.items.append(x))。

✅ 正确的只读描述符实现

关键在于:允许首次赋值(即初始化),但禁止后续覆写。这需要在 __set__ 中判断目标属性是否已存在于实例字典中:

class ReadOnly:
    def __init__(self, default=None):
        self.default = default

    def __set_name__(self, owner, name):
        # 使用私有名称存储真实值,避免与描述符同名冲突
        self._attr_name = f"_{name}"

    def __get__(self, instance, owner):
        if instance is None:
            return self
        # 若未初始化,返回默认值(可选)
        return getattr(instance, self._attr_name, self.default)

    def __set__(self, instance, value):
        # 仅当该私有属性尚未存在时才允许设置(即仅初始化阶段)
        if hasattr(instance, self._attr_name):
            raise AttributeError(f"Cannot modify read-only attribute '{self._attr_name[1:]}'")
        setattr(instance, self._attr_name, value)

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

? 注意:__set_name__ 中将存储名设为 f"_{name}" 是关键设计——它确保描述符本身(类属性)与实例实际数据(如 _n、_top)完全隔离,避免 descriptor 协议被绕过或覆盖。

使用示例:

Python Hardener
Python Hardener

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

下载

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

class Stack:
    S = ReadOnly()
    n = ReadOnly()
    top = ReadOnly()

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

    def push(self, x):
        if self.top + 1 < self.n:
            self.top += 1
            self.S[self.top] = x  # ✅ 允许修改列表内容(这是预期行为)

s = Stack(4)
print(s.S)    # [None, None, None, None]
print(s.top)  # -1

# ❌ 以下均抛出 AttributeError
# s.S = [1, 2]
# s.top = 10
# del s.n

⚠️ 关于“可变对象内容不可修改”的常见误解

描述符控制的是属性绑定关系(即 obj.attr = value),而非对象内部状态。因此:

  • s.S = [...] → 被 ReadOnly.__set__ 拦截 ✅
  • s.S.append(...) 或 s.S[0] = ... → 直接操作列表对象,与描述符无关 ❌

若业务场景要求彻底冻结可变对象内容(例如禁止任何元素增删改),需额外封装不可变视图。推荐方案如下:

方案一:返回 tuple(适用于只读序列)

def __get__(self, instance, owner):
    if instance is None:
        return self
    raw = getattr(instance, self._attr_name)
    return tuple(raw) if isinstance(raw, list) else raw

方案二:使用 types.MappingProxyType(适用于 dict)

from types import MappingProxyType
# 在 __get__ 中返回 MappingProxyType(raw)

方案三:自定义只读包装器(推荐用于复杂场景)

class ReadOnlyList:
    def __init__(self, data):
        self._data = list(data)  # 深拷贝或只读引用,按需选择

    def __getitem__(self, i): return self._data[i]
    def __len__(self): return len(self._data)
    def __iter__(self): return iter(self._data)
    def __repr__(self): return f"ReadOnlyList({self._data!r})"

    # 显式禁用所有修改方法
    def __setitem__(self, i, v): raise TypeError("ReadOnlyList is immutable")
    def append(self, x): raise TypeError("ReadOnlyList is immutable")
    def pop(self, *a): raise TypeError("ReadOnlyList is immutable")

# 在描述符 __get__ 中返回 ReadOnlyList(raw)

✅ 总结与最佳实践

  • ✅ 初始化友好:通过 hasattr(instance, self._attr_name) 判断是否首次赋值,而非无条件拒绝 __set__;
  • ✅ 命名隔离:始终用 f"_{name}" 存储真实值,杜绝 descriptor 与实例属性名冲突;
  • ✅ 明确语义:ReadOnly 控制的是“属性是否可重新绑定”,不是“所指对象是否可变”;
  • ⚠️ 可变对象防护需额外设计:若需冻结内容,请在 __get__ 中返回不可变代理或包装器;
  • ? 调试提示:可通过 vars(instance) 查看实际存储的私有属性,验证描述符是否按预期工作。

遵循以上模式,你就能在大型项目中安全、统一地管理只读字段,兼顾代码简洁性与运行时安全性。

热门AI工具

更多
PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

豆包大模型

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

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

WorkBuddy

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

花生AI
花生AI Hot

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

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

更多
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