VS Code中Python单例装饰器导致类型提示失效的解决求助

问题背景 #

使用以下Singleton类装饰器修饰x_DB类后，原本正常的类型提示完全失效，尝试过更新Pylance、切换Jedi、升级typing包等操作都无法解决：

单例装饰器代码 #

class Singleton:
    def __init__(self, decorated: Callable) -> None: 
        self._decorated = decorated
        self.initialized = False
    def Instance(self) -> Callable:
        """
        Returns the singleton instance. Upon its first call, it creates a
        new instance of the decorated class and calls its `__init__` method.
        On all subsequent calls, the already created instance is returned.
        """
        try:
            return self._instance
        except AttributeError:
            self._instance = self._decorated()
            return self._instance
    def Initialize(self, *args, **kwargs) -> Callable:
        if self.initialized:
            raise Exception("Singleton already initialized")
        self._instance = self._decorated(*args, **kwargs)
        self.initialized = True
        return self._instance
    def __call__(self) -> Callable: 
        if not self.initialized:
            raise Exception("Singleton not initialized")
        return self._instance
    def __instancecheck__(self, inst):
        return isinstance(inst, self._decorated)

被装饰的类代码 #

@Singleton
class x_DB(DBHandler):
    def __init__(self, db_loc:Path):
        self.check_db_exists(db_loc)
        super().__init__(db_loc)
        self.query = self.session.query
        self.check_tables_exist()
        self.check_for_global()
    def check_db_exists(self, path:Path) -> bool:
        if not path.exists():
            logger.debug(f"DB: {path} does not exist, creating..")
            path.touch()
            logger.success(f"Successfully created {path}")
        return True

有效修复方案 #

1. 给装饰器添加泛型类型注解 #

核心问题是原装饰器返回的Singleton实例类型无法关联到被装饰的类，类型检查器不知道它具备被装饰类的属性和方法。通过泛型让装饰器的返回类型与被装饰类绑定：

from typing import Callable, TypeVar, Generic

T = TypeVar('T')

class Singleton(Generic[T]):
    def __init__(self, decorated: Callable[..., T]) -> None: 
        self._decorated = decorated
        self.initialized = False
        self._instance: T | None = None  # 明确实例类型

    def Instance(self) -> T:
        if self._instance is None:
            self._instance = self._decorated()
        return self._instance

    def Initialize(self, *args, **kwargs) -> T:
        if self.initialized:
            raise Exception("Singleton already initialized")
        self._instance = self._decorated(*args, **kwargs)
        self.initialized = True
        return self._instance

    def __call__(self) -> T: 
        if not self.initialized or self._instance is None:
            raise Exception("Singleton not initialized")
        return self._instance

    def __instancecheck__(self, inst) -> bool:
        return isinstance(inst, self._decorated)

2. 添加__getattr__方法转发属性访问 #

让Singleton实例把所有未定义的属性/方法请求转发给内部的单例实例，这样类型检查器能识别到被装饰类的成员：

在原Singleton类中添加以下方法：

def __getattr__(self, name: str):
    # 转发属性到内部实例
    if hasattr(self._instance, name):
        return getattr(self._instance, name)
    raise AttributeError(f"'Singleton' object has no attribute '{name}'")

注意：需要确保_instance已经初始化后再使用，或者在__getattr__里加初始化判断。

3. 改用函数式泛型单例装饰器 #

函数式的实现更简洁，且对类型检查更友好：

from typing import Callable, TypeVar, Any

T = TypeVar('T')

def singleton(cls: Callable[..., T]) -> Callable[..., T]:
    instances: dict[Callable[..., T], T] = {}
    def wrapper(*args: Any, **kwargs: Any) -> T:
        if cls not in instances:
            instances[cls] = cls(*args, **kwargs)
        return instances[cls]
    return wrapper

使用方式不变：

@singleton
class x_DB(DBHandler):
    # ... 类实现不变

4. 临时类型断言（快速 workaround） #

如果不想修改装饰器代码，可以在获取实例时用类型断言明确类型：

from pathlib import Path

# 获取实例时指定类型
db: x_DB = x_DB.Initialize(Path("./test.db"))
# 或者
db: x_DB = x_DB.Instance()

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