如何使用Python的__dir__方法自定义类实例的属性补全列表?

夜杰姑娘_2152

夜杰姑娘_2152

2026-07-23

385人浏览

原创

__dir__ 方法仅控制 dir() 输出,不影响 ide 补全;补全依赖静态分析(如 __dict__、__annotations__),而非运行时 __dir__;需配合 __getattr__ 等确保属性真实可访问才有效。

如何使用python的__dir__方法自定义类实例的属性补全列表?

__dir__ 方法确实能控制 dir() 返回的内容,但要注意:它**不直接影响 IDE 或 REPL 的补全行为**——那些工具大多依赖静态分析或 __dict__,而非运行时调用 __dir__。想让补全“看起来有效”,得配合实际属性存在或动态代理。

为什么重写 __dir__ 后补全没反应?

多数编辑器(VS Code、PyCharm)在编辑时不会执行你的 __dir__,而是扫描类定义、__annotations__、__dict__ 和已知的魔术方法。即使你返回了 ['foo', 'bar'],如果实例没有对应属性,补全也不会显示它们。

  • IDE 补全靠的是“静态可推断性”,不是运行时 dir() 结果
  • __dir__ 主要影响交互式环境(如 IPython)中手动敲 dir(obj) 的输出
  • 若属性是动态生成的(比如通过 __getattr__),必须确保 __dir__ 返回的名称也真实可访问,否则补全会误导人

怎样让 __dir__ 真正有用?

让它反映真实可用的属性,尤其配合 __getattr__ 实现动态属性时:

Li Python Sec Check
Li Python Sec Check

Python 安全规范检查工具:基于 CloudBase 规范、腾讯安全指南,LLM 智能分析(默认禁用,优先本地执行)

下载
class Config:
    def __init__(self, data):
        self._data = data
<pre class="brush:python;toolbar:false;">def __getattr__(self, name):
    if name in self._data:
        return self._data[name]
    raise AttributeError(f"'Config' object has no attribute '{name}'")

def __dir__(self):
    # 合并内置属性 + 动态键
    return sorted(set(super().__dir__()) | set(self._data.keys()))

  • super().__dir__() 保留默认方法和属性(如 __class__、__init__)
  • 用 set 去重,避免重复项干扰补全列表
  • 返回 list,不能是生成器或元组——dir() 要求返回序列

哪些场景下 __dir__ 会被真正调用?

主要出现在交互式调试和文档生成中:

  • IPython / Jupyter 中敲 obj.<tab></tab> 有时会触发(取决于后端配置)
  • help(obj) 会用到 dir(obj) 的结果来筛选展示内容
  • 某些自动化文档工具(如 Sphinx 的 autodoc)可能读取 __dir__ 来决定列出哪些成员
  • 单元测试里用 assert 'x' in dir(obj) 检查接口可见性

真正影响补全的,还是让属性“物理存在”——要么直接赋值到 self.x,要么用 @property,要么配合 __getattr__ + __dir__ 保持一致。否则,__dir__ 只是个好看的幻觉。

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

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4024

7

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

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

2023.07.31

1629

3

python教程
python教程

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

2023.08.03

23237

23

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

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

2023.08.04

2847

5

python eval
python eval

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

2023.08.04

2887

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2243

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程