Python dataclasses：如何使用asdict()忽略默认值？

原生的dataclasses.asdict()并没有ignore_default参数，要实现只保留非默认值字段的需求，可以用以下两种方法：

方法一：自定义过滤函数 #

先调用原生asdict()拿到完整字典，再对比类字段的默认值，过滤掉匹配默认值的项：

from dataclasses import dataclass, asdict, fields

@dataclass
class A:
    a: str
    b: bool = True

def asdict_ignore_defaults(obj):
    # 提取类中带默认值的字段及其默认值
    default_fields = {f.name: f.default for f in fields(obj) if f.default is not fields(obj).default}
    full_dict = asdict(obj)
    # 只保留非默认值的字段
    return {key: val for key, val in full_dict.items() if key not in default_fields or val != default_fields[key]}

# 测试验证
a = A("1")
result = asdict_ignore_defaults(a)
assert {"a": "1"} == result

方法二：封装支持参数的自定义asdict #

如果想让调用方式更贴近原生asdict，可以封装一个带ignore_default参数的函数：

from dataclasses import dataclass, asdict, fields

def asdict_custom(obj, ignore_default=False):
    base_dict = asdict(obj)
    if not ignore_default:
        return base_dict
    
    # 构建字段-默认值映射表
    default_map = {}
    for field in fields(obj):
        # 跳过用default_factory生成默认值的字段（如需支持可额外处理）
        if field.default is not field.default_factory:
            default_map[field.name] = field.default
    
    # 过滤默认值字段
    return {k: v for k, v in base_dict.items() if k not in default_map or v != default_map[k]}

# 测试验证
@dataclass
class A:
    a: str
    b: bool = True

a = A("1")
result = asdict_custom(a, ignore_default=True)
assert {"a": "1"} == result

额外说明 #

• 如果字段用了default_factory（比如列表、字典这类可变类型的默认值），需要额外处理：调用default_factory()获取默认值后再对比。
• 对于可变类型的字段值，直接用!=对比可能不准确，需要根据需求实现深对比逻辑。

内容的提问来源于stack exchange，提问作者Nadav