JupyterLab动态自动补全：对象自定义补全实现方案问询

一、通过实现魔法函数实现自动补全 #

1. 属性/字段补全：重写__dir__方法 #

Jupyter的属性补全逻辑依赖对象的__dir__()方法返回的列表，你可以自定义这个方法来返回动态生成的字段名，比如ORM模型的字段、动态命名空间的属性：

class DynamicORMModel:
    def __init__(self, fields):
        self._db_fields = fields
    
    def __dir__(self):
        # 把自定义字段和默认属性合并返回
        return super().__dir__() + list(self._db_fields.keys())
    
    def __getattr__(self, name):
        if name in self._db_fields:
            return self._db_fields[name]
        raise AttributeError(f"'DynamicORMModel' object has no attribute '{name}'")

在Jupyter里输入model_instance.时，就会自动弹出_db_fields里的所有字段名。

2. __getitem__补全：实现_ipython_key_completions_方法 #

针对obj[key]这种字典式访问的补全，IPython（Jupyter内核基于它）提供了专门的_ipython_key_completions_()方法，返回可补全的键列表即可：

class DynamicDataFrame:
    def __init__(self, columns):
        self._columns = columns
        self._data = {col: [1,2,3] for col in columns}
    
    def __getitem__(self, col):
        return self._data[col]
    
    def _ipython_key_completions_(self):
        return self._columns

输入df['时，Jupyter会自动补全所有列名选项。

二、注册IPython内核钩子扩展补全 #

如果不想修改对象类（比如第三方库的对象），可以直接给IPython内核注册自定义补全器：

from IPython.core.completer import Completer

def custom_attr_completer(s, self):
    # 获取当前输入的对象实例
    obj = self._get_obj()
    # 针对特定类型的对象返回自定义补全项
    if isinstance(obj, SomeThirdPartyClass):
        return obj.dynamic_attrs_list()
    return []

def custom_item_completer(s, self):
    obj = self._get_obj()
    if hasattr(obj, 'get_available_keys'):
        # 返回带引号的键，适配[]语法
        return [f"'{key}'" for key in obj.get_available_keys()]
    return []

# 获取当前IPython会话的补全器
completer = get_ipython().Completer
# 注册属性补全钩子
completer.custom_completers[(r"\.",)] = custom_attr_completer
# 注册__getitem__补全钩子
completer.custom_completers[(r"\['.*'\]",)] = custom_item_completer

这种方式灵活性更高，能快速给现有对象扩展补全能力。

以上两种方案都能完美适配ORM、动态命名空间、数据框等场景，大幅提升交互效率。

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