PyCharm中自定义点访问字典的自动补全设置方法

PyCharm的静态代码分析无法自动识别动态字典的键，要实现dotDict实例的键自动补全，需要通过类型提示明确告诉IDE字典的结构，以下是几种可行方法：

方法1：使用TypedDict定义结构并标注实例类型 #

先通过TypedDict定义你需要的字典键结构，再将dotDict实例标注为该类型：

from typing import TypedDict

# 定义字典的键和对应类型
class MyDictSchema(TypedDict):
    my_item: str
    user_id: int

# 创建dotDict实例并标注类型
my_dict: MyDictSchema = dotDict({"my_item": "test_value", "user_id": 1001})

此时输入my_dict.后，PyCharm会自动提示my_item、user_id等已定义的键。

方法2：给dotDict类添加泛型支持 #

改造dotDict类使其支持泛型，结合TypedDict使用能让IDE更精准识别结构：

from typing import Generic, TypeVar, TypedDict

T = TypeVar('T')

class dotDict(dict, Generic[T]):
    __getattr__ = dict.__getitem__
    __setattr__ = dict.__setitem__
    __delattr__ = dict.__delitem__

# 定义字典结构
class ProfileDict(TypedDict):
    username: str
    age: int

# 标注实例类型
user_profile: dotDict[ProfileDict] = dotDict({"username": "alice", "age": 25})

注意事项 #

• 如果是运行时动态添加的键，PyCharm无法提前识别并给出补全，只有提前通过类型提示定义的键才能触发自动补全。
• 以上方法依赖Python的类型注解体系，确保PyCharm的Settings > Project: [你的项目名] > Python Interpreter中已安装typing相关依赖（Python 3.5+自带）。

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