dbutils.widgets.get - Python

dbutils.widgets.get 是 Databricks 平台上的一个 Python 函数，它允许用户获取在 Databricks 笔记本中定义的小部件的值。

什么是 Databricks Notebook 小部件？

Databricks Notebook 上的小部件是一种简单的用户界面元素，可以向用户提供交互体验。小部件可以是文本框、下拉列表、滑块等，它们都可以在笔记本中根据需要进行定制和配置。

函数签名和用法

dbutils.widgets.get 函数的签名如下:

def get(name: str) -> Union[str, None]:

它需要一个字符串作为输入，并返回一个字符串或 None。

它的用法非常简单，只需要将笔记本中小部件的名称作为参数传递给它即可。

下面是一个简单的示例代码，它展示了如何使用 dbutils.widgets.get 函数来获取笔记本中名为 my-widget 的小部件的值：

my_widget_value = dbutils.widgets.get("my-widget")

在上面的代码中，变量 my_widget_value 将包含 my-widget 的值。

返回值说明

如果小部件不存在，则该函数返回 None。

如果传递给函数的名称是有效的，则该函数将返回小部件的值。

示例代码

下面是一个示例代码片段，它展示了如何使用 dbutils.widgets.get 来获取笔记本中两个小部件的值：

# 获取两个小部件的值
country = dbutils.widgets.get("country-selector")
year = dbutils.widgets.get("year-selector")

# 显示获取到的值
print(f'您选择的国家是：{country}')
print(f'您选择的年份是：{year}')

该示例代码假设笔记本中有两个小部件，它们的名称分别是 country-selector 和 year-selector。它们都是下拉列表，用户可以通过它们选择国家和年份。

该代码片段将获取这两个小部件的值，并将它们打印到控制台上。

结论

dbutils.widgets.get 函数是 Databricks 中非常有用的一个小工具, 它允许用户获取笔记本中定义的小部件的值，使得笔记本中的用户交互更便捷。