何时以及为什么使用 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(client="foo", request="bar")。

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

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

提前谢谢你。

Answer 1

__dict__ 保存类中的所有变量。参加以下课程：

class A():
    def __init__(self, foo):
        self.foo = foo

    def new_var(self, bar):
        self.bar = bar

那么在这种情况下，请注意：

a = A('var1')
print(a.__dict__) # {'foo': 'var1'}

b = A('var1')
b.new_var('var2')
b.foobar = 'var3'
print(b.__dict__) # {'foo': 'var1', 'bar': 'var2', 'foobar': 'var3'}

在您的情况下，您可以选择或。 __dict__ 是在调用它的当前实例中获取属于该类的所有变量的好方法。你可以查看__dict__here上的文档。

Answer 2

几乎所有时候，您都不应该使用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)"，这很方便，因为它显示了实例的整个状态，而且字符串本身就是创建一个具有相同状态的实例。

但是上面的实现有几个问题：如果类的属性发生变化，我们必须改变它，它不会为子类的实例提供有用的结果，我们必须为不同的类编写许多类似的代码不同的属性。如果我们改用__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 代码。如果Foo 的结构发生变化，这种通用的__repr__ 方法仍然可以工作，它可以通过继承在多个类之间共享，并且它为任何属性被__init__ 接受为关键字参数的类返回可执行的Python 代码。