Skip to content

Commit ebffb96

Browse files
committed
add backward compatibility
1 parent 16cb073 commit ebffb96

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

src/databricks/sql/client.py

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ def __init__(
123123
`oauth_client_id` is set
124124
125125
user_agent_entry: `str`, optional
126-
Tag to add to User-Agent header. For use by partners. If not specified, it will use the default user agent PyDatabricksSqlConnector
126+
A custom tag to append to the User-Agent header. This is typically used by partners to identify their applications.. If not specified, it will use the default user agent PyDatabricksSqlConnector
127127
128128
experimental_oauth_persistence: configures preferred storage for persisting oauth tokens.
129129
This has to be a class implementing `OAuthPersistence`.
@@ -228,12 +228,21 @@ def read(self) -> Optional[OAuthToken]:
228228
server_hostname, **kwargs
229229
)
230230

231-
if not kwargs.get("user_agent_entry"):
232-
useragent_header = "{}/{}".format(USER_AGENT_NAME, __version__)
233-
else:
231+
user_agent_entry = kwargs.get("user_agent_entry")
232+
if user_agent_entry is None:
233+
user_agent_entry = kwargs.get("_user_agent_entry")
234+
if user_agent_entry is not None:
235+
logger.warning(
236+
"[WARN] Parameter '_user_agent_entry' is deprecated; use 'user_agent_entry' instead. "
237+
"This parameter will be removed in the next release."
238+
)
239+
240+
if user_agent_entry:
234241
useragent_header = "{}/{} ({})".format(
235-
USER_AGENT_NAME, __version__, kwargs.get("user_agent_entry")
242+
USER_AGENT_NAME, __version__, user_agent_entry
236243
)
244+
else:
245+
useragent_header = "{}/{}".format(USER_AGENT_NAME, __version__)
237246

238247
base_headers = [("User-Agent", useragent_header)]
239248

0 commit comments

Comments
 (0)