Config changes for custom scopes support #1166

Tejas-Kochar · 2025-12-23T12:39:31Z

Summary

change type of scopes from str to list.
add option for disabling refresh token to be used in U2M.
sort scopes when config is initialized.
add getters for scopes that add default scope "all-apis" if scopes is empty.

How is this tested?

Unit tests for loading scopes from a test .databrickscfg config file
Unit tests ensuring disable_oauth_refresh_token is set when environment variable DATABRICKS_DISABLE_OAUTH_REFRESH_TOKEN is set.

NO_CHANGELOG=true

github-actions · 2026-01-08T14:43:33Z

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/sdk-py

Inputs:

PR number: 1166
Commit SHA: 73d24194f88dace2bc027ba2c8daf405725afe10

Checks will be approved automatically on success.

Tejas-Kochar · 2026-01-08T17:54:50Z

tests/test_notebook_oauth.py

+        ("sql, offline_access", None),
+        ("sql, offline_access", '{"type": "databricks_resource"}'),
        ("sql", None),
-        ("sql offline_access all-apis", None),
+        ("sql, offline_access, all-apis", None),


This is probably a breaking change, to avoid making it we will have to also allow for whitespace as a delimiter as runtime oauth already uses that format.

We should add that in this PR then. I see we keep the tests as they are and add new tests for comma.

Side note: space delimited is the standard according to rfc6749. We may want to consider supporting them in other SDKs too.

hectorcast-db · 2026-01-12T12:00:47Z

databricks/sdk/__init__.py

                product_version=product_version,
                token_audience=token_audience,
-                scopes=" ".join(scopes) if scopes else None,
+                scopes=scopes,


This is a generated file. Have you changed the template? Ping me the PR for the template update.

hectorcast-db · 2026-01-12T12:09:30Z

databricks/sdk/config.py


+    # disable_oauth_refresh_token controls whether a refresh token should be requested
+    # during the U2M authentication flow (default to false).
+    disable_oauth_refresh_token: bool = ConfigAttribute(env="DATABRICKS_DISABLE_OAUTH_REFRESH_TOKEN")


Are we using this?

hectorcast-db · 2026-01-12T12:10:04Z

tests/test_config.py

+def test_disable_oauth_refresh_token_defaults_to_false(mocker):
+    mocker.patch("databricks.sdk.config.Config.init_auth")
+    config = Config(host="https://test.databricks.com")
+    assert config.disable_oauth_refresh_token is None  # ConfigAttribute returns None when not set


Why not checking

assert not config.disable_oauth_refresh_token

Is there a case which we want to differentiate between False and Not set?

hectorcast-db · 2026-01-12T12:10:52Z

tests/test_notebook_oauth.py

+        ("sql, offline_access", None),
+        ("sql, offline_access", '{"type": "databricks_resource"}'),
        ("sql", None),
-        ("sql offline_access all-apis", None),
+        ("sql, offline_access, all-apis", None),


We should add that in this PR then. I see we keep the tests as they are and add new tests for comma.

hectorcast-db · 2026-01-12T12:13:11Z

tests/test_notebook_oauth.py

+        ("sql, offline_access", None),
+        ("sql, offline_access", '{"type": "databricks_resource"}'),
        ("sql", None),
-        ("sql offline_access all-apis", None),
+        ("sql, offline_access, all-apis", None),


Side note: space delimited is the standard according to rfc6749. We may want to consider supporting them in other SDKs too.

hectorcast-db

A few more tests we could add:

List as input
Decuplication
Edge cases: Empty strings, whitespace-only strings, None values
Space separated input (backwards compatibility)

Tejas-Kochar requested a review from parthban-db December 23, 2025 12:39

Tejas-Kochar self-assigned this Dec 23, 2025

Tejas-Kochar force-pushed the custom-scopes branch 2 times, most recently from b50398b to 4fb6bd0 Compare December 25, 2025 14:26

Tejas-Kochar temporarily deployed to test-trigger-is December 25, 2025 14:26 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 25, 2025 14:27 — with GitHub Actions Inactive

Tejas-Kochar force-pushed the custom-scopes branch from 4fb6bd0 to d6a9118 Compare December 29, 2025 07:22

Tejas-Kochar temporarily deployed to test-trigger-is December 29, 2025 07:23 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 29, 2025 07:32 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 29, 2025 07:33 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 29, 2025 08:05 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 29, 2025 08:06 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is January 6, 2026 16:28 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is January 6, 2026 16:29 — with GitHub Actions Inactive

Tejas-Kochar force-pushed the custom-scopes branch from e9d4523 to 15d443c Compare January 7, 2026 13:36

Tejas-Kochar temporarily deployed to test-trigger-is January 7, 2026 13:37 — with GitHub Actions Inactive

Tejas-Kochar added 5 commits January 8, 2026 14:34

config changes

f3fb374

fix failing tests

ad4f1f9

fix windows tests

866bde4

store scopes as list in config

9b6ca63

Fix type error for Python 3.8 by using list instead of List[]

73d2419

Tejas-Kochar force-pushed the custom-scopes branch from 15d443c to 73d2419 Compare January 8, 2026 14:43

Tejas-Kochar temporarily deployed to test-trigger-is January 8, 2026 14:43 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is January 8, 2026 14:44 — with GitHub Actions Inactive

Tejas-Kochar commented Jan 8, 2026

View reviewed changes

Tejas-Kochar requested review from hectorcast-db and removed request for parthban-db January 12, 2026 11:54

hectorcast-db reviewed Jan 12, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Config changes for custom scopes support #1166

Config changes for custom scopes support #1166

Tejas-Kochar commented Dec 23, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jan 8, 2026

Uh oh!

Tejas-Kochar Jan 8, 2026

Uh oh!

hectorcast-db Jan 12, 2026

Uh oh!

hectorcast-db Jan 12, 2026

Uh oh!

Tejas-Kochar Jan 12, 2026

Uh oh!

hectorcast-db Jan 12, 2026

Uh oh!

hectorcast-db Jan 12, 2026

Uh oh!

hectorcast-db Jan 12, 2026

Uh oh!

hectorcast-db Jan 12, 2026

Uh oh!

hectorcast-db Jan 12, 2026

Uh oh!

hectorcast-db left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Config changes for custom scopes support #1166

Are you sure you want to change the base?

Config changes for custom scopes support #1166

Conversation

Tejas-Kochar commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

How is this tested?

Uh oh!

github-actions bot commented Jan 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hectorcast-db left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Tejas-Kochar commented Dec 23, 2025 •

edited

Loading