python - 何时以及为何使用 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__这将变量放在 __init__ 中到一个字典(例如 {"client": "foo", "request": "bar"} )，而不是仅仅通过 self.client 来调用它们& self.request在其他方法中？我何时以及为什么应该使用 self.__dict__相反？

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)将是字符串 "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 的结构，该方法仍然有效。更改后，它可以通过继承在多个类之间共享，并且它为任何属性被 __init__ 接受为关键字参数的类返回可执行的 Python 代码。 .