何时以及为何使用 self.__dict__ 而不是 self.variable

Question

我试图了解一些使用下面这个类的代码结构：

class Base(object):

    def __init__(self, **kwargs):
        self.client = kwargs.get('client')
        self.request = kwargs.get('request')
    ...

    def to_dict(self):
        data = dict()

        for key in iter(self.__dict__): # <------------------------ this
            if key in ('client', 'request'):
                continue

            value = self.__dict__[key]
            if value is not None:
                if hasattr(value, 'to_dict'):
                    data[key] = value.to_dict()
                else:
                    data[key] = value
        return data

好的，所以我知道它获取传递给 Base 类的键值参数，例如Base(client="foo", request="bar").

我的困惑是为什么它使用self.__dict__which 将变量内部__init__转换为 dict （例如{"client": "foo", "request": "bar"}）而不是仅通过self.client&self.request在其他方法中调用它们，我做错了什么吗？何时以及为什么我应该使用它self.__dict__？

请问我在哪里可以找到使用/理解这些 dunder 方法的可靠指南？

先感谢您。

Answer 1

几乎所有的时间，你都不应该使用self.__dict__.

如果您正在访问类似 的属性self.client，即属性名称是已知且固定的，那么两者之间的唯一区别self.__dict__['client']是，如果实例中缺少该属性，后者将不会在类上查找该属性。很少有任何理由这样做，但差异如下所示：

>>> class A:
...     b = 3 # class attribute, not an instance attribute
... 
>>> A.b # the class has this attribute
3
>>> a = A()
>>> a.b # the instance doesn't have this attribute, fallback to the class
3
>>> a.__dict__['b'] # the instance doesn't have this attribute, but no fallback
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'b'

主要用例的self.__dict__是，当你不希望访问一个固定的已知属性名称。在几乎所有代码中，您总是知道要访问哪个属性；如果您确实需要使用未知字符串动态查找某些内容，您应该自己创建一个字典，并self.that_dict[key]使用self.__dict__[key].

因此，您真正应该使用的唯一时间__dict__是编写需要工作的代码，而不管实例可能具有哪些属性；即，您特别想要即使更改类的结构或其属性名称也能工作的代码，或者可以跨具有不同结构的多个类工作的代码。我将在下面展示一个例子。

该__repr__方法

该__repr__方法旨在返回表示实例的字符串，以便程序员在使用 REPL 时方便。出于调试/测试目的，此字符串通常包含有关对象状态的信息。这是实现它的常用方法：

class Foo:
    def __init__(self, foo, bar, baz):
        self.foo = foo
        self.bar = bar
        self.baz = baz

    def __repr__(self):
        return 'Foo({!r}, {!r}, {!r})'.format(self.foo, self.bar, self.baz)

这意味着如果你编写obj = Foo(1, 'y', True)创建一个实例，那么repr(obj)将是 string "Foo(1, 'y', True)"，这很方便，因为它显示了实例的整个状态，而且字符串本身是 Python 代码，它创建了一个具有相同状态的实例。

但是上面的实现存在一些问题：如果类的属性发生变化，我们必须更改它，它不会为子类的实例提供有用的结果，并且我们必须为具有不同属性的不同类编写大量类似的代码。如果我们__dict__改用，我们可以解决所有这些问题：

    def __repr__(self):
        return '{}({})'.format(
            self.__class__.__name__,
            ', '.join('{}={!r}'.format(k, v) for k, v in self.__dict__.items())
        )

现在repr(obj)将是Foo(foo=1, bar='y', baz=True)，它也显示了实例的整个状态，也是可执行的 Python 代码。__repr__如果结构发生Foo变化，这种通用方法仍然有效，它可以通过继承在多个类之间共享，并且它返回任何类的可执行 Python 代码，该类的属性被接受为关键字参数__init__。