如何在VSCode+Jupyter+Python中实现数据结构属性自动补全

问题描述 #

在VSCode的Jupyter Notebook环境中使用Python时，遇到动态生成属性与字典键的自动补全问题：在第一个单元格实例化对象后，通过setattr动态添加的属性和字典键，在后续单元格中仅部分值能触发自动补全（如v10可补全，v1999不可），且在表达式内部补全效果更差。已知Python语言服务器本身存在限制，无法通过穷举键或属性作为通用解决方案，询问是否可针对特定对象、Python环境或Jupyter Notebook强制开启完整自动补全。

代码示例 #

# %% Jupyter 单元格1
# 此单元格在单元格2尝试自动补全前执行
from dataclasses import dataclass

@dataclass
class ExistingItemNames:
    pass

class SearchableItemNames:
    def __init__(self, var_names: list):
        self.names__ = ExistingItemNames() 
        # 动态给names__添加属性
        for name in var_names:
            setattr(self.names__, name, name)
        # 将属性转为字典
        self.names = self.names__.__dict__

# 生成2000个动态属性/键
s = SearchableItemNames([f"v{i}" for i in range(2000)])

# %% Jupyter 单元格2

# 在顶层作用域中，通过字典或属性访问的补全表现相近
s.names['v1999'] # 无法自动补全到'v1999'键
s.names['v10'] # 可以自动补全到'v10'键
s.names__.v1999 # 无法自动补全到`v1999`属性
s.names__.v10 # 可以自动补全到`v10`属性

# 在表达式内部时，必须用字典访问才能触发补全，但仍无法覆盖所有值
(s.names__.v1999) # 无法自动补全到`v1999`属性
(s.names__.v10) # 无法自动补全到`v10`属性
(s.names['v1999']) # 无法自动补全到'v1999'键
(s.names['v10']) # 可以自动补全到'v10'键

针对性解决方案 #

1. 给特定对象添加类型提示 #

Python语言服务器依赖静态类型分析，动态生成的属性/键默认不会被识别。可通过自定义类型注解或__getattr__方法，引导服务器识别可能的属性：

from typing import Any

class SearchableItemNames:
    def __init__(self, var_names: list[str]):
        self.names__ = ExistingItemNames() 
        self._all_names = var_names
        for name in var_names:
            setattr(self.names__, name, name)
        self.names = self.names__.__dict__

    # 给names__补充类型提示，告知服务器属性来源
    def __getattr__(self, name: str) -> Any:
        if name == "names__":
            return self.names__
        raise AttributeError(f"'SearchableItemNames' object has no attribute '{name}'")

注：若动态键数量极大（如2000个），不建议用Literal枚举所有值，会导致性能问题。

2. 切换Python语言服务器 #

VSCode默认的Pylance对动态属性支持有限，可切换到Jedi服务器，它对运行时对象的补全支持更友好：

• 打开VSCode设置，搜索Python: Language Server
• 选择Jedi作为服务器
• 重启VSCode后，Jedi会同步Notebook已执行单元格的运行时状态，理论上能识别所有动态生成的属性和键。

3. 开启Jupyter扩展的运行时补全增强 #

确保VSCode的Jupyter扩展相关补全设置开启：

• 打开设置，搜索Jupyter: Enable Intellisense并勾选
• 搜索Python: Analysis: Auto Import Completions并开启
• 执行完第一个单元格后，等待几秒让扩展同步运行时状态，再尝试补全。

局限性说明 #

• 当动态生成的属性/键数量极大时，即使Jedi也可能因性能问题仅展示部分补全结果（这就是v10可补全但v1999不行的原因）
• 不存在通用的"强制开启所有补全"的方法，语言服务器需要平衡性能与准确性
• 表达式内部的补全效果弱于顶层作用域，这是静态分析与运行时状态同步的固有问题

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