dasl-client 1.0.27__py3-none-any.whl → 1.0.28__py3-none-any.whl

dasl_client/client.py

@@ -29,6 +29,7 @@ from dasl_client.auth.auth import (
     DatabricksTokenAuth,
     ServiceAccountKeyAuth,
 )
+from dasl_client.metadata import WorkspaceMetadata
 from dasl_client.conn.conn import get_base_conn
 from dasl_client.errors.errors import ConflictError, error_handler
 from .helpers import Helpers
@@ -79,7 +80,7 @@ class Client:
         service_principal_id: str,
         service_principal_secret: str,
         workspace_url: Optional[str] = None,
-        region: str = Helpers.default_region,
+        region: Optional[str] = None,
         dasl_host: Optional[str] = None,
     ) -> "Client":
         """
@@ -98,18 +99,24 @@ class Client:
             being registered. If you omit this value, it will be inferred
             if you are running within a Databricks notebook. Otherwise, an
             exception will be raised.
-        :param region: The name of the DASL region.
+        :param region: The name of the DASL region. If not specified,
+            the client will auto-detect the region from the workspace
+            URL. For a DASL region, this includes the cloud host, e.g.
+            aws-us-east-1.
         :param dasl_host: The URL of the DASL server. This value should
             not generally be specified. When specified, this value
-            overrides region.
+            overrides both region and auto-detection.
         :returns: Client for the newly created workspace.
         """
-        if dasl_host is None:
-            dasl_host = Regions.lookup(region)
-
         with error_handler():
             if workspace_url is None:
                 workspace_url = Helpers.current_workspace_url()
+
+            # Determine the DASL host to use
+            dasl_host = Client._dasl_host_from_workspace_metadata(
+                workspace_url, dasl_host, region
+            )
+
             admin_config = AdminConfig(
                 workspace_url=workspace_url,
                 app_client_id=app_client_id,
@@ -137,7 +144,7 @@ class Client:
     def for_workspace(
         workspace_url: Optional[str] = None,
         service_account_token: Optional[str] = None,
-        region: str = Helpers.default_region,
+        region: Optional[str] = None,
         dasl_host: Optional[str] = None,
     ) -> "Client":
         """
@@ -151,19 +158,24 @@ class Client:
         :param service_account_token: Antimatter service account token.
             If provided, the client will use this token for auth instead
             of (automatic) secret-based auth.
-        :param region: The name of the DASL region.
+        :param region: The name of the DASL region. If not specified,
+            the client will auto-detect the region from the workspace
+            URL. For a DASL region, this includes the cloud host, e.g.
+            aws-us-east-1.
         :param dasl_host: The URL of the DASL server. This value should
             not generally be specified. When specified, this value
-            overrides region.
+            overrides both region and auto-detection.
         :returns: Client for the existing workspace.
         """
-        if dasl_host is None:
-            dasl_host = Regions.lookup(region)
-
         with error_handler():
             if workspace_url is None:
                 workspace_url = Helpers.current_workspace_url()
 
+            # Determine the DASL host to use
+            dasl_host = Client._dasl_host_from_workspace_metadata(
+                workspace_url, dasl_host, region
+            )
+
             if service_account_token is None:
                 return Client(
                     DatabricksSecretAuth(
@@ -188,7 +200,7 @@ class Client:
         service_principal_secret: str,
         workspace_url: Optional[str] = None,
         service_account_token: Optional[str] = None,
-        region: str = Helpers.default_region,
+        region: Optional[str] = None,
         dasl_host: Optional[str] = None,
     ) -> "Client":
         """
@@ -220,10 +232,13 @@ class Client:
             If provided, the client will use this token for auth instead
             of (automatic) secret-based auth. Ignored if the workspace
             doesn't exist.
-        :param region: The name of the DASL region.
+        :param region: The name of the DASL region. If not specified,
+            the client will auto-detect the region from the workspace
+            URL. For a DASL region, this includes the cloud host, e.g.
+            aws-us-east-1.
         :param dasl_host: The URL of the DASL server. This value should
             not generally be specified. When specified, this value
-            overrides region.
+            overrides both region and auto-detection.
         :returns: Client for the newly created or existing workspace.
         """
         try:
@@ -990,3 +1005,52 @@ class Client:
         """
         with error_handler():
             return self._dbui_client().dbui_v1_query_cancel(self._workspace(), id)
+
+    @staticmethod
+    def _dasl_host_from_workspace_metadata(
+        workspace_url: str, dasl_host: Optional[str], region: Optional[str]
+    ) -> str:
+        """
+        If the dasl_host is already set, it will be returned as-is. If a region
+        is set, this will return the host that region maps to. If neither are
+        set, this gets the DASL host from the workspace URL with a workspace
+        metadata lookup.
+
+        :param workspace_url: The full base URL of the Databricks workspace
+            being registered. If you omit this value, it will be inferred
+            if you are running within a Databricks notebook. Otherwise, an
+            exception will be raised.
+        :param dasl_host: The URL of the DASL server. This value should
+            not generally be specified. When specified, this value
+            overrides both region and auto-detection.
+        :param region: The name of the DASL region. If not specified,
+            the client will auto-detect the region from the workspace
+            URL. For a DASL region, this includes the cloud host, e.g.
+            aws-us-east-1.
+        :return: The DASL host to use.
+        """
+        if dasl_host is None:
+            if region is not None:
+                # Use explicit region
+                dasl_host = Regions.lookup(region)
+            else:
+                # Attempt auto-detection from workspace URL
+                try:
+                    metadata = WorkspaceMetadata.get_workspace_metadata(workspace_url)
+                    if metadata is not None:
+                        dasl_host = metadata.api_url
+                    else:
+                        raise Exception(
+                            f"Could not determine API endpoint for workspace '{workspace_url}'. "
+                            f"The workspace may not be in a supported region. "
+                            f"Please specify 'region' or 'dasl_host' explicitly."
+                        )
+                except Exception as e:
+                    if "Could not determine API endpoint" in str(e):
+                        raise
+                    else:
+                        raise Exception(
+                            f"Failed to auto-detect API endpoint for workspace '{workspace_url}': {e}. "
+                            f"Please specify 'region' or 'dasl_host' explicitly."
+                        )
+        return dasl_host

dasl_client/metadata.py

@@ -0,0 +1,74 @@
+import base64
+from typing import Optional
+
+from dasl_api import ApiClient, Configuration, WorkspaceV1Api
+from dasl_api.models import WorkspaceV1WorkspaceMetadata
+from dasl_api.exceptions import ApiException
+
+
+class WorkspaceMetadata:
+    """Workspace metadata lookup functionality for auto-detecting API endpoints."""
+
+    @staticmethod
+    def get_workspace_metadata(
+        workspace_url: str, dasl_host: Optional[str] = None
+    ) -> Optional[WorkspaceV1WorkspaceMetadata]:
+        """
+        Query the workspace metadata endpoint to auto-detect the correct region
+        and API endpoint for a given Databricks workspace.
+
+        :param workspace_url: The Databricks workspace URL to lookup
+        :param dasl_host: Optional DASL host to use for the lookup. If None, uses default region.
+        :returns: WorkspaceV1WorkspaceMetadata if successful, None if workspace not found
+        """
+        if dasl_host is None:
+            # Use default region for metadata lookup
+            from .regions import Regions
+            from .helpers import Helpers
+
+            dasl_host = Regions.lookup(Helpers.default_region)
+
+        try:
+            # Create an unauthenticated client for the public metadata endpoint
+            configuration = Configuration(host=dasl_host)
+            api_client = ApiClient(configuration)
+            workspace_api = WorkspaceV1Api(api_client)
+
+            # Base64 encode the workspace URL
+            encoded_workspace = base64.urlsafe_b64encode(
+                workspace_url.encode()
+            ).decode()
+
+            # Call the metadata endpoint
+            metadata = workspace_api.workspace_v1_get_workspace_metadata(
+                databricks_workspace=encoded_workspace
+            )
+
+            return metadata
+
+        except ApiException as e:
+            if e.status == 404:
+                # Workspace not found or not in supported region
+                return None
+            elif e.status == 400:
+                # Invalid workspace URL
+                raise ValueError(f"Invalid workspace URL: {workspace_url}")
+            else:
+                # Other API errors
+                raise Exception(f"Failed to get workspace metadata: {e}")
+        except Exception as e:
+            # Network errors, encoding errors, etc.
+            raise Exception(f"Failed to lookup workspace metadata: {e}")
+
+    @staticmethod
+    def get_endpoint_for_workspace(workspace_url: str) -> Optional[str]:
+        """
+        Get the API endpoint URL for a workspace.
+
+        :param workspace_url: The Databricks workspace URL
+        :returns: API endpoint URL if successful, None if workspace not found
+        """
+        metadata = WorkspaceMetadata.get_workspace_metadata(workspace_url)
+        if metadata is not None:
+            return metadata.api_url
+        return None

{dasl_client-1.0.27.dist-info → dasl_client-1.0.28.dist-info}/METADATA

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: dasl_client
-Version: 1.0.27
+Version: 1.0.28
 Summary: The DASL client library used for interacting with the DASL workspace
 Author-email: Antimatter Team <support@antimatter.io>
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: dasl_api==0.1.26
+Requires-Dist: dasl_api==0.1.27
 Requires-Dist: databricks-sdk>=0.41.0
 Requires-Dist: pydantic>=2
 Requires-Dist: typing_extensions>=4.10.0

{dasl_client-1.0.27.dist-info → dasl_client-1.0.28.dist-info}/RECORD

@@ -1,7 +1,8 @@
 dasl_client/__init__.py,sha256=MuaH74tnEHwfymHtlK6GqeMHRRWaSDfS6hSzbMrd7iQ,150
-dasl_client/client.py,sha256=L6Vlzj96CRZ-SeSW9le005IsA52YPcgb6KZBCD29LrI,38983
+dasl_client/client.py,sha256=WRQsJxMAleaGLV12O1NwKa5LrsGygNGidMuhEQZ87MA,42242
 dasl_client/exec_rule.py,sha256=kn-Yo-9L0fjxbulyAghiIKO1SYcqv2XHZn45F8FvUzE,3599
 dasl_client/helpers.py,sha256=kdOoNiyoVzfDHAZ5DGg5YTU4Fj9A5a8gz2RljrY8hbY,1095
+dasl_client/metadata.py,sha256=GlPkkwfTBXSr3RnTYB8E2Y-weLnrVOBe2oYCFiwl8o0,2827
 dasl_client/regions.json,sha256=Rvs_gslMuaod_n6LYLLrTAugtr7VNTljnFUiKf_0qNA,137
 dasl_client/regions.py,sha256=1TIlyJ4iMLsfgeb0ShQsfsju2_NBSXnMAfjdSNMQgi8,442
 dasl_client/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -25,8 +26,8 @@ dasl_client/types/helpers.py,sha256=gLGTvrssAKrdkQT9h80twEosld2egwhvj-zAudxWFPs,
 dasl_client/types/rule.py,sha256=5zvRsqzsej5kYTFjIpP1lptb3Rtit06cxvA4sl89OMU,28734
 dasl_client/types/types.py,sha256=DeUOfdYGOhUGEy7yKOfo0OYTXYRrs57yYgNLUbu7Tlc,8806
 dasl_client/types/workspace_config.py,sha256=XkSmeuOA3OPpWQkx7apPcPNuD4Ai2QO3YKU-aFoOW8k,31030
-dasl_client-1.0.27.dist-info/licenses/LICENSE,sha256=M35UepUPyKmFkvENlkweeaMElheQqNoM5Emh8ADO-rs,4
-dasl_client-1.0.27.dist-info/METADATA,sha256=pTORHSM3o9x_3u1J47vEwpzbosz_0Ojv--r45_fMtjI,4046
-dasl_client-1.0.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dasl_client-1.0.27.dist-info/top_level.txt,sha256=kIv8ox_2oJPjGB8_yuey5vvuPCyfY8kywG138f9oSOY,12
-dasl_client-1.0.27.dist-info/RECORD,,
+dasl_client-1.0.28.dist-info/licenses/LICENSE,sha256=M35UepUPyKmFkvENlkweeaMElheQqNoM5Emh8ADO-rs,4
+dasl_client-1.0.28.dist-info/METADATA,sha256=A9J1hVHFox6Mq7cLnFB4kk-ak3vK7LUy90RSxx2Nna8,4046
+dasl_client-1.0.28.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dasl_client-1.0.28.dist-info/top_level.txt,sha256=kIv8ox_2oJPjGB8_yuey5vvuPCyfY8kywG138f9oSOY,12
+dasl_client-1.0.28.dist-info/RECORD,,