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

如何用 Python 描述符实现真正只读的属性(含不可变容器防护)

星涛大大_8199

星涛大大_8199

发布时间:2026-11-08 20:53:25

|

469人浏览过

|

来源于php中文网

原创

如何用 Python 描述符实现真正只读的属性(含不可变容器防护)

本文详解如何通过自定义描述符正确实现只读属性,解决初始化冲突与底层数据(如列表)被意外修改的问题,并提供可直接复用的安全 readonly 描述符实现。

本文详解如何通过自定义描述符正确实现只读属性,解决初始化冲突与底层数据(如列表)被意外修改的问题,并提供可直接复用的安全 readonly 描述符实现。

在 Python 中,@property 是实现只读属性的常用方式,但当项目规模扩大、需统一管理多处只读逻辑时,重复编写 @property 显得冗余且难以维护。此时,描述符(descriptor) 提供了更优雅、可复用的解决方案。然而,直接将 @property 逻辑平移至描述符常会踩坑——最典型的是:在 __init__ 中赋值触发 __set__,导致初始化失败。

✅ 正确的只读描述符设计

关键在于区分 首次初始化赋值 与 后续非法修改。错误做法是无条件禁止所有 __set__ 调用;正确做法是:仅当属性已存在时才拒绝写入。同时,为避免描述符与实例属性同名冲突(因描述符协议优先级高于实例字典),应将底层存储名设为私有变体(如 _name)。

以下是经过验证的 ReadOnly 描述符实现:

Python Hardener
Python Hardener

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

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

    def __set_name__(self, owner, name):
        # 存储私有属性名,避免与描述符自身冲突
        self._name = f"_{name}"

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

    def __set__(self, instance, value):
        # 仅当属性已存在时禁止修改
        if hasattr(instance, self._name):
            raise AttributeError(f"Cannot modify read-only attribute '{self._name[1:]}'")
        setattr(instance, self._name, value)

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

✅ 应用示例:支持初始化与运行时保护

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 < self.n - 1:
            self.top += 1
            self.S[self.top] = x  # ✅ 允许修改列表元素(业务逻辑需要)

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

s.push(10)
print(s.top)  # 0
print(s.S[0]) # 10

# ❌ 以下操作均抛出 AttributeError:
# s.S = [1, 2]      # 已存在 _S,禁止重赋值
# s.top = 5         # 已存在 _top,禁止重赋值
# del s.n           # 禁止删除

⚠️ 关于“深层只读”:列表/字典等可变对象的防护

描述符只能控制属性引用本身的读写(即 s.S = ...),无法阻止对可变对象内部状态的修改(如 s.S[0] = 1)。这是 Python 的语言特性,非缺陷。若需完全冻结内容,有以下方案:

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

  • 方案1:返回不可变视图(推荐)
    在 __get__ 中返回 tuple() 或 frozenset()(适用于只读场景):

    def __get__(self, instance, owner):
        if instance is None:
            return self
        val = getattr(instance, self._name, None)
        if isinstance(val, list):
            return tuple(val)  # 返回元组,禁止修改
        return val
  • 方案2:使用 types.MappingProxyType 或自定义只读包装器
    对字典类属性更适用,例如:

    from types import MappingProxyType
    self._config = {'a': 1}
    self.config = MappingProxyType(self._config)  # 外部只读,内部仍可改
  • 方案3:深度冻结(谨慎使用)
    利用 copy.deepcopy + types.SimpleNamespace 或第三方库(如 immutable),但会牺牲性能与调试友好性,一般不建议。

✅ 总结

  • ✅ ReadOnly 描述符必须通过 __set_name__ 设置私有存储名(如 _{name}),避免协议冲突;
  • ✅ __set__ 应检查 hasattr(instance, self._name) 而非直接拒绝,确保 __init__ 可正常工作;
  • ✅ 描述符天然不控制可变对象内部状态——这是 Python 的设计哲学,需按需选择封装策略;
  • ✅ 生产环境中,建议为 ReadOnly 增加类型提示与文档字符串,提升可维护性。

该方案已在中大型项目中稳定使用,兼顾简洁性、安全性与可扩展性。

热门AI工具

更多
讯飞智作

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

豆包大模型

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

DeepSeek

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

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

WorkBuddy

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

蛙蛙写作

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

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