Python 特殊方法 __dir__() 对象的属性和方法列表

Python的 __dir__() 是一个特殊方法，用于自定义对象的 dir() 行为。dir() 函数用于获取对象的属性和方法列表。当调用 dir(obj) 时，实际上会调用 obj.__dir__() 方法。

逻辑

你可以在自定义类中实现 object.__dir__(self) 方法，以控制 dir() 返回的结果。通常情况下，__dir__() 应该返回一个属性名称的列表，但也可以返回其他可迭代对象，如元组或集合。

此方法会在针对相应对象调用 dir() 时被调用。 返回值必须为一个可迭代对象。 dir() 会把返回的可迭代对象转换为列表并对其排序。

示例

简单的示例：

class MyClass:
    def __init__(self):
        self.foo = 42
        self.bar = 'hello'

    def __dir__(self):
        return ['foo', 'bar', 'baz']  # 仅返回这些属性

obj = MyClass()

print(dir(obj))  # 输出 ['foo', 'bar', 'baz']

示例中，MyClass 类覆盖了 __dir__() 方法，使得 dir(obj) 仅返回了 foo、bar 和 baz 这三个属性名。

用途

__dir__() 方法的主要用途是自定义对象的属性和方法的展示行为。具体来说，它有以下几个用途：

• 过滤属性和方法：通过重写 __dir__() 方法，你可以控制在调用 dir() 函数时返回的属性和方法列表。这使得你可以隐藏一些内部实现细节或者只暴露部分属性和方法给外部使用。
• 动态生成属性列表：有时候属性的列表是动态的，可能依赖于对象的状态或者其他条件。通过实现 __dir__() 方法，你可以动态生成属性列表，确保它们始终是最新的。
• 提供友好的属性提示：在交互式环境中（如IPython或Jupyter Notebook）使用 Tab 键补全属性时，会调用 __dir__() 方法来获取属性列表。通过定制 __dir__() 方法，你可以提供更友好和更有用的属性提示。
• 控制对象的可见性：通过 __dir__() 方法，你可以控制对象的属性和方法哪些是可见的、哪些是隐藏的。这对于实现类似于私有成员的功能非常有用。

因些，__dir__() 方法允许你定制对象在使用 dir() 函数时的行为，使得属性和方法的展示更加灵活和符合实际需求。

参考

• https://docs.python.org/zh-cn/3/reference/datamodel.html#object.__dir__

更新时间：2024-03-04 10:44:08 标签：python 特殊方法 属性