防止在 __init__ 之外创建新属性

Question

我希望能够创建一个类（在 Python 中），一旦用 __init__ 初始化，不接受新属性，但接受现有属性的修改。我可以看到几种 hack-ish 方法可以做到这一点，例如使用 __setattr__ 方法

def __setattr__(self, attribute, value):
    if not attribute in self.__dict__:
        print "Cannot set %s" % attribute
    else:
        self.__dict__[attribute] = value

，然后直接在 __init__ 内部编辑 __dict__ ，但我想知道是否有“正确”的方法来做到这一点？

Answer 1

我不会直接使用 __dict__ ，但您可以添加一个函数来显式“冻结”实例：

class FrozenClass(object):
    __isfrozen = False
    def __setattr__(self, key, value):
        if self.__isfrozen and not hasattr(self, key):
            raise TypeError( "%r is a frozen class" % self )
        object.__setattr__(self, key, value)

    def _freeze(self):
        self.__isfrozen = True

class Test(FrozenClass):
    def __init__(self):
        self.x = 42#
        self.y = 2**3

        self._freeze() # no new attributes after this point.

a,b = Test(), Test()
a.x = 10
b.z = 10 # fails

Answer 2

插槽是可行的方法：

Pythonic 方法是使用插槽而不是使用 __setattr__。虽然它可以解决问题，但不会带来任何性能改进。对象的属性存储在字典“__dict__”中；这就是为什么您可以动态地将属性添加到我们迄今为止创建的类的对象中的原因。使用字典来存储属性非常方便，但对于只有少量实例变量的对象来说可能意味着空间的浪费。

插槽是解决空间消耗问题的好方法。插槽不是提供允许动态向对象添加属性的动态字典，而是提供静态结构，在创建实例后禁止添加。

当我们设计类时，我们可以使用插槽来阻止动态创建属性。要定义槽，您必须定义一个名为 __slots__ 的列表。该列表必须包含您想要使用的所有属性。我们在下面的类中演示了这一点，其中槽列表仅包含属性“val”的名称。

class S(object):

    __slots__ = ['val']

    def __init__(self, v):
        self.val = v


x = S(42)
print(x.val)

x.new = "not possible"

=>它无法创建属性“new”：

42 
Traceback (most recent call last):
  File "slots_ex.py", line 12, in <module>
    x.new = "not possible"
AttributeError: 'S' object has no attribute 'new'

注释：

1. 自 Python 3.3 以来，优化空间消耗的优势不再那么令人印象深刻。在 Python 3.3 中 密钥共享 字典用于存储对象。实例的属性能够在彼此之间共享其内部存储的一部分，即存储密钥及其相应散列的部分。这有助于减少程序的内存消耗，因为程序会创建许多非内置类型的实例。但仍然是避免动态创建属性的方法。

2. 使用插槽也有其自身的成本。它将破坏序列化（例如pickle）。它还将打破多重继承。一个类不能从多个类继承，这些类要么定义槽，要么具有用 C 代码定义的实例布局（如列表、元组或 int）。

Answer 3

如果有人有兴趣使用装饰器来做到这一点，这里有一个可行的解决方案：

from functools import wraps

def froze_it(cls):
    cls.__frozen = False

    def frozensetattr(self, key, value):
        if self.__frozen and not hasattr(self, key):
            print("Class {} is frozen. Cannot set {} = {}"
                  .format(cls.__name__, key, value))
        else:
            object.__setattr__(self, key, value)

    def init_decorator(func):
        @wraps(func)
        def wrapper(self, *args, **kwargs):
            func(self, *args, **kwargs)
            self.__frozen = True
        return wrapper

    cls.__setattr__ = frozensetattr
    cls.__init__ = init_decorator(cls.__init__)

    return cls

使用起来非常简单：

@froze_it 
class Foo(object):
    def __init__(self):
        self.bar = 10

foo = Foo()
foo.bar = 42
foo.foobar = "no way"

结果：

>>> Class Foo is frozen. Cannot set foobar = no way

Answer 4

实际上，您不需要 __setattr__，您需要 __slots__。将 __slots__ = ('foo', 'bar', 'baz') 添加到类主体中，Python 将确保任何实例上都只有 foo、bar 和 baz。但请阅读文档列出的警告！

Answer 5

我非常喜欢使用装饰器的解决方案，因为它很容易在项目中的许多类中使用它，并且每个类的添加量最少。但它不适用于继承。
所以这是我的版本：它只覆盖 __setattr__ 函数 - 如果该属性不存在并且调用者函数不是 __init__，它会打印一条错误消息。

import inspect                                                                                                                             

def froze_it(cls):                                                                                                                      

    def frozensetattr(self, key, value):                                                                                                   
        if not hasattr(self, key) and inspect.stack()[1][3] != "__init__":                                                                 
            print("Class {} is frozen. Cannot set {} = {}"                                                                                 
                  .format(cls.__name__, key, value))                                                                                       
        else:                                                                                                                              
            self.__dict__[key] = value                                                                                                     

    cls.__setattr__ = frozensetattr                                                                                                        
    return cls                                                                                                                             

@froze_it                                                                                                                                  
class A:                                                                                                                                   
    def __init__(self):                                                                                                                    
        self._a = 0                                                                                                                        

a = A()                                                                                                                                    
a._a = 1                                                                                                                                   
a._b = 2 # error

Answer 6

正确的方法是重写__setattr__。这就是它的用途。

Answer 7

@dataclass(slots=True) Nirvana (Python 3.10)

我爱上了这个@dataclass thing:

main.py

from dataclasses import dataclass

@dataclass(slots=True)
class C:
    n: int
    s: str

c = C(n=1, s='one')
assert c.n == 1
assert c.s == 'one'
c.n == 2
c.s == 'two'
c.asdf = 2

结果：

Traceback (most recent call last):
  File "/home/ciro/main.py", line 15, in <module>
    c.asdf = 2
AttributeError: 'C' object has no attribute 'asdf'

注意 @dataclass 仅需要我们定义我们的使用键入注释一次属性

n: int
s: str

，然后不重复 我们免费获得：

• def __init__(n, s):
      自我.n = n
      self.s = s
  

• __slots__ = ['n', 's']

本例中未显示的其他免费内容：

• __str__
• __eq__: 通过属性比较对象实例是否相等
• __hash__ 如果您还使用 frozen=True： 自定义类型的对象作为字典键

在Python 3.10.7、Ubuntu 22.10上测试。

Answer 8

这是我想出的方法，不需要 _frozen 属性或方法来在 init 中 freeze() 。

在 init 期间，我只是将所有类属性添加到实例中。

我喜欢这个，因为没有 _frozen、freeze()，并且 _frozen 也不会出现在 vars(instance) 输出中。

class MetaModel(type):
    def __setattr__(self, name, value):
        raise AttributeError("Model classes do not accept arbitrary attributes")

class Model(object):
    __metaclass__ = MetaModel

    # init will take all CLASS attributes, and add them as SELF/INSTANCE attributes
    def __init__(self):
        for k, v in self.__class__.__dict__.iteritems():
            if not k.startswith("_"):
                self.__setattr__(k, v)

    # setattr, won't allow any attributes to be set on the SELF/INSTANCE that don't already exist
    def __setattr__(self, name, value):
        if not hasattr(self, name):
            raise AttributeError("Model instances do not accept arbitrary attributes")
        else:
            object.__setattr__(self, name, value)


# Example using            
class Dog(Model):
    name = ''
    kind = 'canine'

d, e = Dog(), Dog()
print vars(d)
print vars(e)
e.junk = 'stuff' # fails

Answer 9

这个怎么样：

class A():
    __allowed_attr=('_x', '_y')

    def __init__(self,x=0,y=0):
        self._x=x
        self._y=y

    def __setattr__(self,attribute,value):
        if not attribute in self.__class__.__allowed_attr:
            raise AttributeError
        else:
            super().__setattr__(attribute,value)

Answer 10

我喜欢乔亨·里策尔的《冰雪奇缘》。不方便的是打印 Class.__dict 时会出现 isfrozen 变量
我通过创建授权属性列表（类似于插槽）来解决这个问题：

class Frozen(object):
    __List = []
    def __setattr__(self, key, value):
        setIsOK = False
        for item in self.__List:
            if key == item:
                setIsOK = True

        if setIsOK == True:
            object.__setattr__(self, key, value)
        else:
            raise TypeError( "%r has no attributes %r" % (self, key) )

class Test(Frozen):
    _Frozen__List = ["attr1","attr2"]
    def __init__(self):
        self.attr1   =  1
        self.attr2   =  1

Answer 11

Jochen Ritzel 的 FrozenClass 很酷，但是每次初始化类时调用 _frozen() 就不那么酷了（并且您需要冒忘记它的风险）。我添加了一个 __init_slots__ 函数：

class FrozenClass(object):
    __isfrozen = False
    def _freeze(self):
        self.__isfrozen = True
    def __init_slots__(self, slots):
        for key in slots:
            object.__setattr__(self, key, None)
        self._freeze()
    def __setattr__(self, key, value):
        if self.__isfrozen and not hasattr(self, key):
            raise TypeError( "%r is a frozen class" % self )
        object.__setattr__(self, key, value)
class Test(FrozenClass):
    def __init__(self):
        self.__init_slots__(["x", "y"])
        self.x = 42#
        self.y = 2**3


a,b = Test(), Test()
a.x = 10
b.z = 10 # fails

Answer 12

没有一个答案提到覆盖 __setattr__ 对性能的影响，这在创建许多小对象时可能是一个问题。 （并且__slots__将是高性能解决方案，但限制pickle/继承）。

所以我想出了这个变体，它在初始化后安装我们较慢的settatr：

class FrozenClass:

    def freeze(self):
        def frozen_setattr(self, key, value):
            if not hasattr(self, key):
                raise TypeError("Cannot set {}: {} is a frozen class".format(key, self))
            object.__setattr__(self, key, value)
        self.__setattr__ = frozen_setattr

class Foo(FrozenClass): ...

如果你不想在 __init__ 末尾调用 freeze，如果继承是一个问题，或者如果您不希望它出现在 vars() 中，那么它也可以进行调整：例如，这里是基于 pystrict 答案的装饰器版本：

import functools
def strict(cls):
    cls._x_setter = getattr(cls, "__setattr__", object.__setattr__)
    cls._x_init = cls.__init__
    @functools.wraps(cls.__init__)
    def wrapper(self, *args, **kwargs):
        cls._x_init(self, *args, **kwargs)
        def frozen_setattr(self, key, value):
            if not hasattr(self, key):
                raise TypeError("Class %s is frozen. Cannot set '%s'." % (cls.__name__, key))
            cls._x_setter(self, key, value)
        cls.__setattr__ = frozen_setattr
    cls.__init__ = wrapper
    return cls

@strict
class Foo: ...

Answer 13

我写了 pystrict 作为这个问题的解决方案。它太大了，无法将所有代码粘贴到 stackoverflow 中。

pystrict 是一个 pypi 可安装的装饰器，可以与类一起使用来冻结它们。这里的许多解决方案都不能正确支持继承。

如果 __slots__ 不适合您（由于继承问题），这是一个不错的选择。

自述文件中有一个示例，说明了为什么即使您的项目上运行了 mypy 和 pylint，也需要这样的装饰器：

pip install pystrict

然后只需使用 @strict 装饰器：

from pystrict import strict

@strict
class Blah
  def __init__(self):
     self.attr = 1