如何让Python Protocol兼容@property与直接属性实现的成员？

要让Moveable Protocol同时兼容用@property实现属性的类，以及直接定义实例属性的类，正确的做法是在Protocol中用@property装饰器声明属性，而不是直接指定属性类型。

正确的Protocol定义 #

from typing import Protocol, Tuple

class Moveable(Protocol):
    @property
    def position(self) -> Tuple[int, int]:
        ...

兼容两种实现方式 #

这个Protocol声明的是：只要类的实例拥有一个可读的position属性，类型为Tuple[int, int]，无论该属性是通过实例变量直接定义，还是通过@property包装实现，都能匹配这个Protocol。

1. 直接定义实例属性的类

class Enemy:
    def __init__(self):
        self.position: Tuple[int, int] = (0, 0)

2. 用@property实现的类

class Player:
    def __init__(self):
        self._position: Tuple[int, int] = (0, 0)
    
    @property
    def position(self) -> Tuple[int, int]:
        return self._position

验证兼容性 #

将两个类的实例赋值给Moveable类型变量，或者传入标注为Moveable的函数参数，类型检查器（如Pylance）不会再抛出错误：

def print_position(obj: Moveable) -> None:
    print(obj.position)

player = Player()
enemy = Enemy()

print_position(player)  # 无类型错误
print_position(enemy)   # 无类型错误

支持可写属性的扩展 #

如果你的场景需要position属性支持写入，可以在Protocol中同时定义setter：

class Moveable(Protocol):
    @property
    def position(self) -> Tuple[int, int]:
        ...
    
    @position.setter
    def position(self, value: Tuple[int, int]) -> None:
        ...

此时，类要么提供可读写的实例变量，要么实现带setter的@property，都能满足Protocol要求。

为什么之前的方法无效 #

• 直接在Protocol中写position: Tuple[int, int]时，类型检查器会将其视为实例变量，而@property本质是方法包装的属性，二者在类型系统中被视为不同的实现，因此会触发不兼容错误。
• 使用Union尝试合并类型的思路不成立，因为类型检查器不会将实例属性和property对象视为可互换的类型，而Protocol的@property声明是从行为契约的角度定义，而非具体实现，因此能统一两种场景。

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