如何忽略传递给数据类的额外参数？

Question

我想创建一个config dataclass，以简化对特定环境变量的白名单和访问（os.environ['VAR_NAME']相对于而言，输入代码很麻烦config.VAR_NAME）。因此，我需要无视我的未使用的环境变量dataclass的__init__函数，但我不知道如何提取默认__init__为了与例如，一个函数，还包括将其包装*_为一体的论据之一。

import os
from dataclasses import dataclass

@dataclass
class Config:
    VAR_NAME_1: str
    VAR_NAME_2: str

config = Config(**os.environ)

运行这个给了我TypeError: __init__() got an unexpected keyword argument 'SOME_DEFAULT_ENV_VAR'。

Answer 1

我只想提供一个明确的__init__而不是使用自动生成的。循环体只设置可识别的值，忽略意外的值。

请注意，直到稍后才会抱怨没有默认值的缺失值。

@dataclass(init=False)
class Config:
    VAR_NAME_1: str
    VAR_NAME_2: str

    def __init__(self, **kwargs):
        names = set([f.name for f in dataclasses.fields(self)])
        for k, v in kwargs.items():
            if k in names:
                setattr(self, k, v)

或者，您可以将过滤后的环境传递给默认的Config.__init__.

field_names = set(f.name for f in dataclasses.fields(Config))
c = Config(**{k:v for k,v in os.environ.items() if k in field_names})

Answer 2

在将参数列表传递给构造函数之前对其进行清理可能是解决此问题的最佳方法。但我建议不要编写自己的__init__函数，因为数据类会__init__做一些其他方便的事情，而覆盖它们会使其失去作用。

另外，由于参数清除逻辑与类的行为紧密绑定并返回实例，因此将其放入可能是有道理的classmethod：

from dataclasses import dataclass
import inspect

@dataclass
class Config:
    var_1: str
    var_2: str

    @classmethod
    def from_dict(cls, env):      
        return cls(**{
            k: v for k, v in env.items() 
            if k in inspect.signature(cls).parameters
        })


# usage:
params = {'var_1': 'a', 'var_2': 'b', 'var_3': 'c'}
c = Config.from_dict(params)   # works without raising a TypeError 
print(c)
# prints: Config(var_1='a', var_2='b')

Answer 3

我结合使用了两个答案；setattr可能会成为性能杀手。当然，如果字典的数据类中没有某些记录，您需要为它们设置字段默认值。

from __future__ import annotations
from dataclasses import field, fields, dataclass

@dataclass()
class Record:
    name: str
    address: str
    zip: str = field(default=None)  # won't fail if dictionary doesn't have a zip key

    @classmethod
    def create_from_dict(cls, dict_) -> Record:
        class_fields = {f.name for f in fields(cls)}
        return Record(**{k: v for k, v in dict_.items() if k in class_fields})