Python 属性查找：深入理解__getattribute__与__getattr__

目录

一、__getattribute__方法详解

1.1 基本概念

1.2 示例分析

1.3 注意事项

二、__getattr__方法详解

2.1 基本概念

2.2 示例分析

2.3 注意事项

三、__getattribute__与__getattr__的区别对比

3.1 调用时机

3.2 应用场景

3.3 性能影响

四、属性查找顺序

属性查找是一个基础而又关键的操作，当我们使用点号（.）来访问对象的属性时，比如obj.attr，Python 会在对象及其所属类的层次结构中进行搜索，以找到对应的属性值。在这个过程中，__getattribute__和__getattr__这两个特殊方法起着至关重要的作用。理解它们的工作机制和区别，对于编写高效、健壮的 Python 代码至关重要。本文将深入探讨这两个方法，帮助大家掌握它们的用法。

一、__getattribute__方法详解

1.1 基本概念

__getattribute__是 Python 中的一个特殊方法，属于新式类（在 Python 2.2 及以上版本中，所有类默认都是新式类）。

当我们尝试访问对象的任何属性时，无论该属性是否存在，Python 都会首先调用对象的__getattribute__方法。这个方法的定义如下：

def __getattribute__(self, name):
    pass

其中，self是对象自身的引用，name是要访问的属性名称，它是一个字符串。例如，当执行obj.attr时，name的值就是'attr'。

1.2 示例分析

class MyClass:
    def __init__(self):
        self.attribute = "Hello, World!"

    def __getattribute__(self, name):
        print(f"正在访问属性: {name}")
        return super().__getattribute__(name)


obj = MyClass()
print(obj.attribute)

在上述代码中，我们定义了一个MyClass类，并在其中重写了__getattribute__方法。当创建obj实例并访问其attribute属性时，__getattribute__方法会首先被调用。它打印出正在访问的属性名称，然后通过super().__getattribute__(name)调用父类（即object类）的__getattribute__方法来获取实际的属性值。这样做是为了避免在__getattribute__方法内部出现无限递归调用。如果我们在__getattribute__方法中直接使用self.name来获取属性值，会再次触发__getattribute__方法，从而导致递归错误。

1.3 注意事项

在重写__getattribute__方法时，一定要注意避免递归错误。如前面提到的，不要在方法内部使用self.attr这种方式来获取属性值，而应该使用super().__getattribute__(attr)。另外，__getattribute__方法无论属性是否存在都会被调用，这意味着即使访问一个不存在的属性，也会进入这个方法。如果在__getattribute__方法中没有找到对应的属性，并且没有抛出AttributeError异常，那么__getattr__方法将不会被调用。

二、__getattr__方法详解

2.1 基本概念

__getattr__同样是 Python 中的特殊方法。

与__getattribute__不同，__getattr__只有在常规的属性查找（在对象的__dict__和类的__dict__及其父类的__dict__中查找）失败，并且对象所属的类定义了__getattr__方法时才会被调用。它的定义如下：

def __getattr__(self, name):
    pass

self和name的含义与__getattribute__方法中的相同。当 Python 在对象及其类的层次结构中找不到指定的属性时，就会调用__getattr__方法，尝试通过这个方法来获取属性值或者提供默认行为。

2.2 示例分析

class MyClass:
    def __init__(self):
        self.attribute = "Hello, World!"

    def __getattr__(self, name):
        if name == "nonexistent_attribute":
            return "这个属性不存在，但我可以返回一个默认值"
        raise AttributeError(f"'MyClass' object has no attribute '{name}'")


obj = MyClass()
print(obj.attribute)
print(obj.nonexistent_attribute)

在这个例子中，我们定义了MyClass类并实现了__getattr__方法。当访问obj的attribute属性时，由于该属性存在于对象的__dict__中，所以__getattr__方法不会被调用，直接返回属性值。而当访问nonexistent_attribute属性时，常规属性查找失败，Python 会调用__getattr__方法。在__getattr__方法中，我们检查属性名称，如果是nonexistent_attribute，则返回一个默认值；否则，抛出AttributeError异常，表明对象确实没有该属性。

2.3 注意事项

__getattr__方法主要用于处理不存在的属性访问。在实现这个方法时，要确保对于确实不存在的属性抛出AttributeError异常，这样可以保持 Python 属性查找机制的一致性，也便于其他开发者理解和调试代码。另外，__getattr__方法只有在常规属性查找失败时才会被调用，这与__getattribute__方法的调用时机有明显区别。

三、__getattribute__与__getattr__的区别对比

3.1 调用时机

• __getattribute__：在每次访问对象属性时都会被调用，无论该属性是否存在于对象及其类的层次结构中。

• __getattr__：只有在常规属性查找（在对象的__dict__和类的__dict__及其父类的__dict__中查找）失败后才会被调用。可以说__getattr__是属性查找的 “后备方案”。

3.2 应用场景

• __getattribute__：适用于需要对所有属性访问进行统一拦截和处理的场景，比如实现属性访问日志记录、权限检查等。例如，我们可以在__getattribute__方法中记录每次属性访问的时间、访问者信息等。

• __getattr__：主要用于为不存在的属性提供默认行为，例如实现懒加载（只有在真正访问某个属性时才去加载相关资源）、代理访问（通过一个代理对象来访问其他对象的属性）等。比如，在一个数据库连接对象中，可以使用__getattr__方法，当访问某个表名属性时，如果该表对象尚未加载，就自动进行加载操作。

3.3 性能影响

由于__getattribute__方法在每次属性访问时都会被调用，所以它对性能的影响相对较大。尤其是在一个对象有大量属性访问操作的情况下，如果在__getattribute__方法中进行了复杂的逻辑处理，可能会导致性能瓶颈。而__getattr__方法只有在属性查找失败时才会被调用，因此在大多数情况下，它对性能的影响较小。所以，在选择使用哪个方法时，除了考虑功能需求，也要考虑性能因素。例如，在一个性能要求较高且大部分属性都存在的场景中，应尽量避免在__getattribute__方法中添加过多复杂逻辑；而在一个属性访问不确定性较大，且需要为不存在的属性提供默认行为的场景中，__getattr__方法是更好的选择。

四、属性查找顺序

当我们执行obj.attr这样的属性访问操作时，Python 的属性查找顺序如下：

1. 调用__getattribute__方法：无论属性是否存在，首先调用对象的__getattribute__方法。如果在这个方法中通过super().__getattribute__(name)成功获取到属性值，则返回该值，查找过程结束。如果在__getattribute__方法中抛出了AttributeError异常（例如，属性确实不存在或者在__getattribute__方法内部逻辑判断该属性不应该被访问），则进入下一步。
2. 检查数据描述符：如果属性是类中的数据描述符（即实现了__get__、__set__和__delete__方法的描述符），则调用数据描述符的__get__方法获取属性值，查找过程结束。
3. 查找实例属性：在对象的__dict__中查找属性。如果找到，则返回该属性值，查找过程结束。
4. 检查类属性和非数据描述符：在类的__dict__及其父类的__dict__中查找属性。如果找到的属性是一个非数据描述符（只实现了__get__方法的描述符），则调用其__get__方法获取属性值；如果找到的不是描述符属性，则直接返回该属性值，查找过程结束。
5. 调用__getattr__方法：如果上述所有步骤都没有找到属性，并且对象所属的类定义了__getattr__方法，则调用__getattr__方法。如果__getattr__方法返回了一个值，则返回该值；如果__getattr__方法抛出了AttributeError异常，则最终抛出该异常，表示属性不存在。

为了更清晰地展示这个过程，我们可以用表格形式总结如下：

理解这个属性查找顺序，对于深入掌握__getattribute__和__getattr__的工作原理以及它们在属性查找过程中的作用至关重要。

通过本文的介绍，相信大家对 Python 中的__getattribute__和__getattr__方法有了更深入的理解。它们虽然都是与属性查找相关的特殊方法，但在调用时机、应用场景和对性能的影响等方面存在明显区别。在实际编程中，我们应根据具体需求合理选择使用这两个方法，以编写出高效、优雅的 Python 代码。