解决ttk.widgets AutocompleteEntry同时按两键自动补全异常问题

使用ttkwidgets的AutocompleteEntry控件创建表单时，遇到快速输入（如未释放前一键就按下新键、同时按多键）的场景，控件会错误补全为当前输入前缀的首个匹配项。例如快速输入“123666”时，会被自动替换成“123555”——因为输入“1”后补全逻辑就触发，匹配到了列表中第一个以“1”开头的项，后续输入的“2”“3”“6”等被补全结果覆盖。

原示例代码：

import tkinter as tk
from ttkwidgets.autocomplete import AutocompleteEntry


class DfeForm(tk.Tk):

    @staticmethod
    def only_numbers(char):
        return char.isdigit()

    def character_limit(self, entry_text):
        if len(entry_text.get()) > 0:
            entry_text.set(entry_text.get()[:14])

    def __init__(self, *args, **kwargs):
        tk.Tk.__init__(self, *args, **kwargs)

        padding = {'padx': 5, 'pady': 5}

        self.geometry('340x255')
        self.title("My form")
        validation = self.register(self.only_numbers)

        input1_text = tk.StringVar()
        input1_label = tk.Label(text='Entry to autocomplete:')
        input1_label.grid(row=1, column=0, sticky=tk.E, **padding)
        input1_entry = AutocompleteEntry(self, foreground='black', validate='key',
                                         validatecommand=(validation, '%S'), textvariable=input1_text,
                                         completevalues=autocompleteList)
        input1_entry.grid(row=1, column=1, **padding, sticky=tk.E)
        input1_text.trace("w", lambda *args: self.character_limit(input1_text))
        self.resizable(0, 0)


def main():
    gui = DfeForm()
    gui.mainloop()


autocompleteList = ['123555', '123666', '123777', '223555']

if __name__ == "__main__":
    main()

问题原因 #

AutocompleteEntry默认的补全逻辑是每次按键事件触发后立即执行匹配，当输入速度快于补全逻辑的执行速度时，前一次的补全结果会覆盖后续输入的字符。比如按下“1”后，控件立刻匹配到“123555”并填充，此时快速按下的“2”还没完全写入输入框，就被补全的内容覆盖，最终得到错误结果。

解决方案 #

通过延迟触发补全逻辑来避免这个问题——只有当用户停止输入一段时间（比如200ms）后，才执行补全匹配。这样可以确保用户完成连续输入后，再基于完整的输入内容进行匹配。

具体实现方式是继承AutocompleteEntry，重写_on_key_release方法，添加一个定时器，每次按键时重置定时器，延迟后再执行原有的补全逻辑。

修改后的代码：

import tkinter as tk
from ttkwidgets.autocomplete import AutocompleteEntry


class DelayedAutocompleteEntry(AutocompleteEntry):
    def __init__(self, *args, delay=200, **kwargs):
        super().__init__(*args, **kwargs)
        self.delay = delay  # 延迟时间，单位ms
        self._autocomplete_timer = None

    def _on_key_release(self, event):
        # 取消之前的定时器
        if self._autocomplete_timer:
            self.after_cancel(self._autocomplete_timer)
        # 设置新的定时器，延迟后执行补全
        self._autocomplete_timer = self.after(self.delay, super()._on_key_release, event)


class DfeForm(tk.Tk):

    @staticmethod
    def only_numbers(char):
        return char.isdigit()

    def character_limit(self, entry_text):
        if len(entry_text.get()) > 0:
            entry_text.set(entry_text.get()[:14])

    def __init__(self, *args, **kwargs):
        tk.Tk.__init__(self, *args, **kwargs)

        padding = {'padx': 5, 'pady': 5}

        self.geometry('340x255')
        self.title("My form")
        validation = self.register(self.only_numbers)

        input1_text = tk.StringVar()
        input1_label = tk.Label(text='Entry to autocomplete:')
        input1_label.grid(row=1, column=0, sticky=tk.E, **padding)
        # 使用自定义的延迟补全Entry，替换原AutocompleteEntry
        input1_entry = DelayedAutocompleteEntry(self, foreground='black', validate='key',
                                         validatecommand=(validation, '%S'), textvariable=input1_text,
                                         completevalues=autocompleteList, delay=200)
        input1_entry.grid(row=1, column=1, **padding, sticky=tk.E)
        input1_text.trace("w", lambda *args: self.character_limit(input1_text))
        self.resizable(0, 0)


def main():
    gui = DfeForm()
    gui.mainloop()


autocompleteList = ['123555', '123666', '123777', '223555']

if __name__ == "__main__":
    main()

说明 #

• 新增DelayedAutocompleteEntry类，继承自原AutocompleteEntry，通过after和after_cancel实现延迟触发。
• delay参数可调整，根据实际输入速度设置合适的时间（比如150-300ms），确保用户完成连续输入后再触发补全。
• 原有的输入验证、字符限制逻辑保持不变，不影响原有功能。

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