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

sempy_labs/_deployment_pipelines.py

@@ -1,10 +1,12 @@
-import sempy.fabric as fabric
 import pandas as pd
 from sempy_labs._helper_functions import (
-    pagination,
+    _is_valid_uuid,
+    _base_api,
+    _update_dataframe_datatypes,
+    _create_dataframe,
 )
 import sempy_labs._icons as icons
-from sempy.fabric.exceptions import FabricHTTPException
+from uuid import UUID
 
 
 def list_deployment_pipelines() -> pd.DataFrame:
@@ -19,18 +21,19 @@ def list_deployment_pipelines() -> pd.DataFrame:
         A pandas dataframe showing a list of deployment pipelines the user can access.
     """
 
-    df = pd.DataFrame(
-        columns=["Deployment Pipeline Id", "Deployment Pipeline Name", "Description"]
+    columns = {
+        "Deployment Pipeline Id": "string",
+        "Deployment Pipeline Name": "string",
+        "Description": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    responses = _base_api(
+        request="/v1/deploymentPipelines",
+        status_codes=200,
+        uses_pagination=True,
     )
 
-    client = fabric.FabricRestClient()
-    response = client.get("/v1/deploymentPipelines")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
-
     for r in responses:
         for v in r.get("value", []):
             new_data = {
@@ -43,7 +46,7 @@ def list_deployment_pipelines() -> pd.DataFrame:
     return df
 
 
-def list_deployment_pipeline_stages(deployment_pipeline: str) -> pd.DataFrame:
+def list_deployment_pipeline_stages(deployment_pipeline: str | UUID) -> pd.DataFrame:
     """
     Shows the specified deployment pipeline stages.
 
@@ -51,8 +54,8 @@ def list_deployment_pipeline_stages(deployment_pipeline: str) -> pd.DataFrame:
 
     Parameters
     ----------
-    deployment_pipeline : str
-        The deployment pipeline name.
+    deployment_pipeline : str | uuid.UUID
+        The deployment pipeline name or ID.
 
     Returns
     -------
@@ -62,28 +65,26 @@ def list_deployment_pipeline_stages(deployment_pipeline: str) -> pd.DataFrame:
 
     from sempy_labs._helper_functions import resolve_deployment_pipeline_id
 
-    df = pd.DataFrame(
-        columns=[
-            "Deployment Pipeline Stage Id",
-            "Deployment Pipeline Stage Name",
-            "Order",
-            "Description",
-            "Workspace Id",
-            "Workspace Name",
-            "Public",
-        ]
-    )
+    columns = {
+        "Deployment Pipeline Stage Id": "string",
+        "Deployment Pipeline Stage Name": "string",
+        "Order": "int",
+        "Description": "string",
+        "Workspace Id": "string",
+        "Workspace Name": "string",
+        "Public": "bool",
+    }
+    df = _create_dataframe(columns=columns)
 
     deployment_pipeline_id = resolve_deployment_pipeline_id(
         deployment_pipeline=deployment_pipeline
     )
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/deploymentPipelines/{deployment_pipeline_id}/stages")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
 
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/deploymentPipelines/{deployment_pipeline_id}/stages",
+        status_codes=200,
+        uses_pagination=True,
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -98,14 +99,14 @@ def list_deployment_pipeline_stages(deployment_pipeline: str) -> pd.DataFrame:
             }
             df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    df["Order"] = df["Order"].astype(int)
-    df["Public"] = df["Public"].astype(bool)
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
 
 def list_deployment_pipeline_stage_items(
-    deployment_pipeline: str, stage_name: str
+    deployment_pipeline: str | UUID,
+    stage: str | UUID,
 ) -> pd.DataFrame:
     """
     Shows the supported items from the workspace assigned to the specified stage of the specified deployment pipeline.
@@ -114,10 +115,10 @@ def list_deployment_pipeline_stage_items(
 
     Parameters
     ----------
-    deployment_pipeline : str
-        The deployment pipeline name.
-    stage_name : str
-        The deployment pipeline stage name.
+    deployment_pipeline : str | uuid.UUID
+        The deployment pipeline name or ID.
+    stage : str | uuid.UUID
+        The deployment pipeline stage name or ID.
 
     Returns
     -------
@@ -127,39 +128,46 @@ def list_deployment_pipeline_stage_items(
 
     from sempy_labs._helper_functions import resolve_deployment_pipeline_id
 
-    df = pd.DataFrame(
-        columns=[
-            "Deployment Pipeline Stage Item Id",
-            "Deployment Pipeline Stage Item Name",
-            "Item Type",
-            "Source Item Id",
-            "Target Item Id",
-            "Last Deployment Time",
-        ]
-    )
+    columns = {
+        "Deployment Pipeline Stage Item Id": "string",
+        "Deployment Pipeline Stage Item Name": "string",
+        "Item Type": "string",
+        "Source Item Id": "string",
+        "Target Item Id": "string",
+        "Last Deployment Time": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
     deployment_pipeline_id = resolve_deployment_pipeline_id(
         deployment_pipeline=deployment_pipeline
     )
-    dfPS = list_deployment_pipeline_stages(deployment_pipeline=deployment_pipeline)
-    dfPS_filt = dfPS[dfPS["Deployment Pipeline Stage Name"] == stage_name]
 
-    if len(dfPS_filt) == 0:
-        raise ValueError(
-            f"{icons.red_dot} The '{stage_name}' stage does not exist within the '{deployment_pipeline}' deployment pipeline."
+    def resolve_deployment_pipeline_stage_id(
+        deployment_pipeline_id: UUID, stage: str | UUID
+    ):
+
+        dfPS = list_deployment_pipeline_stages(
+            deployment_pipeline=deployment_pipeline_id
         )
-    stage_id = dfPS_filt["Deployment Pipeline Stage Id"].iloc[0]
 
-    client = fabric.FabricRestClient()
-    response = client.get(
-        f"/v1/deploymentPipelines/{deployment_pipeline_id}/stages/{stage_id}/items"
+        if _is_valid_uuid(stage):
+            dfPS_filt = dfPS[dfPS["Deployment Pipeline Stage Id"] == stage]
+        else:
+            dfPS_filt = dfPS[dfPS["Deployment Pipeline Stage Name"] == stage]
+        if dfPS.empty:
+            raise ValueError(
+                f"{icons.red_dot} The '{stage}' stage does not exist within the '{deployment_pipeline}' deployment pipeline."
+            )
+        return dfPS_filt["Deployment Pipeline Stage Id"].iloc[0]
+
+    stage_id = resolve_deployment_pipeline_stage_id(deployment_pipeline_id, stage)
+
+    responses = _base_api(
+        request=f"/v1/deploymentPipelines/{deployment_pipeline_id}/stages/{stage_id}/items",
+        status_codes=200,
+        uses_pagination=True,
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
-
     for r in responses:
         for v in r.get("value", []):
             new_data = {
@@ -172,6 +180,4 @@ def list_deployment_pipeline_stage_items(
             }
             df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    df["Last Deployment Time"] = pd.to_datetime(df["Last Deployment Time"])
-
     return df

sempy_labs/_environments.py

@@ -1,13 +1,12 @@
-import sempy.fabric as fabric
 import pandas as pd
 import sempy_labs._icons as icons
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    lro,
-    pagination,
+    _base_api,
+    _print_success,
+    _create_dataframe,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -35,20 +34,23 @@ def create_environment(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {"displayName": environment}
+    payload = {"displayName": environment}
 
     if description:
-        request_body["description"] = description
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/environments", json=request_body
+        payload["description"] = description
+
+    _base_api(
+        request="/v1/workspaces/{workspace_id}/environments",
+        method="post",
+        payload=payload,
+        status_codes=[201, 202],
+        lro_return_status_code=True,
     )
-
-    lro(client, response, status_codes=[201, 202])
-
-    print(
-        f"{icons.green_dot} The '{environment}' environment has been created within the '{workspace_name}' workspace."
+    _print_success(
+        item_name=environment,
+        item_type="environment",
+        workspace_name=workspace_name,
+        action="created",
     )
 
 
@@ -71,16 +73,18 @@ def list_environments(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         A pandas dataframe showing the environments within a workspace.
     """
 
-    df = pd.DataFrame(columns=["Environment Name", "Environment Id", "Description"])
+    columns = {
+        "Environment Name": "string",
+        "Environment Id": "string",
+        "Description": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/environments")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/environments", uses_pagination=True
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -117,16 +121,15 @@ def delete_environment(environment: str, workspace: Optional[str | UUID] = None)
         environment=environment, workspace=workspace_id
     )
 
-    client = fabric.FabricRestClient()
-    response = client.delete(
-        f"/v1/workspaces/{workspace_id}/environments/{environment_id}"
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/environments/{environment_id}",
+        method="delete",
     )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    print(
-        f"{icons.green_dot} The '{environment}' environment within the '{workspace_name}' workspace has been deleted."
+    _print_success(
+        item_name=environment,
+        item_type="environment",
+        workspace_name=workspace_name,
+        action="deleted",
     )
 
 
@@ -153,13 +156,13 @@ def publish_environment(environment: str, workspace: Optional[str | UUID] = None
         environment=environment, workspace=workspace_id
     )
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/environments/{environment_id}/staging/publish"
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/environments/{environment_id}/staging/publish",
+        method="post",
+        lro_return_status_code=True,
+        status_codes=None,
     )
 
-    lro(client, response)
-
     print(
         f"{icons.green_dot} The '{environment}' environment within the '{workspace_name}' workspace has been published."
     )

sempy_labs/_eventhouses.py

@@ -1,13 +1,13 @@
 import sempy.fabric as fabric
 import pandas as pd
-import sempy_labs._icons as icons
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    lro,
-    pagination,
+    _base_api,
+    _print_success,
+    resolve_item_id,
+    _create_dataframe,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -33,20 +33,23 @@ def create_eventhouse(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {"displayName": name}
+    payload = {"displayName": name}
 
     if description:
-        request_body["description"] = description
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/eventhouses", json=request_body
+        payload["description"] = description
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/eventhouses",
+        method="post",
+        status_codes=[201, 202],
+        payload=payload,
+        lro_return_status_code=True,
     )
-
-    lro(client, response, status_codes=[201, 202])
-
-    print(
-        f"{icons.green_dot} The '{name}' eventhouse has been created within the '{workspace_name}' workspace."
+    _print_success(
+        item_name=name,
+        item_type="eventhouse",
+        workspace_name=workspace_name,
+        action="created",
     )
 
 
@@ -69,16 +72,18 @@ def list_eventhouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         A pandas dataframe showing the eventhouses within a workspace.
     """
 
-    df = pd.DataFrame(columns=["Eventhouse Name", "Eventhouse Id", "Description"])
+    columns = {
+        "Eventhouse Name": "string",
+        "Eventhouse Id": "string",
+        "Description": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/eventhouses")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/eventhouses", uses_pagination=True
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -109,17 +114,12 @@ def delete_eventhouse(name: str, workspace: Optional[str | UUID] = None):
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    item_id = fabric.resolve_item_id(
-        item_name=name, type="Eventhouse", workspace=workspace_id
-    )
-
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/workspaces/{workspace_id}/eventhouses/{item_id}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    print(
-        f"{icons.green_dot} The '{name}' eventhouse within the '{workspace_name}' workspace has been deleted."
+    item_id = resolve_item_id(item=name, type="Eventhouse", workspace=workspace)
+
+    fabric.delete_item(item_id=item_id, workspace=workspace)
+    _print_success(
+        item_name=name,
+        item_type="eventhouse",
+        workspace_name=workspace_name,
+        action="deleted",
     )

sempy_labs/_eventstreams.py

@@ -1,13 +1,13 @@
 import sempy.fabric as fabric
 import pandas as pd
-import sempy_labs._icons as icons
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    lro,
-    pagination,
+    _base_api,
+    _print_success,
+    resolve_item_id,
+    _create_dataframe,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -30,16 +30,17 @@ def list_eventstreams(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         A pandas dataframe showing the eventstreams within a workspace.
     """
 
-    df = pd.DataFrame(columns=["Eventstream Name", "Eventstream Id", "Description"])
+    columns = {
+        "Eventstream Name": "string",
+        "Eventstream Id": "string",
+        "Description": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/eventstreams")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/eventstreams", uses_pagination=True
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -75,24 +76,27 @@ def create_eventstream(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {"displayName": name}
+    payload = {"displayName": name}
 
     if description:
-        request_body["description"] = description
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/eventstreams", json=request_body
+        payload["description"] = description
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/eventstreams",
+        method="post",
+        payload=payload,
+        status_codes=[201, 202],
+        lro_return_status_code=True,
     )
-
-    lro(client, response, status_codes=[201, 202])
-
-    print(
-        f"{icons.green_dot} The '{name}' eventstream has been created within the '{workspace_name}' workspace."
+    _print_success(
+        item_name=name,
+        item_type="eventstream",
+        workspace_name=workspace_name,
+        action="created",
     )
 
 
-def delete_eventstream(name: str, workspace: Optional[str | UUID] = None):
+def delete_eventstream(name: str | UUID, workspace: Optional[str | UUID] = None):
     """
     Deletes a Fabric eventstream.
 
@@ -100,8 +104,8 @@ def delete_eventstream(name: str, workspace: Optional[str | UUID] = None):
 
     Parameters
     ----------
-    name: str
-        Name of the eventstream.
+    name: str | uuid.UUID
+        Name or ID of the eventstream.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -109,17 +113,12 @@ def delete_eventstream(name: str, workspace: Optional[str | UUID] = None):
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    item_id = fabric.resolve_item_id(
-        item_name=name, type="Eventstream", workspace=workspace_id
-    )
-
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/workspaces/{workspace_id}/eventstreams/{item_id}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    print(
-        f"{icons.green_dot} The '{name}' eventstream within the '{workspace_name}' workspace has been deleted."
+    item_id = resolve_item_id(item=name, type="Eventstream", workspace=workspace)
+
+    fabric.delete_item(item_id=item_id, workspace=workspace)
+    _print_success(
+        item_name=name,
+        item_type="eventstream",
+        workspace_name=workspace_name,
+        action="deleted",
     )

sempy_labs/_external_data_shares.py

@@ -5,9 +5,9 @@ from typing import Optional, List
 import sempy_labs._icons as icons
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    pagination,
+    _base_api,
+    _create_dataframe,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 
 
 def create_external_data_share(
@@ -48,15 +48,12 @@ def create_external_data_share(
 
     payload = {"paths": paths, "recipient": {"userPrincipalName": recipient}}
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares",
-        json=payload,
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares",
+        method="post",
+        status_codes=201,
+        payload=payload,
     )
-
-    if response.status_code != 201:
-        raise FabricHTTPException(response)
-
     print(
         f"{icons.green_dot} An external data share was created for the '{item_name}' {item_type} within the '{workspace_name}' workspace for the {paths} paths."
     )
@@ -92,14 +89,10 @@ def revoke_external_data_share(
         item_name=item_name, type=item_type, workspace=workspace_id
     )
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}/revoke"
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}/revoke",
+        method="post",
     )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     print(
         f"{icons.green_dot} The '{external_data_share_id}' external data share for the '{item_name}' {item_type} within the '{workspace_name}' workspace has been revoked."
     )
@@ -135,32 +128,26 @@ def list_external_data_shares_in_item(
         item_name=item_name, type=item_type, workspace=workspace_id
     )
 
-    client = fabric.FabricRestClient()
-    response = client.get(
-        f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares"
+    columns = {
+        "External Data Share Id": "string",
+        "Paths": "string",
+        "Creator Principal Id": "string",
+        "Creator Principal Type": "string",
+        "Recipient User Principal Name": "string",
+        "Status": "string",
+        "Expiration Time UTC": "string",
+        "Workspace Id": "string",
+        "Item Id": "string",
+        "Item Name": "string",
+        "Item Type": "string",
+        "Invitation URL": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares",
+        uses_pagination=True,
     )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    df = pd.DataFrame(
-        columns=[
-            "External Data Share Id",
-            "Paths",
-            "Creator Principal Id",
-            "Creater Principal Type",
-            "Recipient User Principal Name",
-            "Status",
-            "Expiration Time UTC",
-            "Workspace Id",
-            "Item Id",
-            "Item Name",
-            "Item Type",
-            "Invitation URL",
-        ]
-    )
-
-    responses = pagination(client, response)
     dfs = []
 
     for r in responses: