动态只读属性:在 Python 实例中实现按需补全的只读字段

星磊大大_5172

星磊大大_5172

2026-10-29

873人浏览

原创

动态只读属性:在 Python 实例中实现按需补全的只读字段

本文介绍如何为 python 实例创建真正动态、实例专属的只读属性,使其支持 ide/repl 的 tab 补全(仅显示该实例实际拥有的键),同时禁止修改、保持字典后端只读语义。

本文介绍如何为 python 实例创建真正动态、实例专属的只读属性,使其支持 ide/repl 的 tab 补全(仅显示该实例实际拥有的键),同时禁止修改、保持字典后端只读语义。

在 Python 中,若希望对象支持 obj.attr 语法访问内部字典中的值,并让这些属性表现为实例级、只读、可补全,单纯使用描述符(descriptor)会因类属性共享导致跨实例污染(如 a1.x 和 a2.y 的属性混杂出现在同一补全列表中)。而仅靠 __getattr__ 又无法被 dir() 或 Tab 补全识别。真正的解决方案在于协同重写三个特殊方法:__getattr__、__setattr__ 和关键的 __dir__,并辅以 types.MappingProxyType 保障只读契约。

以下是推荐实现:

from types import MappingProxyType
from typing import Any, List, Dict, Union

class DynamicReadOnly:
    def __init__(self, keys: List[str], values: List[Any]) -> None:
        # 使用普通 dict 存储,便于初始化和运行时访问
        self._d: Dict[str, Any] = dict(zip(keys, values))

    @property
    def d(self) -> MappingProxyType:
        """公开只读视图,防止外部意外修改底层字典"""
        return MappingProxyType(self._d)

    def __getattr__(self, name: str) -> Any:
        """当常规属性查找失败时,尝试从 _d 中获取"""
        try:
            return self._d[name]
        except KeyError:
            raise AttributeError(f"'{self.__class__.__name__}' object has no attribute '{name}'")

    def __setattr__(self, name: str, value: Any) -> None:
        """禁止对已存在于 _d 中的键赋值;允许设置其他新属性(如 _cache)"""
        # 避免在 __init__ 中触发此逻辑(此时 _d 尚未设置)
        if hasattr(self, '_d') and name in self._d:
            raise TypeError(f"Cannot assign to read-only attribute '{name}'")
        super().__setattr__(name, value)

    def __dir__(self) -> List[str]:
        """定制 dir() 输出,使 Tab 补全仅显示当前实例有效的动态属性"""
        # 获取父类 dir 结果(含方法、内置属性等)
        attrs = super().__dir__()
        # 移除内部字典名 _d(避免暴露实现细节)
        if '_d' in attrs:
            attrs.remove('_d')
        # 动态注入当前实例所有键作为可补全属性
        attrs.extend(self._d.keys())
        # 去重并排序,提升可读性(非必需但推荐)
        return sorted(set(attrs))

✅ 使用示例:

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
a = DynamicReadOnly(['x', 'y'], [10, 'hello'])
b = DynamicReadOnly(['z', 'count'], [3.14, 42])

print(a.x)      # → 10
print(b.z)      # → 3.14
print(a.d)      # → mappingproxy({'x': 10, 'y': 'hello'})

# ✅ 补全友好:在 IPython/Jupyter 中输入 `a.` + Tab,仅显示 x、y、d 等;
#              输入 `b.` + Tab,仅显示 z、count、d —— 完全隔离!

# ❌ 写保护生效:
# a.x = 99       # → TypeError: Cannot assign to read-only attribute 'x'
# b.count = 0    # → TypeError: Cannot assign to read-only attribute 'count'

# ✅ 允许新增非 _d 键的属性(如缓存、配置):
a._cache = {'computed': True}  # ✅ 合法

⚠️ 注意事项:

  • __dir__ 是补全功能的核心——多数 IDE(VS Code、PyCharm)和交互式环境(IPython、Jupyter)依赖它生成建议列表;
  • MappingProxyType 不仅提供只读视图,还防止 obj.d.clear() 或 obj.d.update(...) 等误操作;
  • __setattr__ 中通过 hasattr(self, '_d') 判断是否已完成初始化,避免 __init__ 过程中对 _d 自身赋值被拦截;
  • 若需完全禁止新增任意属性(即实现“封闭实例”),可添加 __slots__ = ('_d',),但会牺牲灵活性(无法动态加 _cache 等辅助属性)。

这种模式正是 pandas DataFrame 列访问(如 df.column_name)背后的原理之一:不预定义属性,而靠 __getattr__ + __dir__ 实现轻量、精准、可扩展的动态接口。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1831

4

python能做什么
python能做什么

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

2023.07.25

4884

7

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

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

2023.07.31

1789

3

python教程
python教程

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

2023.08.03

29137

23

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

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

2023.08.04

3487

5

python eval
python eval

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

2023.08.04

3487

5

scratch和python区别
scratch和python区别

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

2023.08.11

1223

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2703

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习