如何阻止Databricks在多次运行间保留小部件选择？

问题原因 #

Databricks的Notebook小部件状态是与Notebook本身绑定并持久化存储的，并非仅存在于计算会话中。即使重启计算集群，Notebook的小部件参数会保留在工作区的元数据里。当调用dbutils.widgets.multiselect创建同名小部件时，系统会优先加载已保存的旧选择状态，而非使用新的默认值或当前未选择的状态，这就导致取消勾选或选项被删除后，旧选择仍会被读取。

解决方法 #

方法1：先删除旧小部件再重建 #

每次运行Notebook时，先检查并删除已存在的同名小部件，再重新创建。这样会彻底清除旧的持久化状态，让小部件基于当前的选项列表初始化，同时添加验证逻辑确保选择有效：

# 从表中获取当前可用选项
widget_values = spark.sql(f'''
SELECT      my_column
FROM        my_table
GROUP BY    my_column
ORDER BY    my_column
''').collect()
widget_values = [i[0] for i in widget_values]

# 删除已存在的同名小部件，清除旧状态
if dbutils.widgets.exists("My widget"):
    dbutils.widgets.remove("My widget")

selection = ""
if len(widget_values) > 0:
    # 重新创建多选小部件
    dbutils.widgets.multiselect("My widget", widget_values[0], widget_values)
    # 获取当前选择并验证有效性
    raw_selection = dbutils.widgets.get("My widget")
    valid_selections = [item for item in raw_selection.split(",") if item in widget_values]
    selection = ",".join(valid_selections) if valid_selections else ""
else:
    print("No data in my_table")

方法2：仅验证选择有效性（不删除小部件） #

如果不需要重置小部件的显示状态，可在获取选择后直接验证项是否存在于当前可用列表中，过滤无效选择：

widget_values = spark.sql(f'''
SELECT      my_column
FROM        my_table
GROUP BY    my_column
ORDER BY    my_column
''').collect()
widget_values = [i[0] for i in widget_values]

selection = ""
if len(widget_values) > 0:
    dbutils.widgets.multiselect("My widget", widget_values[0], widget_values)
    raw_selection = dbutils.widgets.get("My widget")
    # 过滤掉不在当前选项中的旧选择
    valid_selections = [item for item in raw_selection.split(",") if item in widget_values]
    selection = ",".join(valid_selections) if valid_selections else ""
else:
    print("No data in my_table")

说明 #

• 方法1适合需要完全重置小部件状态的场景，确保每次运行都基于最新选项列表初始化；
• 方法2更轻量，仅处理无效选择，保留用户当前的有效勾选状态；
• 多选小部件的get方法返回逗号分隔的字符串，需拆分后逐个验证项的有效性。

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