如何让JetBrains PyCharm为注解数据类自动补全字段名？

我正在开发一个将多类型协议转换为Python的程序，用注解数据类表示各类消息，示例代码如下：

from dataclasses import dataclass, field

@dataclass()
class TriggerEvent:
    sequence_num: int = 0
    num_sub_messages: int = 0
    carryover: dict[bytes, Ledger] = field(default_factory=lambda: {}) # Ledger是另一个类似定义的数据类
    qrs: list[int] = field(default_factory=lambda: [])
    trs: list[int] = field(default_factory=lambda: [])
    tss: list[int] = field(default_factory=lambda: [])
    last_tss: list[int] = field(default_factory=lambda: []) 
    observed: bool = False
    sub_messages: list[SubTriggerEvents] = field(default_factory=lambda: []) # SubTriggerEvents是另一个类似定义的数据类

这是相对简单的示例，部分消息类型包含数十个字段。实际代码的主循环结构如下：

next_event = get_next_event()
if type(next_event) is TriggerEvent:
   ....

我希望在上述if语句块内输入next_event.时，或是方法签名带有类型提示时，JetBrains PyCharm的代码补全能自动列出对应字段。请问有什么方法可以实现这一需求？

以下几种方法可以让PyCharm正确识别数据类类型，实现代码补全：

1. 改用isinstance做类型检查 #

PyCharm的类型推断对isinstance的支持远优于type()判断，修改条件语句如下：

next_event = get_next_event()
if isinstance(next_event, TriggerEvent):
    # 输入next_event.即可触发字段补全
    next_event.sequence_num

这种方式无需额外操作，PyCharm会自动识别if块内变量的具体类型，直接提供对应字段的补全。

2. 给get_next_event()添加返回类型提示 #

如果get_next_event()是自定义函数，为其添加联合类型的返回提示，让PyCharm提前知晓返回值的可能类型：

from typing import Union

def get_next_event() -> Union[TriggerEvent, OtherEventType1, OtherEventType2]:
    # 函数实现逻辑
    ...

配合isinstance判断，PyCharm的类型预判会更精准，补全效果更稳定。

3. 添加类型断言明确变量类型 #

如果不想修改类型检查方式，可在if块内添加类型断言，直接告知PyCharm变量的具体类型：

next_event = get_next_event()
if type(next_event) is TriggerEvent:
    next_event: TriggerEvent  # 类型断言
    next_event.  # 此时会触发字段补全

4. 确保数据类被PyCharm正确索引 #

• 确认已正确导入dataclass和field：from dataclasses import dataclass, field
• 关联的其他数据类（如Ledger、SubTriggerEvents）所在文件未被PyCharm标记为"Excluded"
• 若出现索引异常，可执行File -> Invalidate Caches...清除缓存后重启PyCharm，重新索引项目

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