__getattr__ 与 __getattribute__ 之间的区别

Question

我试图了解何时使用__getattr__或__getattribute__ 。 文档提到__getattribute__适用于新式类。 什么是新式班级？

Answer 1

__getattr__和__getattribute__之间的一个主要区别是__getattr__仅在没有以通常的方式找到属性时才被调用。 这对于为缺少的属性实施回退很有用，并且可能是您想要的两个之一。

__getattribute__在查看对象的实际属性之前被调用，因此正确实现可能会很棘手。 您可以很容易地以无限递归结束。

新式类派生自object ，旧式类是 Python 2.x 中没有显式基类的类。 但是在__getattr__和__getattribute__之间进行选择时，旧式和新式类之间的区别并不是重要的。

你几乎肯定想要__getattr__ 。

Answer 2

让我们看一些__getattr__和__getattribute__魔术方法的简单示例。

__getattr__

每当您请求尚未定义的属性时，Python 都会调用__getattr__方法。 在以下示例中，我的类Count没有__getattr__方法。 现在在 main 中，当我尝试访问obj1.mymin和obj1.mymax属性时，一切正常。 但是当我尝试访问obj1.mycurrent属性时——Python 给了我AttributeError: 'Count' object has no attribute 'mycurrent'

class Count():
    def __init__(self,mymin,mymax):
        self.mymin=mymin
        self.mymax=mymax

obj1 = Count(1,10)
print(obj1.mymin)
print(obj1.mymax)
print(obj1.mycurrent)  --> AttributeError: 'Count' object has no attribute 'mycurrent'

现在我的类Count有__getattr__方法。 现在，当我尝试访问obj1.mycurrent属性时obj1.mycurrent返回我在__getattr__方法中实现的任何内容。 在我的示例中，每当我尝试调用一个不存在的属性时，python 都会创建该属性并将其设置为整数值 0。

class Count:
    def __init__(self,mymin,mymax):
        self.mymin=mymin
        self.mymax=mymax    

    def __getattr__(self, item):
        self.__dict__[item]=0
        return 0

obj1 = Count(1,10)
print(obj1.mymin)
print(obj1.mymax)
print(obj1.mycurrent1)

__getattribute__

现在让我们看看__getattribute__方法。 如果你的类中有__getattribute__方法，python 会为每个属性调用这个方法，不管它是否存在。 那么为什么我们需要__getattribute__方法呢？ 一个很好的理由是您可以阻止对属性的访问并使它们更安全，如以下示例所示。

每当有人尝试访问我的以子字符串'cur'开头的属性时，python 都会引发AttributeError异常。 否则它返回该属性。

class Count:

    def __init__(self,mymin,mymax):
        self.mymin=mymin
        self.mymax=mymax
        self.current=None
   
    def __getattribute__(self, item):
        if item.startswith('cur'):
            raise AttributeError
        return object.__getattribute__(self,item) 
        # or you can use ---return super().__getattribute__(item)

obj1 = Count(1,10)
print(obj1.mymin)
print(obj1.mymax)
print(obj1.current)

重要提示：为了避免__getattribute__方法中的无限递归，其实现应始终调用具有相同名称的基类方法来访问它需要的任何属性。 例如： object.__getattribute__(self, name)或super().__getattribute__(item)而不是self.__dict__[item]

重要的

如果您的类同时包含getattr和getattribute魔术方法，则首先调用__getattribute__ 。 但是如果__getattribute__引发AttributeError异常，则该异常将被忽略并调用__getattr__方法。 请参阅以下示例：

class Count(object):

    def __init__(self,mymin,mymax):
        self.mymin=mymin
        self.mymax=mymax
        self.current=None

    def __getattr__(self, item):
            self.__dict__[item]=0
            return 0

    def __getattribute__(self, item):
        if item.startswith('cur'):
            raise AttributeError
        return object.__getattribute__(self,item)
        # or you can use ---return super().__getattribute__(item)
        # note this class subclass object

obj1 = Count(1,10)
print(obj1.mymin)
print(obj1.mymax)
print(obj1.current)

Answer 3

这只是基于Ned Batchelder 解释的示例。

__getattr__示例：

class Foo(object):
    def __getattr__(self, attr):
        print "looking up", attr
        value = 42
        self.__dict__[attr] = value
        return value

f = Foo()
print f.x 
#output >>> looking up x 42

f.x = 3
print f.x 
#output >>> 3

print ('__getattr__ sets a default value if undefeined OR __getattr__ to define how to handle attributes that are not found')

如果相同的例子与__getattribute__使用，你会得到 >>> RuntimeError: maximum recursion depth exceeded while calling a Python object

Answer 4

新样式类继承自object ，或从另一个新样式类继承：

class SomeObject(object):
    pass

class SubObject(SomeObject):
    pass

旧式类不会：

class SomeObject:
    pass

这仅适用于 Python 2 - 在 Python 3 中，以上所有内容都将创建新样式的类。

请参阅9. 类（Python 教程）、 NewClassVsClassicClass和 Python 中旧式和新式类的区别是什么？ 详情。

Answer 5

新式类是将“对象”（直接或间接）子类化的类。 除了__init__之外，它们还有一个__new__类方法，并且具有更合理的低级行为。

通常，您会想要覆盖__getattr__ （如果您要覆盖任何一个），否则您将很难在您的方法中支持“self.foo”语法。

额外信息： http : //www.devx.com/opensource/Article/31482/0/page/4

Answer 6

• getattribute ：用于从实例中检索属性。 它通过使用点符号或 getattr() 内置函数捕获访问实例属性的每一次尝试。
• getattr ：当在对象中找不到属性时，作为最后一个资源执行。 您可以选择返回默认值或引发 AttributeError。

回到__getattribute__函数； 如果默认实现没有被覆盖； 执行该方法时会进行以下检查：

• 检查MRO链中的任何类中是否定义了同名的描述符（属性名）（方法对象解析）
• 然后查看实例的命名空间
• 然后查看类命名空间
• 然后进入每个基的命名空间等等。
• 最后，如果未找到，则默认实现调用实例的回退getattr () 方法，并引发 AttributeError 异常作为默认实现。

这是 object.__getattribute__ 方法的实际实现：

.. c:function:: PyObject* PyObject_GenericGetAttr(PyObject *o, PyObject *name) 通用属性 getter 函数，旨在放入类型对象的 tp_getattro 槽中。 它在对象的 MRO 中的类字典中查找描述符以及对象的 :attr:~object 中的属性。 dict （如果存在）。 如 :ref:descriptors 中所述，数据描述符优先于实例属性，而非数据描述符则不然。 否则，会引发 :exc:AttributeError 。

Answer 7

在阅读 Beazley & Jones PCB 时，我偶然发现了__getattr__一个明确且实用的用例，它有助于回答 OP 问题的“何时”部分。 从书中：

“ __getattr__()方法有点像属性查找的全能方法。如果代码试图访问不存在的属性，它就会被调用。” 我们从上面的答案中知道这一点，但在 PCB 配方 8.15 中，此功能用于实现委托设计模式。 如果对象 A 有一个属性对象 B，它实现了对象 A 想要委托给的许多方法，而不是重新定义对象 A 中的所有对象 B 的方法只是为了调用对象 B 的方法，定义一个__getattr__()方法如下：

def __getattr__(self, name):
    return getattr(self._b, name)

其中 _b 是对象 B 的对象 A 属性的名称。当对象 B 上定义的方法在对象 A 上调用时，将在查找链的末尾调用__getattr__方法。 这也会使代码更清晰，因为您没有定义仅用于委托给另一个对象的方法列表。

Answer 8

我发现没有人提到这种差异：

__getattribute__有一个默认实现，但__getattr__没有。

class A:
    pass
a = A()
a.__getattr__ # error
a.__getattribute__ # return a method-wrapper

这有一个明确的含义：因为__getattribute__有一个默认实现，而__getattr__没有，显然 python 鼓励用户实现__getattr__ 。