Add DATABRICKS_OIDC_TOKEN_FILEPATH env var support (#1334)

## Summary

The Go SDK, CLI, and Terraform all use `DATABRICKS_OIDC_TOKEN_FILEPATH`,
while the Python SDK used `DATABRICKS_OIDC_TOKEN_FILE`. This mismatch
caused silent failures for users coming from Go/CLI/Terraform.

This PR:
- Adds an `env_aliases` mechanism to `ConfigAttribute` so a config field
can be loaded from multiple env vars with clear precedence (primary >
alias)
- Makes `DATABRICKS_OIDC_TOKEN_FILEPATH` the primary env var, keeping
`DATABRICKS_OIDC_TOKEN_FILE` as a backward-compatible alias
- Reports alias usage in `debug_string` output

## Test plan

- [x] Alias loads when primary is not set
- [x] Primary takes precedence over alias when both are set
- [x] Constructor arg takes precedence over both env vars

Author: renaudhartert-db

NEXT_CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Release v0.103.0
 
 ### New Features and Improvements
+* Accept `DATABRICKS_OIDC_TOKEN_FILEPATH` environment variable for consistency with other Databricks SDKs (Go, CLI, Terraform). The previous `DATABRICKS_OIDC_TOKEN_FILE` is still supported as an alias.
 
 ### Security
 

databricks/sdk/config.py

@@ -34,11 +34,14 @@ class ConfigAttribute:
     transform: type = str
     _custom_transform = None
 
-    def __init__(self, env: str = None, auth: str = None, sensitive: bool = False, transform=None):
+    def __init__(
+        self, env: str = None, auth: str = None, sensitive: bool = False, transform=None, env_aliases: List[str] = None
+    ):
         self.env = env
         self.auth = auth
         self.sensitive = sensitive
         self._custom_transform = transform
+        self.env_aliases = env_aliases or []
 
     def __get__(self, cfg: "Config", owner):
         if not cfg:
@@ -109,7 +112,10 @@ class Config:
 
     # Environment variable for OIDC token.
     oidc_token_env: str = ConfigAttribute(env="DATABRICKS_OIDC_TOKEN_ENV", auth="env-oidc")
-    oidc_token_filepath: str = ConfigAttribute(env="DATABRICKS_OIDC_TOKEN_FILE", auth="file-oidc")
+    # The DATABRICKS_OIDC_TOKEN_FILE alias is kept for backward compatibility.
+    oidc_token_filepath: str = ConfigAttribute(
+        env="DATABRICKS_OIDC_TOKEN_FILEPATH", auth="file-oidc", env_aliases=["DATABRICKS_OIDC_TOKEN_FILE"]
+    )
 
     username: str = ConfigAttribute(env="DATABRICKS_USERNAME", auth="basic")
     password: str = ConfigAttribute(env="DATABRICKS_PASSWORD", auth="basic", sensitive=True)
@@ -557,6 +563,11 @@ def debug_string(self) -> str:
         for attr in Config.attributes():
             if attr.env and os.environ.get(attr.env):
                 envs_used.append(attr.env)
+            else:
+                for alias in attr.env_aliases:
+                    if os.environ.get(alias):
+                        envs_used.append(alias)
+                        break
             value = getattr(self, attr.name)
             if not value:
                 continue
@@ -709,6 +720,11 @@ def _load_from_env(self):
             if attr.name in self._inner:
                 continue
             value = os.environ.get(attr.env)
+            if not value:
+                for alias in attr.env_aliases:
+                    value = os.environ.get(alias)
+                    if value:
+                        break
             if not value:
                 continue
             self.__setattr__(attr.name, value)

tests/test_config.py

@@ -47,6 +47,30 @@ def test_config_host_url_format_check(mocker, host, expected):
     assert Config(host=host).host == expected
 
 
+def test_oidc_token_filepath_env_alias(monkeypatch, mocker):
+    monkeypatch.setenv("DATABRICKS_HOST", "https://abc.def.ghi")
+    monkeypatch.setenv("DATABRICKS_OIDC_TOKEN_FILE", "/tmp/token")
+    monkeypatch.delenv("DATABRICKS_OIDC_TOKEN_FILEPATH", raising=False)
+    mocker.patch("databricks.sdk.config.Config.init_auth")
+    assert Config().oidc_token_filepath == "/tmp/token"
+
+
+def test_oidc_token_filepath_env_primary_precedence(monkeypatch, mocker):
+    monkeypatch.setenv("DATABRICKS_HOST", "https://abc.def.ghi")
+    monkeypatch.setenv("DATABRICKS_OIDC_TOKEN_FILEPATH", "/tmp/primary")
+    monkeypatch.setenv("DATABRICKS_OIDC_TOKEN_FILE", "/tmp/alias")
+    mocker.patch("databricks.sdk.config.Config.init_auth")
+    assert Config().oidc_token_filepath == "/tmp/primary"
+
+
+def test_oidc_token_filepath_env_constructor_precedence(monkeypatch, mocker):
+    monkeypatch.setenv("DATABRICKS_HOST", "https://abc.def.ghi")
+    monkeypatch.setenv("DATABRICKS_OIDC_TOKEN_FILEPATH", "/tmp/env")
+    monkeypatch.setenv("DATABRICKS_OIDC_TOKEN_FILE", "/tmp/alias")
+    mocker.patch("databricks.sdk.config.Config.init_auth")
+    assert Config(oidc_token_filepath="/tmp/constructor").oidc_token_filepath == "/tmp/constructor"
+
+
 def test_extra_and_upstream_user_agent(monkeypatch):
 
     class MockUname: