如何为来自未声明基类的@property添加PEP-484类型提示？

问题背景 #

使用Mixin时，我们常需要为那些来自未显式声明基类的@property添加PEP-484类型提示。此前的常规做法是在Mixin中直接声明属性类型，以此标注继承体系中预期存在的属性：

class SomeMixin:
    name: str
    logger: Logger
    def __init__(self):
        super().__init__()

这种写法在logger是普通实例属性时可行，但当logger是其他类提供的@property时（如下方的Base类），类型检查器（如pyright）会抛出不兼容覆盖错误：

from typing import Logger

class Base:
    @property
    def logger(self) -> Logger:
        return Logger("foo")

class Derived(SomeMixin, Base):
    pass

pyright报错信息：

Base classes for class "Derived" define variable "logger" in incompatible wayPylancereportIncompatibleVariableOverride
foo.py(17, 9): Base class "Base" provides type "property", which is overridden
foo.py(9, 5): Base class "SomeMixin" overrides with type "Logger"

如果把Mixin中的logger标注为property类型，又会导致logger被推断为Any类型，失去类型校验的作用。

解决方案 #

方案1：使用property[Logger]类型标注（Python 3.10+） #

直接在Mixin中将logger的类型标注为property[Logger]（Python 3.9及以下可使用typing.Property），这样类型检查器能识别这是一个返回Logger类型的@property，既不会报覆盖错误，也能保留类型校验：

from typing import Logger, Property

class SomeMixin:
    name: str
    logger: Property[Logger]  # Python 3.10+可简写为 property[Logger]
    def __init__(self):
        super().__init__()

class Base:
    @property
    def logger(self) -> Logger:
        return Logger("foo")

class Derived(SomeMixin, Base):
    pass

方案2：通过Protocol定义依赖接口 #

定义Protocol来描述Mixin所需的属性/方法约束，让Mixin继承这些Protocol。类型检查器会自动验证使用Mixin的类是否满足这些约束，同时保留完整的类型提示：

from typing import Protocol, Logger

# 定义Protocol，描述必须具备的@property
class HasLogger(Protocol):
    @property
    def logger(self) -> Logger: ...

# 定义另一个Protocol描述name属性
class HasName(Protocol):
    name: str

# Mixin继承Protocol，声明依赖
class SomeMixin(HasLogger, HasName):
    def __init__(self):
        super().__init__()
    
    def do_something(self):
        # 使用self.name和self.logger时会有正确的类型提示
        print(f"Hello {self.name}")
        self.logger.info("Executing do_something")

class Base:
    @property
    def logger(self) -> Logger:
        return Logger("foo")
    name: str = "test"

# Derived继承Mixin和Base，类型检查器会验证Base满足Protocol约束
class Derived(SomeMixin, Base):
    pass

这种方案更符合面向接口编程的思想，也能更清晰地表达Mixin的依赖要求。

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