PyCharm对类装饰器修饰属性未触发类型检查的问题及解决方法

一、原因分析 #

• PyCharm和mypy采用两套完全不同的类型检查逻辑，PyCharm的内置检查引擎在处理自定义泛型装饰器这类复杂场景时，类型追踪能力不如mypy精准。
• 你基于cached_property自定义的result_property装饰器，PyCharm可能无法正确识别其装饰后属性的具体类型，导致没发现prop_int的int类型与func_str要求的str参数不匹配。
• 2023.2.3版本的PyCharm社区版，在高级类型检查场景下本身存在功能局限，对泛型装饰器的支持完善度不如专业版。

二、让PyCharm检测到错误的修改方案 #

1. 显式指定泛型参数 #

给result_property标注明确的泛型参数，直接告知PyCharm属性的返回类型：

from functools import cached_property
from typing import Generic, TypeVar

T = TypeVar('T')

class result_property(cached_property, Generic[T]):
    def __get__(self, instance, owner=None) -> T:
        return super().__get__(instance, owner)

class Foo:
    @result_property[int]  # 明确标注该属性返回int类型
    def prop_int(self) -> int:
        return 42

def func_str(s: str) -> None:
    pass

foo = Foo()
func_str(foo.prop_int)  # 此时PyCharm应能检测到类型不匹配

2. 补全装饰器的类型注解 #

把result_property的__get__方法类型注解写得更清晰，帮助PyCharm识别类型：

from functools import cached_property
from typing import Generic, TypeVar, Any, Optional, Type

T = TypeVar('T')

class result_property(cached_property, Generic[T]):
    def __get__(self, instance: Optional[Any], owner: Optional[Type[Any]] = None) -> T:
        value = super().__get__(instance, owner)
        return value

3. 开启PyCharm严格类型检查 #

调整PyCharm的设置，加强类型检查力度：

• 打开设置/偏好设置 -> 编辑器 -> 检查 -> Python -> 类型检查器
• 勾选不兼容的函数调用类型、不兼容的赋值类型等选项，将检查级别设为错误或警告

4. 换用PyCharm更好支持的装饰器 #

如果上述方法无效，可以尝试使用Python 3.8+内置的typing.cached_property，PyCharm对内置类型的支持更到位：

from typing import cached_property

class Foo:
    @cached_property
    def prop_int(self) -> int:
        return 42

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