带有**kwargs（星号）的python3数据类

Question

目前我像这样使用了 DTO（数据传输对象）。

class Test1:
    def __init__(self, 
        user_id: int = None,
        body: str = None):
        self.user_id = user_id
        self.body = body

示例代码很小，但是当对象规模越来越大时，我必须定义每个变量。

在深入研究的同时，发现python 3.7支持 dataclass

下面的代码是 DTO 使用的数据类。

from dataclasses import dataclass


@dataclass
class Test2:
    user_id: int
    body: str

在这种情况下，如何允许传递更多未定义为的参数class Test2？

如果我使用Test1，这很容易。只需添加**kwargs(asterisk)到__init__

class Test1:
    def __init__(self, 
        user_id: int = None,
        body: str = None,
        **kwargs):
        self.user_id = user_id
        self.body = body

但是使用数据类，找不到任何方法来实现它。

这里有什么解决办法吗？

谢谢。

---

编辑

class Test1:
    def __init__(self,
        user_id: str = None, 
        body: str = None):
        self.user_id = user_id
        self.body = body

if __name__ == '__main__':
    temp = {'user_id': 'hide', 'body': 'body test'}
    t1 = Test1(**temp)
    print(t1.__dict__)

结果 ： {'user_id': 'hide', 'body': 'body test'}

如您所知，我想插入字典类型的数据 -> **temp

在数据类中使用星号的原因是相同的。

我必须将字典类型传递给类 init。

这里有什么想法吗？

Answer 1

数据类的基本用例是提供一个将参数映射到属性的容器。如果您有未知参数，则在创建类时无法知道各自的属性。

如果您在初始化期间知道哪些参数是未知的，则可以通过手动将它们发送到 catch-all 属性来解决这个问题：

from dataclasses import dataclass, field


@dataclass
class Container:
    user_id: int
    body: str
    meta: field(default_factory=dict)


# usage:
obligatory_args = {'user_id': 1, 'body': 'foo'}
other_args = {'bar': 'baz', 'amount': 10}
c = Container(**obligatory_args, meta=other_args)
print(c.meta['bar'])  # prints: 'baz'

但是在这种情况下，您仍然需要查看字典，并且无法按名称访问参数，即c.bar不起作用。

如果您关心按名称访问属性，或者在初始化期间无法区分已知参数和未知参数，那么您最后的不重写__init__（这几乎违背了使用的目的dataclasses）的方法是编写@classmethod：

from dataclasses import dataclass
from typing import ClassVar


@dataclass
class Container:
    user_id: int
    body: str

    @classmethod
    def from_kwargs(cls, **kwargs):
        # identify the constructor's signature
        cls_fields = {
            name for
            name, f in cls.__dataclass_fields__.items() if
            f.type != ClassVar and getattr(f.type, "__origin__", None) != ClassVar
        }

        # split the kwargs into native ones and new ones
        native_args, new_args = {}, {}
        for name, val in kwargs.items():
            if name in cls_fields:
                native_args[name] = val
            else:
                new_args[name] = val

        # use the native ones to create the class ...
        ret = cls(**native_args)

        # ... and add the new ones by hand
        for new_name, new_val in new_args.items():
            setattr(ret, new_name, new_val)
        return ret

用法：

params = {'user_id': 1, 'body': 'foo', 'bar': 'baz', 'amount': 10}
Container(**params)  # still doesn't work, raises a TypeError 
c = Container.from_kwargs(**params)
print(c.bar)  # prints: 'baz'

Answer 2

Dataclass 仅依赖于该__init__方法，因此您可以自由地在该__new__方法中更改您的类。

from dataclasses import dataclass


@dataclass
class Container:
    user_id: int
    body: str

    def __new__(cls, *args, **kwargs):
        try:
            initializer = cls.__initializer
        except AttributeError:
            # Store the original init on the class in a different place
            cls.__initializer = initializer = cls.__init__
            # replace init with something harmless
            cls.__init__ = lambda *a, **k: None

        # code from adapted from Arne
        added_args = {}
        for name in list(kwargs.keys()):
            if name not in cls.__annotations__:
                added_args[name] = kwargs.pop(name)

        ret = object.__new__(cls)
        initializer(ret, **kwargs)
        # ... and add the new ones by hand
        for new_name, new_val in added_args.items():
            setattr(ret, new_name, new_val)

        return ret


if __name__ == "__main__":
    params = {'user_id': 1, 'body': 'foo', 'bar': 'baz', 'amount': 10}
    c = Container(**params)
    print(c.bar)  # prints: 'baz'
    print(c.body)  # prints: 'baz'`

Answer 3

这是我使用的一个巧妙的变体。

from dataclasses import dataclass, field
from typing import Optional, Dict


@dataclass
class MyDataclass:
    data1: Optional[str] = None
    data2: Optional[Dict] = None
    data3: Optional[Dict] = None

    kwargs: field(default_factory=dict) = None

    def __post_init__(self):
        [setattr(self, k, v) for k, v in self.kwargs.items()]

其工作原理如下：

>>> data = MyDataclass(data1="data1", kwargs={"test": 1, "test2": 2})
>>> data.test
1
>>> data.test2
2

但请注意，数据类似乎不知道它具有这些新属性：

>>> from dataclasses import asdict
>>> asdict(data)
{'data1': 'data1', 'data2': None, 'data3': None, 'kwargs': {'test': 1, 'test2': 2}}

这意味着必须知道密钥。这适用于我的用例，也可能适用于其他用例。