如何捕获Python dataclass实例化时的参数传入顺序？

问题背景 #

使用Python的dataclass装饰器时，生成的__init__方法参数签名是按类定义时的字段顺序排列的，但实例化时如果用关键字参数传入（比如Person(name='Jack', age=10)），默认无法直接获取传入参数的顺序。需求是：

• 不手动编写__init__方法，保留dataclass的自动生成优势
• 保留类型提示
• 能按实例化时的参数传入顺序将对象序列化为JSON

解决方案 #

可以通过自定义基类包装dataclass生成的__init__方法，在不破坏原有逻辑的前提下捕获参数传入顺序：

1. 定义带参数顺序追踪的基类

from dataclasses import dataclass, fields
from inspect import signature

class OrderedDataclass:
    def __init_subclass__(cls):
        original_init = cls.__init__
        sig = signature(original_init)
        # 获取dataclass的字段参数名（排除self）
        param_names = list(sig.parameters.keys())[1:]

        def wrapped_init(self, *args, **kwargs):
            # 记录参数顺序：先处理位置参数，再处理关键字参数
            init_order = []
            # 位置参数对应定义顺序的前N个字段
            init_order.extend(param_names[:len(args)])
            # 关键字参数保留传入顺序
            init_order.extend(kwargs.keys())
            # 存入实例属性，后续可直接调用
            self._init_order = tuple(init_order)
            # 调用原有的__init__方法
            original_init(self, *args, **kwargs)

        cls.__init__ = wrapped_init

2. 定义你的dataclass并继承基类

@dataclass
class Person(OrderedDataclass):
    age: int
    name: str = 'John'

# 测试不同调用方式
p1 = Person(name='Jack', age=10)
print(p1._init_order)  # 输出: ('name', 'age')

p2 = Person(20, name='Alice')
print(p2._init_order)  # 输出: ('age', 'name')

p3 = Person(30)
print(p3._init_order)  # 输出: ('age',)

3. 按传入顺序序列化JSON

自定义JSON编码器，利用_init_order属性控制序列化顺序：

import json

class OrderedDataclassEncoder(json.JSONEncoder):
    def default(self, obj):
        if hasattr(obj, '_init_order'):
            # 按传入顺序构建字典
            result = {}
            # 先添加传入的参数
            for key in obj._init_order:
                result[key] = getattr(obj, key)
            # 补充未传入的默认字段（可选，如果需要完整序列化所有字段）
            for field in fields(obj):
                if field.name not in result:
                    result[field.name] = getattr(obj, field.name)
            return result
        return super().default(obj)

# 序列化测试
p = Person(name='Jack', age=10)
print(json.dumps(p, cls=OrderedDataclassEncoder))
# 输出: {"name": "Jack", "age": 10}

注意事项 #

• 该方案依赖Python 3.7+，因为从3.7开始Python会保留关键字参数的传入顺序（PEP 468）
• Python不允许同时用位置参数和关键字参数传入同一个字段，因此无需处理重复键的情况
• 如果不需要包含默认字段，可以去掉编码器中补充默认值的逻辑

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