首页 > 解决方案 > 具有可变和不可变属性的数据类样式对象?

问题描述

我一直在使用从文件中动态加载属性名称的数据类,但我无法找到一种方法来创建“冻结”和“非冻结”属性。我相信数据类只允许您将所有属性设置为冻结或非冻结。

到目前为止,我创建了一个冻结的数据类并添加了一个可变类作为我可以随时更改的属性之一,但我对这种方法的可读性不太满意。

人们是否会推荐另一个 pythonic 数据类,而无需实现具有设置可变/不可变属性的类的能力?

import dataclasses

class ModifiableConfig:
    """There is stuff in here but you get the picture."""
    ...

config_dataclass = dataclasses.make_dataclass(
    'c',
    [(x, type(x), v) for x, v in config.items()] + [('var', object, ModifiableConfig())],
    frozen=True
)

但是,我更喜欢能够选择哪些属性是冻结的,哪些不是。不再需要向数据类添加额外的类。它可能看起来像这样:

config_dataclass_modifiable = dataclasses.make_dataclass(
            'c', [(x, type(x), v, True if 'modifiable' in x else False) for x, v in config.items()])

请注意“如果 x else False 中的 'modifiable' 为真”,我并不是说我最终会这样做,但希望这有助于更好地理解我的问题。

标签: pythonimmutabilitypython-3.7mutablepython-dataclasses

解决方案


调整属性处理的常规方法是编写一个自定义__setattr__方法,该方法允许您覆盖属性分配的默认行为。不幸的是,该方法也是数据类挂钩以强制执行逻辑的方法,它有效地锁定了函数,不会在您尝试触摸它时立即frozen抛出异常。TypeError: Cannot overwrite attribute __setattr__ in class ModifiableConfig

因此,我看不到您的问题没有直接简单的解决方案。在我看来,您将类的可变部分委派给内部对象或字典的方法一点也不差或非 Pythonic,但是如果您可以frozen从需求列表中删除并且只想要一个部分可变的数据类,您可以尝试在此处使用此 bootleg-semi-frozen 配方,该配方使用您可以打开dataclass的标志更新装饰器以获得您描述的行为:semi

from dataclasses import dataclass as dc
from traceback import format_stack

def dataclass(_cls=None, *, init=True, repr=True, eq=True, order=False,
              unsafe_hash=False, frozen=False, semi=False):

    def wrap(cls):
        # sanity checks for new kw
        if semi:
            if frozen:
                raise AttributeError("Either semi or frozen, not both.")
            if cls.__setattr__ != cls.mro()[1].__setattr__:
                raise AttributeError("No touching setattr when using semi!")

        # run original dataclass decorator
        dc(cls, init=init, repr=repr, eq=eq, order=order,
           unsafe_hash=unsafe_hash, frozen=frozen)

        # add semi-frozen logic
        if semi:
            def __setattr__(self, key, value):
                if key in self.__slots__:
                    caller = format_stack()[-2].rsplit('in ', 1)[1].strip()
                    if caller != '__init__':
                        raise TypeError(f"Attribute '{key}' is immutable!")
                object.__setattr__(self, key, value)
            cls.__setattr__ = __setattr__

        return cls

    # Handle being called with or without parens
    if _cls is None:
        return wrap
    return wrap(_cls)

我在这里很简短,不会在这里解决一些潜在的边缘情况。有更好的方法来处理包装,以便内部更加一致,但它会使这个已经很复杂的片段更加复杂。

有了这个新的dataclass装饰器,您可以像这样使用它来定义一个具有一些不可变属性和一些可变属性的数据类:

>>> @dataclass(semi=True)
... class Foo:
...     # put immutable attributes and __dict__ into slots 
...     __slots__ = ('__dict__', 'x', 'y')
...     x: int
...     y: int
...     z: int
...
>>> f = Foo(1, 2, 3)
>>> f        # prints Foo(x=1, y=2, z=3)
>>> f.z = 4  # will work
>>> f.x = 4  # raises TypeError: attribute 'x' is immutable!

您不必使用__slots__将可变部分与不可变部分分开,但出于一些原因(例如作为不属于默认数据类的元属性repr)并且对我来说感觉很直观,它很方便。


推荐阅读