Python中如何使用dir自定义dir()行为？

林译川

2026-10-26 • 👁 0人浏览过

在 python 中，__dir__()方法允许自定义dir()函数的行为。通过重写__dir__()，你可以控制哪些属性和方法被展示：1)定义__dir__()方法返回一个字符串列表，表示希望展示的属性和方法；2)在实际项目中使用__dir__()可以简化api，隐藏内部细节，提升易用性；3)注意使用时可能影响依赖dir()的工具，且需避免过度使用以保持代码可理解性。在Python中，

__dir__()

方法是一个特殊的方法，它允许你自定义对象的

dir()

函数行为。

dir()

函数通常用于列出对象的所有属性和方法，但通过重写

__dir__()

方法，你可以控制哪些属性和方法会被显示出来。这对于创建更易于使用的API或隐藏内部实现细节非常有用。当我第一次接触到

__dir__()

方法时，我觉得它就像是给对象披上了一件隐形斗篷，让你可以根据需要展示或隐藏对象的某些部分。让我们来看看如何使用这个方法，并分享一些我在实际项目中使用它的经验。首先，我们需要知道，

__dir__()

方法应该返回一个字符串列表，这些字符串代表了你希望

dir()

函数展示的属性和方法。如果你不重写这个方法，Python会使用默认的

dir()

行为，这通常包括所有公共属性和方法。立即学习 “ Python免费学习笔记（深入） ”；来看看一个简单的示例：

class MyClass:
    def __init__(self):
        self.public_attr = "I'm public"
        self._private_attr = "I'm private"

    def public_method(self):
        return "This is a public method"

    def _private_method(self):
        return "This is a private method"

    def __dir__(self):
        return ['public_attr', 'public_method']

在这个例子中，我定义了一个

MyClass

类，并重写了

__dir__()

方法，使其只返回

public_attr

和

public_method

。这样，当你使用

dir()

函数时，你只会看到这两个属性和方法，而不会看到

_private_attr

和

_private_method

。 Python 3.14.3 微软官方的 Python 扩展，是 VS Code 安装量最高的扩展（209M+）。集成 IntelliSense（通过 Pylance）、调试（通过 Python Debugger）、代码检查、格式化、重构和单元测试等功能。支持 Jupyter Notebook、虚拟环境管理和多 Python 版本切换。下载在实际项目中，我曾经用

__dir__()

来简化一个复杂的API。我的工作涉及到一个大型的库，其中有很多内部方法和属性，这些对于普通用户来说并不需要知道。通过重写

__dir__()

方法，我能够隐藏这些内部细节，只展示那些对用户有用的部分。这不仅提高了API的易用性，也减少了用户的学习曲线。然而，使用

__dir__()

也有一些需要注意的地方。首先，它可能会影响到一些依赖

dir()

函数的工具或库，比如IDE的自动补全功能。如果你隐藏了一些属性或方法，这些工具可能无法正确地展示或使用它们。其次，过度使用

__dir__()

可能会使你的代码变得难以理解，因为它改变了Python的默认行为。在性能方面，重写

__dir__()

通常不会有显著的影响，因为它只是改变了展示的内容，而不影响实际的属性和方法的访问。然而，如果你的

__dir__()

方法很复杂，可能会稍微增加一点点开销。总的来说，

__dir__()

是一个强大的工具，可以帮助你更好地管理和展示对象的属性和方法。但在使用时，需要权衡其带来的便利和可能的副作用。通过合理的使用，你可以创建更加清晰、易用的API，同时保护你的内部实现细节。在实际应用中，我建议你结合使用

__dir__()

和Python的命名约定（如使用下划线前缀表示私有属性和方法）来创建一个清晰、一致的接口。通过这种方式，你不仅可以控制

dir()

的输出，还可以让你的代码更加符合Pythonic的风格。

相关文章