如何使用PyQt5 QCompleter实现代码补全及嵌套属性补全异常

我刚好之前做过类似的代码补全功能，你的两个问题其实都是默认QCompleter的行为逻辑导致的，咱们一步步来解决：

问题1：选中补全项时替换了item.而非追加 #

默认的QCompleter会把输入框中匹配补全前缀的部分完全替换掉，所以当你输入item.，补全项是attr时，它就直接把item.换成attr了。要改这个逻辑，我们可以自定义Completer类，或者手动处理选中补全项时的插入行为。

问题2：子属性补全失效 #

这个需要动态根据当前输入的路径生成补全项——比如输入item.时加载item的属性列表，输入item.attr.时加载attr的子属性列表。我们需要监听输入框的文本变化，解析当前的上下文路径，再实时更新补全模型。

完整示例代码 #

下面是修改后的可运行代码，完美解决这两个问题：

import sys
from PyQt5.QtCore import Qt, QStringListModel
from PyQt5.QtWidgets import QApplication, QLineEdit, QCompleter

# 模拟你的属性结构，可根据实际业务替换
class MockObject:
    def __init__(self, name, attrs=None):
        self.name = name
        self.attrs = attrs or {}

# 构建测试用的属性树
root_obj = MockObject("root", {
    "item": MockObject("item", {
        "attr": MockObject("attr", {
            "subattr": MockObject("subattr"),
            "subattr2": MockObject("subattr2")
        }),
        "attr2": MockObject("attr2")
    })
})

class CustomCompleter(QCompleter):
    def __init__(self, parent=None):
        super().__init__(parent)
        self.setCompletionMode(QCompleter.PopupCompletion)
        self.setCaseSensitivity(Qt.CaseInsensitive)

    def pathFromIndex(self, index):
        # 返回补全项的原始文本，避免默认的前缀替换逻辑
        return index.data(Qt.DisplayRole)

class CodeLineEdit(QLineEdit):
    def __init__(self, parent=None):
        super().__init__(parent)
        self.completer = CustomCompleter(self)
        self.setCompleter(self.completer)
        # 监听文本变化，动态更新补全候选
        self.textChanged.connect(self.update_completion_model)

    def update_completion_model(self, text):
        # 解析当前输入的路径，比如 "item.attr." 拆分为 ["item", "attr"]
        parts = text.split(".")
        current_obj = root_obj
        valid_path = True

        # 遍历路径，定位到当前对应的对象
        for part in parts[:-1]:
            if part in current_obj.attrs:
                current_obj = current_obj.attrs[part]
            else:
                valid_path = False
                break

        if valid_path and parts[-1] == "":
            # 输入末尾是点，显示当前对象的所有属性
            completions = list(current_obj.attrs.keys())
        else:
            # 过滤以当前输入后缀开头的属性
            prefix = parts[-1]
            completions = [k for k in current_obj.attrs.keys() if k.startswith(prefix)]

        # 更新补全模型
        self.completer.setModel(QStringListModel(completions))

    def insertCompletion(self, completion):
        # 手动处理插入逻辑：保留点之前的内容，追加补全文本
        text = self.text()
        dot_pos = text.rfind(".")
        if dot_pos != -1:
            # 拼接成 "item.attr" 这类格式
            new_text = text[:dot_pos+1] + completion
            self.setText(new_text)
            self.setCursorPosition(len(new_text))
        else:
            # 无点的情况，沿用默认替换逻辑
            super().insertCompletion(completion)

if __name__ == "__main__":
    app = QApplication(sys.argv)
    line_edit = CodeLineEdit()
    line_edit.setPlaceholderText("输入item.试试...")
    line_edit.show()
    sys.exit(app.exec_())

代码说明 #

1. CustomCompleter：重写pathFromIndex方法，确保返回补全项的原始文本，避免默认的前缀替换行为。
2. CodeLineEdit：
   • update_completion_model：实时解析输入的路径，根据上下文动态生成对应层级的补全候选列表，解决子属性补全的问题。
   • insertCompletion：手动处理插入逻辑，找到最后一个点的位置，在点后追加补全文本，解决item.被替换的问题。

运行后你可以测试：输入item.会弹出attr和attr2，选中attr后文本会变成item.attr，再输入.就会弹出subattr和subattr2，完全符合预期。

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