config changes

Author: tejaskochar-db

databricks/sdk/config.py

@@ -4,6 +4,7 @@
 import logging
 import os
 import pathlib
+import re
 import sys
 import urllib.parse
 from typing import Dict, Iterable, List, Optional
@@ -117,6 +118,10 @@ class Config:
     scopes: str = ConfigAttribute()
     authorization_details: str = ConfigAttribute()
 
+    # Controls whether the offline_access scope is requested during U2M OAuth authentication.
+    # offline_access is requested by default, causing a refresh token to be included in the OAuth token.
+    disable_oauth_refresh_token: bool = ConfigAttribute(env="DATABRICKS_DISABLE_OAUTH_REFRESH_TOKEN")
+
     files_ext_client_download_streaming_chunk_size: int = 2 * 1024 * 1024  # 2 MiB
 
     # When downloading a file, the maximum number of attempts to retry downloading the whole file. Default is no limit.
@@ -245,6 +250,7 @@ def __init__(
             self._known_file_config_loader()
             self._fix_host_if_needed()
             self._validate()
+            self._sort_scopes()
             self.init_auth()
             self._init_product(product, product_version)
         except ValueError as e:
@@ -579,6 +585,16 @@ def _validate(self):
         names = " and ".join(sorted(auths_used))
         raise ValueError(f"validate: more than one authorization method configured: {names}")
 
+    def _sort_scopes(self):
+        """Sort scopes in-place for better de-duplication in the refresh token cache.
+        Delimiter is set to a single whitespace after sorting."""
+        if self.scopes and isinstance(self.scopes, str):
+            # Split on whitespaces and commas, sort, and rejoin
+            parsed = [s for s in re.split(r"[\s,]+", self.scopes) if s]
+            if parsed:
+                parsed.sort()
+                self.scopes = " ".join(parsed)
+
     def init_auth(self):
         try:
             self._header_factory = self._credentials_strategy(self)
@@ -598,6 +614,33 @@ def _init_product(self, product, product_version):
         else:
             self._product_info = None
 
+    def get_scopes(self) -> List[str]:
+        """Get OAuth scopes with proper defaulting.
+
+        Returns ["all-apis"] if no scopes configured.
+        This is the single source of truth for scope defaulting across all OAuth methods.
+
+        Parses string scopes by splitting on whitespaces and commas.
+
+        Returns:
+            List of scope strings.
+        """
+        if self.scopes and isinstance(self.scopes, str):
+            parsed = [s for s in re.split(r"[\s,]+", self.scopes) if s]
+            if not parsed:  # Empty string case
+                return ["all-apis"]
+            return parsed
+        return ["all-apis"]
+
+    def get_scopes_as_string(self) -> str:
+        """Get OAuth scopes as a space-separated string.
+
+        Returns "all-apis" if no scopes configured.
+        """
+        if self.scopes and isinstance(self.scopes, str):
+            return self.scopes
+        return " ".join(self.get_scopes())
+
     def __repr__(self):
         return f"<{self.debug_string()}>"
 

tests/test_config.py

@@ -260,3 +260,42 @@ def test_oauth_token_reuses_existing_provider(mocker):
     # Both calls should work and use the same provider instance
     assert token1 == token2 == mock_token
     assert mock_oauth_provider.oauth_token.call_count == 2
+
+
+def test_disable_oauth_refresh_token_from_env(monkeypatch, mocker):
+    mocker.patch("databricks.sdk.config.Config.init_auth")
+    monkeypatch.setenv("DATABRICKS_DISABLE_OAUTH_REFRESH_TOKEN", "true")
+    config = Config(host="https://test.databricks.com")
+    assert config.disable_oauth_refresh_token is True
+
+
+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
+
+
+def test_config_file_scopes_empty_defaults_to_all_apis(monkeypatch, mocker):
+    """Test that empty scopes in config file defaults to all-apis."""
+    mocker.patch("databricks.sdk.config.Config.init_auth")
+    monkeypatch.setenv("HOME", str(pathlib.Path(__tests__) / "testdata"))
+    config = Config(profile="scope-empty")
+    assert config.get_scopes() == ["all-apis"]
+
+
+def test_config_file_scopes_single(monkeypatch, mocker):
+    """Test single scope from config file."""
+    mocker.patch("databricks.sdk.config.Config.init_auth")
+    monkeypatch.setenv("HOME", str(pathlib.Path(__tests__) / "testdata"))
+    config = Config(profile="scope-single")
+    assert config.get_scopes() == ["clusters:read"]
+
+
+def test_config_file_scopes_multiple_sorted(monkeypatch, mocker):
+    """Test multiple scopes from config file are sorted."""
+    mocker.patch("databricks.sdk.config.Config.init_auth")
+    monkeypatch.setenv("HOME", str(pathlib.Path(__tests__) / "testdata"))
+    config = Config(profile="scope-multiple")
+    # Should be sorted alphabetically
+    expected = ["clusters", "files:read", "iam:read", "jobs", "mlflow", "model-serving:read", "pipelines"]
+    assert config.get_scopes() == expected

tests/testdata/.databrickscfg

@@ -38,4 +38,15 @@ google_credentials = paw48590aw8e09t8apu
 
 [pat.with.dot]
 host = https://dbc-XXXXXXXX-YYYY.cloud.databricks.com/
-token = PT0+IC9kZXYvdXJhbmRvbSA8PT0KYFZ
+token = PT0+IC9kZXYvdXJhbmRvbSA8PT0KYFZ
+
+[scope-empty]
+host = https://example.cloud.databricks.com
+
+[scope-single]
+host = https://example.cloud.databricks.com
+scopes = clusters
+
+[scope-multiple]
+host = https://example.cloud.databricks.com
+scopes = clusters, jobs, pipelines, iam:read, files:read, mlflow, model-serving:read