VSCode中Python自定义dataclass装饰器的__init__类型提示失效问题

问题说明 #

自定义了一个模拟dataclasses.dataclass的装饰器@pyclass，内部直接调用原生dataclass方法：

from dataclasses import dataclass
def pyclass(cls=None):
    return dataclass(cls)

用该装饰器修饰的类（如TestPyClass），在VSCode中无法获得正确的__init__方法参数提示，仅显示__init__(*args, **kwargs)；但原生@dataclass修饰的类（如TestDataClass）能正常显示__init__(name: str)。实际运行逻辑正常，仅类型提示失效。

临时解决办法（Python 3.10及以下版本） #

通过typing_extensions库的dataclass_transform装饰器，告知类型检查器（如VSCode的Pylance）该自定义装饰器的行为与原生dataclass一致：

from dataclasses import dataclass
from typing_extensions import dataclass_transform

@dataclass_transform()
def pyclass(cls=None):
    return dataclass(cls)

若未安装依赖，执行以下命令安装：

pip install typing-extensions

Python 3.11+ 官方解决方案 #

Python 3.11通过PEP 681正式引入了dataclass_transform装饰器，无需额外安装依赖，直接从标准库typing导入使用即可：

from dataclasses import dataclass
from typing import dataclass_transform

@dataclass_transform()
def pyclass(cls=None):
    return dataclass(cls)

该方案让类型检查器能够正确识别自定义装饰器生成的类结构，自动推断出__init__方法的参数信息。

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