make fmt fixes

Author: dbkegley

examples/connect/databricks/dash/app.py

@@ -10,9 +10,9 @@
 from databricks.sdk.service.iam import CurrentUserAPI
 
 from posit.connect.external.databricks import (
+    ConnectStrategy,
     new_config,
     sql_credentials,
-    ConnectStrategy,
 )
 
 DATABRICKS_HOST = os.getenv("DATABRICKS_HOST")

examples/connect/databricks/fastapi/app.py

@@ -9,9 +9,9 @@
 from typing_extensions import TYPE_CHECKING, Annotated
 
 from posit.connect.external.databricks import (
+    ConnectStrategy,
     new_config,
     sql_credentials,
-    ConnectStrategy,
 )
 
 if TYPE_CHECKING:

examples/connect/databricks/flask/app.py

@@ -6,9 +6,9 @@
 from flask import Flask, request
 
 from posit.connect.external.databricks import (
+    ConnectStrategy,
     new_config,
     sql_credentials,
-    ConnectStrategy,
 )
 
 DATABRICKS_HOST = os.getenv("DATABRICKS_HOST")
@@ -34,9 +34,7 @@ def get_fares():
 
     session_token = request.headers.get("Posit-Connect-User-Session-Token")
     cfg = new_config(
-        posit_connect_strategy=ConnectStrategy(
-            user_session_token=session_token
-        ),
+        posit_connect_strategy=ConnectStrategy(user_session_token=session_token),
     )
 
     if rows is None:

examples/connect/databricks/shiny/app.py

@@ -9,9 +9,9 @@
 from shiny import App, Inputs, Outputs, Session, render, ui
 
 from posit.connect.external.databricks import (
+    ConnectStrategy,
     new_config,
     sql_credentials,
-    ConnectStrategy,
 )
 
 DATABRICKS_HOST = os.getenv("DATABRICKS_HOST")
@@ -28,9 +28,7 @@ def server(i: Inputs, o: Outputs, session: Session):
     """
     session_token = session.http_conn.headers.get("Posit-Connect-User-Session-Token")
     cfg = new_config(
-        posit_connect_strategy=ConnectStrategy(
-            user_session_token=session_token
-        ),
+        posit_connect_strategy=ConnectStrategy(user_session_token=session_token),
     )
 
     @render.data_frame

examples/connect/databricks/streamlit/app.py

@@ -9,9 +9,9 @@
 from databricks.sdk.service.iam import CurrentUserAPI
 
 from posit.connect.external.databricks import (
+    ConnectStrategy,
     new_config,
     sql_credentials,
-    ConnectStrategy,
 )
 
 DATABRICKS_HOST = os.getenv("DATABRICKS_HOST")
@@ -20,9 +20,7 @@
 
 session_token = st.context.headers.get("Posit-Connect-User-Session-Token")
 cfg = new_config(
-    posit_connect_strategy=ConnectStrategy(
-        user_session_token=session_token
-    ),
+    posit_connect_strategy=ConnectStrategy(user_session_token=session_token),
 )
 
 databricks_user = CurrentUserAPI(ApiClient(cfg)).me()

src/posit/connect/_utils.py

@@ -37,10 +37,12 @@ def is_workbench() -> bool:
 
     There is not yet a definitive way to determine if the content is running on Workbench. This method is best-effort.
     """
-    return "RSW_LAUNCHER" in os.environ or \
-        "RSTUDIO_MULTI_SESSION" in os.environ or \
-        "RS_SERVER_ADDRESS" in os.environ or \
-        "RS_SERVER_URL" in os.environ
+    return (
+        "RSW_LAUNCHER" in os.environ
+        or "RSTUDIO_MULTI_SESSION" in os.environ
+        or "RS_SERVER_ADDRESS" in os.environ
+        or "RS_SERVER_URL" in os.environ
+    )
 
 
 def is_connect() -> bool:

src/posit/connect/client.py

@@ -208,6 +208,7 @@ def with_user_session_token(self, token: str) -> Client:
         --------
         ```python
         from posit.connect import Client
+
         client = Client().with_user_session_token("my-user-session-token")
         ```
 
@@ -218,13 +219,14 @@ def with_user_session_token(self, token: str) -> Client:
 
         client = Client()
 
+
         @reactive.calc
         def visitor_client():
             ## read the user session token and generate a new client
-            user_session_token = session.http_conn.headers.get(
-                "Posit-Connect-User-Session-Token"
-            )
+            user_session_token = session.http_conn.headers.get("Posit-Connect-User-Session-Token")
             return client.with_user_session_token(user_session_token)
+
+
         @render.text
         def user_profile():
             # fetch the viewer's profile information

src/posit/connect/external/databricks.py

@@ -7,19 +7,24 @@
 These APIs are provided as a convenience and are subject to breaking changes:
 https://github.com/databricks/databricks-sdk-py#interface-stability
 """
+
 from __future__ import annotations
 
-from typing_extensions import Dict, Optional
+import logging
+
+from typing_extensions import TYPE_CHECKING, Dict, Optional
 
 from .._utils import is_connect, is_workbench
 from ..client import Client
-from ..oauth import Credentials
 
 try:
     from databricks.sdk.core import Config, DefaultCredentials
     from databricks.sdk.credentials_provider import CredentialsProvider, CredentialsStrategy
-except ImportError:
-    raise ImportError("The 'databricks-sdk' package is required to use this module.")
+except ImportError as e:
+    raise ImportError("The 'databricks-sdk' package is required to use this module.") from e
+
+if TYPE_CHECKING:
+    from ..oauth import Credentials
 
 
 POSIT_OAUTH_INTEGRATION_AUTH_TYPE = "posit-oauth-integration"
@@ -85,41 +90,47 @@ def __call__(self) -> Dict[str, str]:
 
 
 class WorkbenchStrategy(CredentialsStrategy):
-    """
-    """
-    def __init__(self, config: Config):
-        self._config = config or Config("workbench")
+    """`CredentialsStrategy` implementation which provides a bearer token for Workbench environments."""
+
+    def __init__(self, config: Optional[Config] = None):
+        self._config = config or Config(profile="workbench")
 
     def auth_type(self) -> str:
         return POSIT_WORKBENCH_AUTH_TYPE
 
-    def __call__(self, *args, **kwargs) -> CredentialsProvider: # noqa: ARG002
+    def __call__(self, *args, **kwargs) -> CredentialsProvider:  # noqa: ARG002
         if self._config.token is None:
             raise ValueError("Missing value for field 'token' in Config.")
 
         def cp():
             return {"Authorization": f"Bearer {self._config.token}"}
+
         return cp
 
 
 class ConnectStrategy(CredentialsStrategy):
-    """
-    """
-    def __init__(self,
-                 client: Optional[Client] = None,
-                 user_session_token: Optional[str] = None,
+    """`CredentialsStrategy` implementation which provides a bearer token for Posit Connect environments."""
+
+    def __init__(
+        self,
+        client: Optional[Client] = None,
+        user_session_token: Optional[str] = None,
     ):
         self._client = client
         self._user_session_token = user_session_token
         if self._user_session_token is None:
-            print() # log that we are falling back to client credentials
+            logging.info(
+                "ConnectStrategy will attempt to use OAuth Service Account credentials because user_session_token is not set."
+            )
 
     def auth_type(self) -> str:
         return POSIT_OAUTH_INTEGRATION_AUTH_TYPE
 
-    def __call__(self, *args, **kwargs) -> CredentialsProvider: # noqa: ARG002
+    def __call__(self, *args, **kwargs) -> CredentialsProvider:  # noqa: ARG002
         if not is_connect():
-            raise ValueError("The PositConnectCredentials is not supported for content running outside of Posit Connect.")
+            raise ValueError(
+                "The ConnectStrategy is not supported for content running outside of Posit Connect."
+            )
 
         if self._client is None:
             self._client = Client()
@@ -157,30 +168,32 @@ def new_config(
         Config
     """
     credentials_strategy = None
-    if 'credentials_strategy' in kwargs:
-        del kwargs['credentials_strategy']
+    if "credentials_strategy" in kwargs:
+        del kwargs["credentials_strategy"]
 
     if is_connect():
+        logging.info(
+            "Initializing ConnectStrategy because the content appears to be running on Posit Connect."
+        )
         if posit_connect_strategy is not None:
             credentials_strategy = posit_connect_strategy
         else:
             credentials_strategy = ConnectStrategy()
-    else:
-        print()
-        # log and continue
-
-    if is_workbench():
+    elif is_workbench():
+        logging.info(
+            "Initializing WorkbenchStrategy because the content appears to be running on Posit Workbench."
+        )
         if posit_workbench_strategy is not None:
             credentials_strategy = posit_workbench_strategy
         else:
             credentials_strategy = WorkbenchStrategy()
     else:
-        print()
-        # log and continue
-
-    if posit_default_strategy is not None:
-        credentials_strategy = posit_default_strategy 
-    else:
-        credentials_strategy = DefaultCredentials()
+        logging.info(
+            "Initializing default strategy because neither Posit Connect nor Posit Workbench were detected."
+        )
+        if posit_default_strategy is not None:
+            credentials_strategy = posit_default_strategy
+        else:
+            credentials_strategy = DefaultCredentials()
 
     return Config(credentials_strategy=credentials_strategy, **kwargs)