python - 何时以及为什么应该使用 attr.Factory？

Question

何时以及为什么要使用attr.ib(default=attr.Factory(list))over attr.ib(default=[])？

从文档中我看到工厂用于生成新值，如果您使用带有输入的 lambda 表达式，这很有意义；但是，如果您只是生成一个空列表，我不明白为什么要使用它。

我在这里想念什么？

Answer 1

您希望避免使用可变对象作为默认值。如果您使用attr.ib(default=[])，则生成的是__init__使用该列表对象作为关键字参数默认值的方法：

def __init__(self, foo=[]):
    self.foo = foo

参数的默认值在定义时创建一次。每次调用该方法时都不会重新评估它们。然后在所有实例之间共享对该对象的任何突变。请参阅“Least Astonishment”和可变默认参数。

然而，使用该attr.Factory()方法，默认设置为哨兵，当参数保留为哨兵值时，函数本身就是该值，然后替换为调用工厂的结果。这相当于：

def __init__(self, foo=None):
    if foo is None:
        foo = []
    self.foo = foo

所以现在每个实例都创建了一个新的列表对象。

演示差异的快速演示：

>>> import attr
>>> @attr.s
... class Demo:
...     foo = attr.ib(default=[])
...     bar = attr.ib(default=attr.Factory(list))
...
>>> d1 = Demo()
>>> d1.foo, d1.bar
([], [])
>>> d1.foo.append('d1'), d1.bar.append('d1')
(None, None)
>>> d1.foo, d1.bar
(['d1'], ['d1'])
>>> d2 = Demo()
>>> d2.foo, d2.bar
(['d1'], [])

因为demo.foo正在使用共享列表对象，所以对其所做的更改d1.foo在任何其他实例下都是可见的，立即可见。

当我们使用inspect.getargspec()查看Demo.__init__方法时，我们会看到原因：

>>> import inspect
>>> inspect.getargspec(Demo.__init__)
ArgSpec(args=['self', 'foo', 'bar'], varargs=None, keywords=None, defaults=(['d1'], NOTHING))

的默认值foo是相同的列表对象，附加的'd1'字符串仍然存在。bar设置为一个哨兵对象（这里使用attr.NOTHING; 一个值，它可以在Demo(bar=None)不变成列表对象的情况下使用）：

>>> print(inspect.getsource(Demo.__init__))
def __init__(self, foo=attr_dict['foo'].default, bar=NOTHING):
    self.foo = foo
    if bar is not NOTHING:
        self.bar = bar
    else:
        self.bar = __attr_factory_bar()