如何使用Databricks widgets实现DataFrame列动态多选并存为列表

核心逻辑是依托Databricks widgets的运行时更新特性，每次执行代码时实时拉取DataFrame最新列名作为控件候选项，无需手动维护列配置。

具体实现步骤 #

• 动态读取目标DataFrame的全量列名：直接调用DataFrame内置的columns属性，该属性会实时返回当前DataFrame的所有列名，后续新增、删除列都会自动同步到返回结果里，不需要硬编码列名。
• 初始化/更新多选控件：调用dbutils.widgets.multiselect方法，把动态拿到的列列表作为候选项传入，默认值设为全量列，方便用户直接使用全选结果，也支持手动勾选部分列。
• 读取选择结果转存为列表：控件返回值是逗号分隔的字符串，直接用split方法拆成标准Python列表即可，后续可以直接传入DataFrame的select等方法使用。

可直接运行的代码示例 #

假设你当前使用的DataFrame变量名为df：

# 实时拉取DataFrame最新列，自动同步列的增减变化
latest_columns = df.columns

# 创建/更新多选下拉控件，候选项自动匹配最新列，默认全选
dbutils.widgets.multiselect(
    name="selected_cols",
    defaultValue=",".join(latest_columns),
    choices=latest_columns,
    label="选择目标列"
)

# 读取用户选中的内容，转换为list类型存储
selected_column_list = dbutils.widgets.get("selected_cols").split(",")

使用说明 #

• 只要重新运行上述代码单元格，控件的候选项就会和当前df的列完全同步，后续给DataFrame新增列、删除列都不需要修改代码配置。
• 拿到的selected_column_list是标准Python列表，可以直接用于列筛选，比如执行df.select(*selected_column_list).display()就能直接预览选中列的数据。
• 如果不需要默认全选，修改defaultValue参数即可，比如传入"A,C"就会默认选中A、C两列。
• 不要把列名硬编码写入choices参数，必须传入动态获取的df.columns才能实现自动同步效果。

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