Adding dashboard support to PyDABs

acceptance/bundle/python/dashboards-support/dashboard.lvdash.json

@@ -0,0 +1,3 @@
+{
+  "pages": []
+}

acceptance/bundle/python/dashboards-support/databricks.yml

@@ -0,0 +1,17 @@
+bundle:
+  name: my_project
+
+sync: {paths: []} # don't need to copy files
+
+python:
+  resources:
+    - "resources:load_resources"
+  mutators:
+    - "mutators:update_dashboard"
+
+resources:
+  dashboards:
+    my_dashboard_1:
+      display_name: "My Dashboard"
+      file_path: dashboard.lvdash.json
+      warehouse_id: my_warehouse

acceptance/bundle/python/dashboards-support/mutators.py

@@ -0,0 +1,11 @@
+from dataclasses import replace
+
+from databricks.bundles.core import dashboard_mutator
+from databricks.bundles.dashboards import Dashboard
+
+
+@dashboard_mutator
+def update_dashboard(dashboard: Dashboard) -> Dashboard:
+    assert isinstance(dashboard.display_name, str)
+
+    return replace(dashboard, display_name=f"{dashboard.display_name} (updated)")

acceptance/bundle/python/dashboards-support/output.txt

@@ -0,0 +1,39 @@
+
+>>> uv run [UV_ARGS] -q [CLI] bundle validate --output json
+{
+  "experimental": {
+    "python": {
+      "mutators": [
+        "mutators:update_dashboard"
+      ],
+      "resources": [
+        "resources:load_resources"
+      ]
+    }
+  },
+  "resources": {
+    "dashboards": {
+      "my_dashboard_1": {
+        "display_name": "My Dashboard (updated)",
+        "embed_credentials": false,
+        "file_path": "dashboard.lvdash.json",
+        "parent_path": "/Workspace/Users/[USERNAME]/.bundle/my_project/default/resources",
+        "serialized_dashboard": "{\n  \"pages\": []\n}\n",
+        "warehouse_id": "my_warehouse"
+      },
+      "my_dashboard_2": {
+        "display_name": "My Dashboard (2) (updated)",
+        "embed_credentials": false,
+        "parent_path": "/Workspace/Users/[USERNAME]/.bundle/my_project/default/resources",
+        "serialized_dashboard": {
+          "pages": [
+            {
+              "name": "python_page"
+            }
+          ]
+        },
+        "warehouse_id": "my_warehouse_2"
+      }
+    }
+  }
+}

acceptance/bundle/python/dashboards-support/resources.py

@@ -0,0 +1,16 @@
+from databricks.bundles.core import Resources
+
+
+def load_resources() -> Resources:
+    resources = Resources()
+
+    resources.add_dashboard(
+        "my_dashboard_2",
+        {
+            "display_name": "My Dashboard (2)",
+            "serialized_dashboard": {"pages": [{"name": "python_page"}]},
+            "warehouse_id": "my_warehouse_2",
+        },
+    )
+
+    return resources

acceptance/bundle/python/dashboards-support/script

@@ -0,0 +1,5 @@
+
+trace uv run $UV_ARGS -q $CLI bundle validate --output json | \
+  jq "pick(.experimental.python, .resources)"
+
+rm -fr .databricks __pycache__

acceptance/bundle/python/dashboards-support/test.toml

@@ -0,0 +1,4 @@
+Cloud = false # tests don't interact with APIs
+
+# dashboards are only supported in the current version of the wheel
+EnvMatrix.PYDAB_VERSION = ["current"]

python/codegen/codegen/generated_imports.py

@@ -44,7 +44,7 @@ def get_code(
     b = CodeBuilder()
 
     b.append(
-        "from typing import Literal, Optional, TypedDict, ClassVar, TYPE_CHECKING\n"
+        "from typing import Any, Literal, Optional, TypedDict, ClassVar, TYPE_CHECKING\n"
     )
     b.append("from enum import Enum\n")
     b.append("from dataclasses import dataclass, replace, field\n")

python/codegen/codegen/packages.py

@@ -9,6 +9,7 @@
     "resources.Schema": "schemas",
     "resources.Volume": "volumes",
     "resources.Alert": "alerts",
+    "resources.Dashboard": "dashboards",
 }
 
 RESOURCE_TYPES = list(RESOURCE_NAMESPACE.keys())
@@ -20,6 +21,7 @@
     "number": "float",
     "int64": "int",
     "float64": "float",
+    "interface": "Any",
 }
 
 PRIMITIVES = [
@@ -31,6 +33,7 @@
     "int",
     "int64",
     "float64",
+    "interface",
 ]
 
 

python/codegen/codegen_tests/test_generated_dataclass.py

@@ -26,6 +26,20 @@ def test_generate_type_string():
     )
 
 
+def test_generate_type_interface():
+    generated_type = generate_type(
+        namespace="dashboards",
+        ref="#/$defs/interface",
+        is_param=False,
+    )
+
+    assert generated_type == GeneratedType(
+        name="Any",
+        package=None,
+        parameters=[],
+    )
+
+
 def test_generate_type_dict():
     generated_type = generate_type(
         namespace="jobs",

python/databricks/bundles/core/_transform.py

@@ -137,6 +137,9 @@ def _transform_field(cls: Type[_T], field: Field, value: Any) -> _T:
 def _transform(cls: Type[_T], value: Any) -> _T:
     origin = get_origin(cls)
 
+    if cls is Any:
+        return value
+
     if is_dataclass(cls) and isinstance(value, cls):  # type:ignore
         return value