Adding dashboard support to PyDABs

[hejcman-enverus]

Changes

• Added PyDABs support for dashboard resources.
• Added the generated Dashboard models and exposed:
  • Resources.add_dashboard
  • Resources.dashboards
  • dashboard_mutator
• Added codegen support for schema interface{} fields as Python Any, enabling both inline and file-backed serialized_dashboard values.
• Added a changelog fragment.

Example Usage

from dataclasses import replace

from databricks.bundles.core import Resources, dashboard_mutator
from databricks.bundles.dashboards import Dashboard


def load_resources() -> Resources:
    resources = Resources()
    resources.add_dashboard(
        "sales_dashboard",
        Dashboard(
            display_name="Sales Dashboard",
            serialized_dashboard={"pages": []},
            warehouse_id="0123456789abcdef",
        ),
    )
    return resources


@dashboard_mutator
def configure_dashboard(dashboard: Dashboard) -> Dashboard:
    return replace(dashboard, embed_credentials=True)

Why

Dashboards are supported as bundle resources by the Databricks CLI, but they did not have an equivalent PyDABs API like jobs, schemas, volumes, and other resources.

Dashboard definitions also require support for serialized_dashboard, whose schema permits both serialized strings and structured JSON values. Mapping the underlying interface{} type to Any preserves both representations.

Tests

• All relevant PyDABs checks in the taskfile
• Added an acceptance test covering:
  • A YAML-defined, file-backed dashboard
  • A Python-defined dashboard with inline structured JSON
  • Dashboard mutators
  • Direct and Terraform bundle engines
  • Supported DMS configurations

[github-actions]

Approval status: pending

/acceptance/bundle/ - needs approval

8 files changed
Suggested: @denik
Also eligible: @andrewnester, @anton-107, @janniklasrose, @lennartkats-db, @pietern, @shreyas-goenka

General files (require maintainer)

16 files changed
Based on git history:

• @denik -- recent work in python/databricks/bundles/core/, python/codegen/codegen/, python/codegen/codegen_tests/

_{Any maintainer (@andrewnester, @anton-107, @denik, @pietern, @shreyas-goenka, @simonfaltum, @renaudhartert-db, @janniklasrose, @lennartkats-db, @rugpanov, @rclarey) can approve all areas.
See OWNERS for ownership rules.}

[github-actions]

An authorized user can trigger integration tests manually by following the instructions below:

Trigger:
go/deco-tests-run/cli

Inputs:

• PR number: 6518
• Commit SHA: 352c90b6c7b7b099013e7c6f7f9180c168ed290f

Checks will be approved automatically on success.

[Sankalp-Mittal]

Hi @hejcman-enverus, thanks for the PR.
We are currently consolidating support for all PyDABs resources in PR #6528 (dashboards support will also be added soon). Since that will cover this functionality and serve as our path forward, I'll be closing this PR. We really appreciate your time and effort here sorry for the overlap!