semantic-link-labs 0.9.0__py3-none-any.whl → 0.9.2__py3-none-any.whl

sempy_labs/_gateways.py

@@ -1,14 +1,14 @@
-import sempy.fabric as fabric
 from sempy._utils._log import log
 import pandas as pd
 from typing import Optional
-from sempy.fabric.exceptions import FabricHTTPException
 from sempy_labs._helper_functions import (
-    pagination,
     _is_valid_uuid,
     resolve_capacity_id,
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
+    _update_dataframe_datatypes,
+    _base_api,
+    _create_dataframe,
 )
 from uuid import UUID
 import sempy_labs._icons as icons
@@ -27,28 +27,21 @@ def list_gateways() -> pd.DataFrame:
         A pandas dataframe showing a list of all gateways the user has permission for, including on-premises, on-premises (personal mode), and virtual network gateways.
     """
 
-    client = fabric.FabricRestClient()
-    response = client.get("/v1/gateways")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
-
-    df = pd.DataFrame(
-        columns=[
-            "Gateway Name",
-            "Gateway Id",
-            "Type",
-            "Public Key Exponent",
-            "Public Key Modulus",
-            "Version",
-            "Number Of Member Gateways",
-            "Load Balancing Setting",
-            "Allow Cloud Connection Refresh",
-            "Allow Custom Connectors",
-        ]
-    )
+    columns = {
+        "Gateway Name": "string",
+        "Gateway Id": "string",
+        "Type": "string",
+        "Public Key Exponent": "string",
+        "Public Key Modulus": "string",
+        "Version": "string",
+        "Number Of Member Gateways": "int",
+        "Load Balancing Setting": "string",
+        "Allow Cloud Connection Refresh": "bool",
+        "Allow Custom Connectors": "bool",
+    }
+    df = _create_dataframe(columns=columns)
+
+    responses = _base_api(request="/v1/gateways", uses_pagination=True)
 
     for r in responses:
         for v in r.get("value", []):
@@ -67,10 +60,7 @@ def list_gateways() -> pd.DataFrame:
 
             df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    int_cols = ["Number Of Member Gateways"]
-    bool_cols = ["Allow Cloud Connection Refresh", "Allow Custom Connectors"]
-    df[bool_cols] = df[bool_cols].astype(bool)
-    df[int_cols] = df[int_cols].astype(int)
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
@@ -102,12 +92,7 @@ def delete_gateway(gateway: str | UUID):
     """
 
     gateway_id = _resolve_gateway_id(gateway)
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/gateways/{gateway_id}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
+    _base_api(request=f"/v1/gateways/{gateway_id}", method="delete")
     print(f"{icons.green_dot} The '{gateway}' gateway has been deleted.")
 
 
@@ -128,16 +113,17 @@ def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
         A pandas dataframe showing a list of gateway role assignments.
     """
 
+    columns = {
+        "Gateway Role Assignment Id": "string",
+        "Principal Id": "string",
+        "Principal Type": "string",
+        "Role": "string",
+    }
+    df = _create_dataframe(columns=columns)
     gateway_id = _resolve_gateway_id(gateway)
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/gateways/{gateway_id}/roleAssignments")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    df = pd.DataFrame(columns=[])
-
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/gateways/{gateway_id}/roleAssignments", uses_pagination=True
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -153,7 +139,7 @@ def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
     return df
 
 
-def delete_gateway_role_assignment(gateway: str | UUID, role_assignement_id: UUID):
+def delete_gateway_role_assignment(gateway: str | UUID, role_assignment_id: UUID):
     """
     Delete the specified role assignment for the gateway.
 
@@ -163,21 +149,18 @@ def delete_gateway_role_assignment(gateway: str | UUID, role_assignement_id: UUI
     ----------
     gateway : str | uuid.UUID
         The gateway name or ID.
-    role_assignement_id : uuid.UUID
+    role_assignment_id : uuid.UUID
         The role assignment ID.
     """
 
     gateway_id = _resolve_gateway_id(gateway)
-    client = fabric.FabricRestClient()
-    response = client.delete(
-        f"/v1/gateways/{gateway_id}/roleAssignments/{role_assignement_id}"
+    _base_api(
+        request=f"/v1/gateways/{gateway_id}/roleAssignments/{role_assignment_id}",
+        method="delete",
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     print(
-        f"{icons.green_dot} The '{role_assignement_id}' role assignment for the '{gateway}' gateway has been deleted."
+        f"{icons.green_dot} The '{role_assignment_id}' role assignment for the '{gateway}' gateway has been deleted."
     )
 
 
@@ -217,12 +200,7 @@ def delete_gateway_member(gateway: str | UUID, gateway_member: str | UUID):
         gateway=gateway_id, gateway_member=gateway_member
     )
 
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/gateways/{gateway_id}/members/{member_id}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
+    _base_api(request=f"/v1/gateways/{gateway_id}/members/{member_id}", method="delete")
     print(
         f"{icons.green_dot} The '{member_id}' member for the '{gateway}' gateway has been deleted."
     )
@@ -246,22 +224,18 @@ def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
     """
 
     gateway_id = _resolve_gateway_id(gateway)
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/gateways/{gateway_id}/members")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    df = pd.DataFrame(
-        columns=[
-            "Member Id",
-            "Member Name",
-            "Public Key Exponent",
-            "Public Key Modulus",
-            "Version",
-            "Enabled",
-        ]
-    )
+
+    columns = {
+        "Member Id": "string",
+        "Member Name": "string",
+        "Public Key Exponent": "string",
+        "Public Key Modulus": "string",
+        "Version": "string",
+        "Enabled": "bool",
+    }
+    df = _create_dataframe(columns=columns)
+
+    response = _base_api(request=f"/v1/gateways/{gateway_id}/members")
 
     for v in response.json().get("value", []):
         new_data = {
@@ -275,8 +249,7 @@ def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
 
         df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    bool_cols = ["Enabled"]
-    df[bool_cols] = df[bool_cols].astype(bool)
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
@@ -316,8 +289,6 @@ def create_vnet_gateway(
         The name of the subnet.
     """
 
-    client = fabric.FabricRestClient()
-
     capacity_id = resolve_capacity_id(capacity)
     payload = {
         "type": "VirtualNetwork",
@@ -332,10 +303,8 @@ def create_vnet_gateway(
         "inactivityMinutesBeforeSleep": inactivity_minutes_before_sleep,
         "numberOfMemberGateways": number_of_member_gateways,
     }
-    response = client.post("/v1/gateways", json=payload)
 
-    if response.status_code != 201:
-        raise FabricHTTPException(response)
+    _base_api(request="/v1/gateways", method="post", payload=payload, status_codes=201)
 
     print(
         f"{icons.green_dot} The '{name}' gateway was created within the '{capacity}' capacity."
@@ -383,11 +352,7 @@ def update_on_premises_gateway(
 
     payload["type"] = "OnPremises"
 
-    client = fabric.FabricRestClient()
-    response = client.patch(f"/v1/gateways/{gateway_id}", json=payload)
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    _base_api(request=f"/v1/gateways/{gateway_id}", method="patch", payload=payload)
 
     print(f"{icons.green_dot} The '{gateway}' has been updated accordingly.")
 
@@ -434,12 +399,7 @@ def update_vnet_gateway(
 
     payload["type"] = "VirtualNetwork"
 
-    client = fabric.FabricRestClient()
-    response = client.patch(f"/v1/gateways/{gateway_id}", json=payload)
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
+    _base_api(request=f"/v1/gateways/{gateway_id}", method="patch", payload=payload)
     print(f"{icons.green_dot} The '{gateway}' has been updated accordingly.")
 
 
@@ -473,15 +433,11 @@ def bind_semantic_model_to_gateway(
         "gatewayObjectId": gateway_id,
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1.0/myorg/groups/{workspace_id}/datasets/{dataset_id}/Default.BindToGateway",
-        json=payload,
+    _base_api(
+        request=f"/v1.0/myorg/groups/{workspace_id}/datasets/{dataset_id}/Default.BindToGateway",
+        method="post",
+        payload=payload,
     )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     print(
         f"{icons.green_dot} The '{dataset_name}' semantic model within the '{workspace_name}' workspace has been binded to the '{gateway_id}' gateway."
     )

sempy_labs/_generate_semantic_model.py

@@ -10,7 +10,7 @@ from sempy_labs._helper_functions import (
     resolve_dataset_name_and_id,
     _conv_b64,
     _decode_b64,
-    lro,
+    _base_api,
 )
 from sempy_labs.lakehouse._lakehouse import lakehouse_attached
 import sempy_labs._icons as icons
@@ -145,18 +145,16 @@ def create_semantic_model_from_bim(
     dfI = fabric.list_datasets(workspace=workspace_id, mode="rest")
     dfI_filt = dfI[(dfI["Dataset Name"] == dataset)]
 
-    if len(dfI_filt) > 0:
+    if not dfI_filt.empty:
         raise ValueError(
             f"{icons.red_dot} The '{dataset}' semantic model already exists as a semantic model in the '{workspace_name}' workspace."
         )
 
-    client = fabric.FabricRestClient()
     defPBIDataset = {"version": "1.0", "settings": {}}
-
     payloadPBIDefinition = _conv_b64(defPBIDataset)
     payloadBim = _conv_b64(bim_file)
 
-    request_body = {
+    payload = {
         "displayName": dataset,
         "definition": {
             "parts": [
@@ -174,13 +172,14 @@ def create_semantic_model_from_bim(
         },
     }
 
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/semanticModels",
-        json=request_body,
+    _base_api(
+        request=f"v1/workspaces/{workspace_id}/semanticModels",
+        payload=payload,
+        method="post",
+        lro_return_status_code=True,
+        status_codes=[201, 202],
     )
 
-    lro(client, response, status_codes=[201, 202])
-
     print(
         f"{icons.green_dot} The '{dataset}' semantic model has been created within the '{workspace_name}' workspace."
     )
@@ -210,13 +209,11 @@ def update_semantic_model_from_bim(
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     (dataset_name, dataset_id) = resolve_dataset_name_and_id(dataset, workspace_id)
 
-    client = fabric.FabricRestClient()
     defPBIDataset = {"version": "1.0", "settings": {}}
-
     payloadPBIDefinition = _conv_b64(defPBIDataset)
     payloadBim = _conv_b64(bim_file)
 
-    request_body = {
+    payload = {
         "displayName": dataset_name,
         "definition": {
             "parts": [
@@ -234,13 +231,14 @@ def update_semantic_model_from_bim(
         },
     }
 
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/updateDefinition",
-        json=request_body,
+    _base_api(
+        request=f"v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/updateDefinition",
+        payload=payload,
+        method="post",
+        lro_return_status_code=True,
+        status_codes=None,
     )
 
-    lro(client, response, status_codes=[200, 202], return_status_code=True)
-
     print(
         f"{icons.green_dot} The '{dataset_name}' semantic model has been updated within the '{workspace_name}' workspace."
     )
@@ -333,7 +331,6 @@ def get_semantic_model_bim(
     dataset: str | UUID,
     workspace: Optional[str | UUID] = None,
     save_to_file_name: Optional[str] = None,
-    lakehouse_workspace: Optional[str] = None,
 ) -> dict:
     """
     Extracts the Model.bim file for a given semantic model.
@@ -348,10 +345,6 @@ def get_semantic_model_bim(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     save_to_file_name : str, default=None
         If specified, saves the Model.bim as a file in the lakehouse attached to the notebook.
-    lakehouse_workspace : str, default=None
-        The Fabric workspace name in which the lakehouse attached to the workspace resides.
-        Defaults to None which resolves to the workspace of the attached lakehouse
-        or if no lakehouse attached, resolves to the workspace of the notebook.
 
     Returns
     -------
@@ -375,9 +368,7 @@ def get_semantic_model_bim(
                 f"{icons.red_dot} In order to save the model.bim file, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook."
             )
 
-        lakehouse_id = fabric.get_lakehouse_id()
-        lake_workspace = fabric.resolve_workspace_name()
-        lakehouse = resolve_lakehouse_name(lakehouse_id, lake_workspace)
+        lakehouse = resolve_lakehouse_name()
         folderPath = "/lakehouse/default/Files"
         fileExt = ".bim"
         if not save_to_file_name.endswith(fileExt):
@@ -437,11 +428,12 @@ def get_semantic_model_definition(
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     (dataset_name, dataset_id) = resolve_dataset_name_and_id(dataset, workspace_id)
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/getDefinition?format={format}",
+    result = _base_api(
+        request=f"v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/getDefinition?format={format}",
+        method="post",
+        lro_return_json=True,
+        status_codes=None,
     )
-    result = lro(client, response).json()
 
     files = result["definition"]["parts"]
 

sempy_labs/_git.py

@@ -1,12 +1,10 @@
-import sempy.fabric as fabric
 import pandas as pd
 import sempy_labs._icons as icons
 from typing import Optional, List
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    lro,
+    _base_api,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -43,7 +41,7 @@ def connect_workspace_to_azure_dev_ops(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {
+    payload = {
         "gitProviderDetails": {
             "organizationName": organization_name,
             "projectName": project_name,
@@ -54,12 +52,11 @@ def connect_workspace_to_azure_dev_ops(
         }
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/git/connect", json=request_body
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/connect",
+        payload=payload,
+        method="post",
     )
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
 
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been connected to the '{project_name}' Git project in Azure DevOps within the '{repository_name}' repository."
@@ -102,7 +99,7 @@ def connect_workspace_to_github(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {
+    payload = {
         "gitProviderDetails": {
             "ownerName": owner_name,
             "gitProviderType": "GitHub",
@@ -116,12 +113,11 @@ def connect_workspace_to_github(
         },
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/git/connect", json=request_body
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/connect",
+        payload=payload,
+        method="post",
     )
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
 
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been connected to the '{repository_name}' GitHub repository."
@@ -144,10 +140,7 @@ def disconnect_workspace_from_git(workspace: Optional[str | UUID] = None):
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    client = fabric.FabricRestClient()
-    response = client.post(f"/v1/workspaces/{workspace_id}/git/disconnect")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    _base_api(request=f"/v1/workspaces/{workspace_id}/git/disconnect", method="post")
 
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been disconnected from Git."
@@ -189,13 +182,11 @@ def get_git_status(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         ]
     )
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/git/status")
-
-    if response.status_code not in [200, 202]:
-        raise FabricHTTPException(response)
-
-    result = lro(client, response).json()
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/status",
+        lro_return_json=True,
+        status_codes=None,
+    )
 
     for changes in result.get("changes", []):
         item_metadata = changes.get("itemMetadata", {})
@@ -252,11 +243,7 @@ def get_git_connection(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         ]
     )
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/git/connection")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    response = _base_api(request=f"/v1/workspaces/{workspace_id}/git/connection")
 
     r = response.json()
     provider_details = r.get("gitProviderDetails", {})
@@ -298,19 +285,18 @@ def initialize_git_connection(workspace: Optional[str | UUID] = None) -> str:
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    client = fabric.FabricRestClient()
-    response = client.post(f"/v1/workspaces/{workspace_id}/git/initializeConnection")
-
-    if response.status_code not in [200, 202]:
-        raise FabricHTTPException(response)
-
-    lro(client, response)
+    response_json = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/initializeConnection",
+        method="post",
+        lro_return_json=True,
+        status_codes=None,
+    )
 
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace git connection has been initialized."
     )
 
-    return response.json().get("remoteCommitHash")
+    return response_json.get("remoteCommitHash")
 
 
 def commit_to_git(
@@ -350,26 +336,23 @@ def commit_to_git(
         if isinstance(item_ids, str):
             item_ids = [item_ids]
 
-        request_body = {
+        payload = {
             "mode": commit_mode,
             "workspaceHead": workspace_head,
             "comment": comment,
         }
 
         if item_ids is not None:
-            request_body["items"] = [{"objectId": item_id} for item_id in item_ids]
-
-        client = fabric.FabricRestClient()
-        response = client.post(
-            f"/v1/workspaces/{workspace_id}/git/commitToGit",
-            json=request_body,
+            payload["items"] = [{"objectId": item_id} for item_id in item_ids]
+
+        _base_api(
+            request=f"/v1/workspaces/{workspace_id}/git/commitToGit",
+            method="post",
+            payload=payload,
+            lro_return_status_code=True,
+            status_codes=None,
         )
 
-        if response.status_code not in [200, 202]:
-            raise FabricHTTPException(response)
-
-        lro(client=client, response=response, return_status_code=True)
-
         if commit_mode == "All":
             print(
                 f"{icons.green_dot} All items within the '{workspace_name}' workspace have been committed to Git."
@@ -426,29 +409,26 @@ def update_from_git(
             f"{icons.red_dot} Invalid conflict resolution policy. Valid options: {conflict_resolution_policies}."
         )
 
-    request_body = {}
-    request_body["remoteCommitHash"] = remote_commit_hash
-    request_body["conflictResolution"] = {
+    payload = {}
+    payload["remoteCommitHash"] = remote_commit_hash
+    payload["conflictResolution"] = {
         "conflictResolutionType": "Workspace",
         "conflictResolutionPolicy": conflict_resolution_policy,
     }
 
     if workspace_head is not None:
-        request_body["workspaceHead"] = workspace_head
+        payload["workspaceHead"] = workspace_head
     if allow_override is not None:
-        request_body["options"] = {"allowOverrideItems": allow_override}
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/git/updateFromGit",
-        json=request_body,
+        payload["options"] = {"allowOverrideItems": allow_override}
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/updateFromGit",
+        method="post",
+        payload=payload,
+        lro_return_status_code=True,
+        status_codes=None,
     )
 
-    if response.status_code not in [200, 202]:
-        raise FabricHTTPException(response)
-
-    lro(client, response, return_status_code=True)
-
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been updated with commits pushed to the connected branch."
     )