在Doctest中使用@dataclass装饰器定义类报错，该如何解决？

问题原因 #

1. "unexpected EOF while parsing" 语法错误 #

Doctest模拟Python交互式环境解析代码，对多行代码格式要求严苛：

• 装饰器（如@dataclass）与后续类定义必须用续行标记...开头，类内字段需保持正确缩进。
• 若缩进错误或遗漏续行标记，解析器无法识别完整的类定义，会提前触发EOF解析错误。

2. TypeError 实例调用错误 #

如果手动定义类替代@dataclass，常见触发TypeError的场景：

• 未实现__init__方法，实例化时无法传入参数。
• __init__方法的参数数量、顺序与调用时不匹配。
• 类实例缺少目标函数需要访问的属性（如未在__init__中赋值对应字段）。

解决办法 #

方法一：在Doctest中正确使用@dataclass #

严格遵循交互式语法的续行标记与缩进要求：

def my_func(obj):
    """
    >>> from dataclasses import dataclass
    >>> @dataclass
    ... class Temp:
    ...     x: int
    ...     y: str
    ...
    >>> t = Temp(1, "test")
    >>> my_func(t)
    5
    """
    return obj.x + len(obj.y)

注意：类定义的最后一行（字段行）后，直接接下一个>>>块即可，无需额外的...。

方法二：手动定义类并实现完整的__init__ #

若无法使用装饰器，手动实现初始化逻辑，保证实例参数与属性匹配：

def my_func(obj):
    """
    >>> class Temp:
    ...     def __init__(self, x, y):
    ...         self.x = x
    ...         self.y = y
    ...
    >>> t = Temp(1, "test")
    >>> my_func(t)
    5
    """
    return obj.x + len(obj.y)

关键注意点 #

• Doctest中所有非>>>开头的多行代码，必须用...作为前缀，且缩进与代码块逻辑层级一致。
• 无论用装饰器还是手动定义类，都要确保类实例的属性与目标函数的访问逻辑匹配，避免属性缺失导致的错误。

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