PyCharm中如何基于类已有方法类型提示定义IDE可识别的函数注解

核心问题根因：
静态类型检查器、IDE的类型提示引擎不会执行模块级的运行时函数调用，仅能解析可静态推导的字面类型、独立类型别名。原代码中typing.get_type_hints(...)属于运行时执行逻辑，静态分析阶段无法获取其返回值，因此不能被识别为有效类型。

实现方案 #

把需要复用的key类型抽成独立的静态可解析类型别名，所有关联的类属性、方法（包括get_key）、自定义字典类型都引用该别名。这种写法既保证了类中方法的类型提示和全局复用的类型完全绑定，后续修改类型时仅需改动一处，所有注解自动同步更新，IDE也可准确解析最终类型。

改造后代码（Python 3.10+ 写法） #

import typing
from typing import TypeAlias

# 统一定义key的类型，后续变更仅需修改这一行
KeyType: TypeAlias = str

class Foo:
    # 类构造参数、实例属性、方法注解全部引用KeyType，保证类型一致性
    def __init__(self, l_key: KeyType = "1234"):
        self.key: KeyType = l_key

    def get_key(self) -> KeyType:
        return self.key

# 自定义字典类型别名直接引用静态可解析的KeyType
DictOfFoos: TypeAlias = typing.Dict[KeyType, Foo]

def test_return() -> DictOfFoos:
    test: dict[KeyType, Foo] = {}
    test["123"] = Foo()
    return test

实际效果 #

• IDE会直接解析出test_return的返回类型为Dict[str, Foo]，完全符合预期显示要求。
• 后续若需要把key的类型从str调整为int，仅需修改KeyType对应的定义，Foo类的属性、get_key方法、字典类型、函数注解都会自动同步更新，IDE也会同步刷新类型提示，无需逐处修改其他代码。

旧版Python适配（Python 3.10 之前无TypeAlias） #

按照PEP8规范使用大驼峰命名类型别名，无需额外导入TypeAlias，静态检查器和IDE同样可以识别：

import typing

# 直接大写命名作为类型别名
KeyType = str
DictOfFoos = typing.Dict[KeyType, Foo]

class Foo:
    def __init__(self, l_key: KeyType = "1234"):
        self.key: KeyType = l_key

    def get_key(self) -> KeyType:
        return self.key

def test_return() -> DictOfFoos:
    test: dict[KeyType, Foo] = {}
    test["123"] = Foo()
    return test

注意事项 #

任何需要执行函数调用、运行阶段逻辑才能获取的类型值，都无法被静态分析阶段的IDE、类型检查器识别。直接将运行时函数调用的结果赋值给类型别名的写法，会被静态引擎判定为普通动态变量，无法推导实际类型，也就无法显示清晰的类型提示。

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