导入其他脚本后Tkinter文件选择函数Listbox失效问题排查

我编写了一个基于Tkinter的本地文件选择函数local_file_selection，该函数会创建Tk窗口，通过Listbox展示程序目录下指定扩展名的文件。在自身脚本中调用时，该函数运行正常，Listbox可正确显示文件并支持选择；但将其导入到另一脚本中调用后，Listbox显示为空，lbx_files.get(0)返回空字符串，尽管绑定的Tk变量tkv_files的值符合预期。我尝试重命名窗口对象root但无效果，现寻求该问题产生的原因。

简化后的函数代码 #

from tkinter import Tk, Label, Button, Listbox, Variable
from os import getcwd, listdir

def local_file_selection(title:str = '', extension = '.gif') -> str | None:
    file = ''

    def confirm(): # 点击确认按钮时调用的函数
        nonlocal file
        try:
            file = lbx_files.get(lbx_files.curselection()[0])
            root.destroy()
        except IndexError: print('请选择一个文件。')

    dir_path  = getcwd() # 获取程序当前路径
    lst_files = []

    for path in listdir(dir_path):
        if path[-len(extension):] == extension: # 判断是否为指定扩展名文件
            lst_files.append(path)              # 加入文件列表
 
    root = Tk()
    root.title(title)

    tkv_files = Variable(value=lst_files) # Tk变量，用于绑定Listbox
    lbx_files = Listbox(root, listvariable=tkv_files) # Listbox控件
    '''
    在自身脚本调用时：
        tkv_files.get() == "('my_first_and_only_file.gif',)"
        lbx_files.get(0) == 'my_first_and_only_file.gif'

    但在其他脚本调用时：
        tkv_files.get() == "('my_first_and_only_file.gif',)" # 符合预期
        lbx_files.get(0) == ''                               # 不明原因
    '''
    btn_confirm = Button(root, text='确认', command=confirm)

    lbx_files.pack()
    btn_confirm.pack()

    root.mainloop()

    return file

调用该函数的简化脚本代码 #

from tkinter import Tk, Label, Button, Entry
from file_selection import local_file_selection


class PictureButton(Button):
    def __init__(self, *args, **kwargs):
        self.get = lambda: None
        super().__init__(text='选择图片', command=self.command, *args, **kwargs)

    def command(self):
        sel = local_file_selection()
        self.get = lambda: sel


root = Tk()
root.title('新站点')


def create(): 
    
    alert = Tk()
    alert.title('提示')
    Label(alert, text=f"你的用户名是 '{entry_username.get()}' \n 你的头像文件名是 '{button_picture.get()}'").pack()
    alert.mainloop()

label_username = Label(root,text='用户名 :')
label_picture = Label(root,text='头像 :')

entry_username = Entry(root)
button_picture = PictureButton(root)

button_create = Button(root, text='注册', command= create)


label_username.grid(row=0, column=0)
label_picture.grid(row=1, column=0)

entry_username.grid(row=0, column=1)
button_picture.grid(row=1, column=1)

button_create.grid(row=3, column=0, columnspan=2)

root.mainloop()

问题原因 #

Tkinter程序中只能存在一个主Tk实例，当调用脚本里已经创建了root = Tk()作为主窗口，再在local_file_selection里创建第二个Tk()实例时，会导致Tk内部的变量绑定机制异常：

• 自身脚本调用时，函数内的Tk()是唯一主实例，tkv_files和Listbox的绑定正常生效；
• 其他脚本调用时，主脚本已有一个Tk()实例，函数内新创建的Tk()是第二个实例，此时Variable对象默认绑定到第一个主Tk实例的Tcl解释器，而Listbox属于第二个Tk窗口，两者不在同一Tcl上下文，导致Listbox无法读取变量内容，因此显示为空。

解决方法 #

将函数内的root = Tk()替换为root = Toplevel()，Toplevel是基于现有主窗口的子窗口，会共享同一个Tcl解释器，变量绑定即可正常工作：

# 替换原来的root = Tk()
root = Toplevel()
root.title(title)

也可以先检查是否存在主Tk实例，不存在时再创建：

try:
    root = Tk()
except TclError:
    root = Toplevel()

规范做法是始终用Toplevel作为弹出窗口，避免多主实例引发的问题。

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