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

sempy_labs/report/_generate_report.py

@@ -6,15 +6,15 @@ from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _conv_b64,
-    resolve_report_id,
     resolve_dataset_name_and_id,
     resolve_item_name_and_id,
-    lro,
+    _update_dataframe_datatypes,
+    _base_api,
+    resolve_item_id,
 )
 import sempy_labs._icons as icons
 from sempy._utils._log import log
 from uuid import UUID
-from sempy.fabric.exceptions import FabricHTTPException
 
 
 def create_report_from_reportjson(
@@ -57,7 +57,6 @@ def create_report_from_reportjson(
         )
         return
 
-    client = fabric.FabricRestClient()
     defPBIR = {
         "version": "1.0",
         "datasetReference": {
@@ -106,9 +105,13 @@ def create_report_from_reportjson(
         }
         request_body["definition"]["parts"].append(part)
 
-    response = client.post(f"/v1/workspaces/{workspace_id}/reports", json=request_body)
-
-    lro(client, response, status_codes=[201, 202], return_status_code=True)
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/reports",
+        method="post",
+        payload=request_body,
+        lro_return_status_code=True,
+        status_codes=[201, 202],
+    )
 
     print(
         f"{icons.green_dot} Succesfully created the '{report}' report within the '{workspace_name}' workspace."
@@ -116,7 +119,7 @@ def create_report_from_reportjson(
 
 
 def update_report_from_reportjson(
-    report: str, report_json: dict, workspace: Optional[str | UUID] = None
+    report: str | UUID, report_json: dict, workspace: Optional[str | UUID] = None
 ):
     """
     Updates a report based on a report.json file.
@@ -125,8 +128,8 @@ def update_report_from_reportjson(
 
     Parameters
     ----------
-    report : str
-        Name of the report.
+    report : str | uuid.UUID
+        Name or ID of the report.
     report_json : dict
         The report.json file to be used to update the report.
     workspace : str | uuid.UUID, default=None
@@ -136,7 +139,7 @@ def update_report_from_reportjson(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    report_id = resolve_report_id(report=report, workspace=workspace_id)
+    report_id = resolve_item_id(item=report, type="Report", workspace=workspace)
 
     # Get the existing PBIR file
     df_items = get_report_definition(report=report, workspace=workspace_id)
@@ -144,7 +147,7 @@ def update_report_from_reportjson(
     rptDefFile = df_items_filt["payload"].iloc[0]
     payloadReportJson = _conv_b64(report_json)
 
-    request_body = {
+    payload = {
         "definition": {
             "parts": [
                 {
@@ -161,14 +164,14 @@ def update_report_from_reportjson(
         }
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/reports/{report_id}/updateDefinition",
-        json=request_body,
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/reports/{report_id}/updateDefinition",
+        method="post",
+        payload=payload,
+        lro_return_status_code=True,
+        status_codes=None,
     )
 
-    lro(client, response, return_status_code=True)
-
     print(
         f"{icons.green_dot} The '{report}' report within the '{workspace_name}' workspace has been successfully updated."
     )
@@ -200,15 +203,15 @@ def get_report_definition(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    report_id = resolve_item_id(item=report, type="Report", workspace=workspace)
 
-    report_id = resolve_report_id(report=report, workspace=workspace_id)
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/reports/{report_id}/getDefinition",
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/reports/{report_id}/getDefinition",
+        method="post",
+        lro_return_json=True,
+        status_codes=None,
     )
 
-    result = lro(client, response).json()
-
     if return_dataframe:
         return pd.json_normalize(result["definition"]["parts"])
     else:
@@ -238,8 +241,6 @@ def create_model_bpa_report(
         or if no lakehouse attached, resolves to the workspace of the notebook.
 
     """
-    # from sempy_labs._helper_functions import resolve_dataset_id
-
     (dataset_workspace_name, dataset_workspace_id) = resolve_workspace_name_and_id(
         dataset_workspace
     )
@@ -334,28 +335,30 @@ def _create_report(
     dfR_filt = dfR[dfR["Name"] == report]
 
     updated_report = False
-    client = fabric.FabricRestClient()
     # Create report if it does not exist
-    if len(dfR_filt) == 0:
-        response = client.post(
-            f"/v1/workspaces/{report_workspace_id}/reports",
-            json=request_body,
+    if dfR_filt.empty:
+        _base_api(
+            request=f"/v1/workspaces/{report_workspace_id}/reports",
+            method="post",
+            payload=request_body,
+            lro_return_status_code=True,
+            status_codes=[201, 202],
         )
 
-        lro(client, response, status_codes=[201, 202], return_status_code=True)
-
         print(
             f"{icons.green_dot} The '{report}' report has been created within the '{report_workspace}'"
         )
         updated_report = True
     # Update the report if it exists
-    elif len(dfR_filt) > 0 and overwrite:
+    elif not dfR_filt.empty and overwrite:
         report_id = dfR_filt["Id"].iloc[0]
-        response = client.post(
-            f"/v1/workspaces/{report_workspace_id}/reports/{report_id}/updateDefinition",
-            json=request_body,
+        _base_api(
+            request=f"/v1/workspaces/{report_workspace_id}/reports/{report_id}/updateDefinition",
+            method="post",
+            payload=request_body,
+            lro_return_status_code=True,
+            status_codes=None,
         )
-        lro(client, response, return_status_code=True)
         print(
             f"{icons.green_dot} The '{report}' report has been updated within the '{report_workspace}'"
         )
@@ -384,12 +387,9 @@ def _get_report(
         item=report, type="Report", workspace=workspace
     )
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1.0/myorg/groups/{workspace_id}/reports/{report_id}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
+    response = _base_api(
+        request=f"v1.0/myorg/groups/{workspace_id}/reports/{report_id}"
+    )
     result = response.json()
 
     new_data = {
@@ -412,7 +412,10 @@ def _get_report(
 
     df = pd.DataFrame([new_data])
 
-    bool_cols = ["Is From Pbix", "Is Owned By Me"]
-    df[bool_cols] = df[bool_cols].astype(bool)
+    column_map = {
+        "Is From Pbix": "bool",
+        "Is Owned By Me": "bool",
+    }
+    _update_dataframe_datatypes(dataframe=df, column_map=column_map)
 
     return df

sempy_labs/report/_paginated.py

@@ -1,15 +1,16 @@
-import sempy.fabric as fabric
 from typing import Optional
-from sempy.fabric.exceptions import FabricHTTPException
 import pandas as pd
 from uuid import UUID
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
+    _base_api,
+    resolve_item_id,
+    _create_dataframe,
 )
 
 
 def get_report_datasources(
-    report: str,
+    report: str | UUID,
     workspace: Optional[str | UUID] = None,
 ) -> pd.DataFrame:
     """
@@ -17,8 +18,8 @@ def get_report_datasources(
 
     Parameters
     ----------
-    report : str | List[str]
-        Name(s) of the Power BI report(s).
+    report : str | uuid.UUID
+        Name or ID of the Power BI report.
     workspace : str | uuid.UUID, default=None
         The name or ID of the Fabric workspace in which the report resides.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -30,33 +31,26 @@ def get_report_datasources(
         A pandas dataframe showing a list of data sources for the specified paginated report (RDL) from the specified workspace.
     """
 
-    df = pd.DataFrame(
-        columns=[
-            "Report Name",
-            "Report Id",
-            "Datasource Id",
-            "Datasource Type",
-            "Gateway Id",
-            "Server",
-            "Database",
-        ]
-    )
+    columns = {
+        "Report Name": "str",
+        "Report Id": "str",
+        "Datasource Id": "str",
+        "Datasource Type": "str",
+        "Gateway Id": "str",
+        "Server": "str",
+        "Database": "str",
+    }
+    df = _create_dataframe(columns=columns)
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    report_id = fabric.resolve_item_id(
-        item_name=report, type="PaginatedReport", workspace=workspace_id
+    report_id = resolve_item_id(
+        item=report, type="PaginatedReport", workspace=workspace
     )
 
-    client = fabric.PowerBIRestClient()
-
-    response = client.get(
-        f"/v1.0/myorg/groups/{workspace_id}/reports/{report_id}/datasources"
+    response = _base_api(
+        request=f"v1.0/myorg/groups/{workspace_id}/reports/{report_id}/datasources"
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     for i in response.json().get("value", []):
         conn = i.get("connectionDetails", {})
         new_data = {

sempy_labs/report/_report_functions.py

@@ -15,14 +15,14 @@ from sempy_labs._helper_functions import (
     resolve_lakehouse_name,
     language_validate,
     resolve_workspace_name_and_id,
-    lro,
     _decode_b64,
     resolve_dataset_id,
+    _update_dataframe_datatypes,
+    _base_api,
 )
 from typing import List, Optional, Union
 from sempy._utils._log import log
 import sempy_labs._icons as icons
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -57,12 +57,12 @@ def get_report_json(
     report_id = resolve_report_id(report=report, workspace=workspace_id)
     fmt = "PBIR-Legacy"
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/reports/{report_id}/getDefinition?format={fmt}"
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/reports/{report_id}/getDefinition?format={fmt}",
+        method="post",
+        lro_return_json=True,
+        status_codes=None,
     )
-
-    result = lro(client, response).json()
     df_items = pd.json_normalize(result["definition"]["parts"])
     df_items_filt = df_items[df_items["path"] == "report.json"]
     payload = df_items_filt["payload"].iloc[0]
@@ -284,7 +284,6 @@ def export_report(
         )
 
     reportId = dfI_filt["Id"].iloc[0]
-    client = fabric.PowerBIRestClient()
 
     if (
         export_format in ["BMP", "EMF", "GIF", "JPEG", "TIFF"]
@@ -362,31 +361,35 @@ def export_report(
         ]
 
     base_url = f"/v1.0/myorg/groups/{workspace_id}/reports/{reportId}"
-    response = client.post(f"{base_url}/ExportTo", json=request_body)
-
-    if response.status_code == 202:
-        response_body = json.loads(response.content)
-        export_id = response_body["id"]
-        response = client.get(f"{base_url}/exports/{export_id}")
+    response = _base_api(
+        request=f"{base_url}/ExportTo",
+        method="post",
+        payload=request_body,
+        status_codes=202,
+    )
+    export_id = json.loads(response.content).get("id")
+
+    get_status_url = f"{base_url}/exports/{export_id}"
+    response = _base_api(request=get_status_url, status_codes=[200, 202])
+    response_body = json.loads(response.content)
+    while response_body["status"] not in ["Succeeded", "Failed"]:
+        time.sleep(3)
+        response = _base_api(request=get_status_url, status_codes=[200, 202])
         response_body = json.loads(response.content)
-        while response_body["status"] not in ["Succeeded", "Failed"]:
-            time.sleep(3)
-            response = client.get(f"{base_url}/exports/{export_id}")
-            response_body = json.loads(response.content)
-        if response_body["status"] == "Failed":
-            raise ValueError(
-                f"{icons.red_dot} The export for the '{report}' report within the '{workspace_name}' workspace in the '{export_format}' format has failed."
-            )
-        else:
-            response = client.get(f"{base_url}/exports/{export_id}/file")
-            print(
-                f"{icons.in_progress} Saving the '{export_format}' export for the '{report}' report within the '{workspace_name}' workspace to the lakehouse..."
-            )
-            with open(filePath, "wb") as export_file:
-                export_file.write(response.content)
-            print(
-                f"{icons.green_dot} The '{export_format}' export for the '{report}' report within the '{workspace_name}' workspace has been saved to the following location: '{filePath}'."
-            )
+    if response_body["status"] == "Failed":
+        raise ValueError(
+            f"{icons.red_dot} The export for the '{report}' report within the '{workspace_name}' workspace in the '{export_format}' format has failed."
+        )
+    else:
+        response = _base_api(request=f"{get_status_url}/file")
+        print(
+            f"{icons.in_progress} Saving the '{export_format}' export for the '{report}' report within the '{workspace_name}' workspace to the lakehouse..."
+        )
+        with open(filePath, "wb") as export_file:
+            export_file.write(response.content)
+        print(
+            f"{icons.green_dot} The '{export_format}' export for the '{report}' report within the '{workspace_name}' workspace has been saved to the following location: '{filePath}'."
+        )
 
 
 def clone_report(
@@ -452,20 +455,17 @@ def clone_report(
             f"{icons.warning} The 'report' and 'cloned_report' parameters have the same value of '{report}. The 'workspace' and 'target_workspace' have the same value of '{workspace_name}'. Either the 'cloned_report' or the 'target_workspace' must be different from the original report."
         )
 
-    client = fabric.PowerBIRestClient()
-
-    request_body = {"name": cloned_report}
+    payload = {"name": cloned_report}
     if target_dataset is not None:
-        request_body["targetModelId"] = target_dataset_id
+        payload["targetModelId"] = target_dataset_id
     if target_workspace != workspace_name:
-        request_body["targetWorkspaceId"] = target_workspace_id
+        payload["targetWorkspaceId"] = target_workspace_id
 
-    response = client.post(
-        f"/v1.0/myorg/groups/{workspace_id}/reports/{reportId}/Clone", json=request_body
+    _base_api(
+        request=f"/v1.0/myorg/groups/{workspace_id}/reports/{reportId}/Clone",
+        method="post",
+        payload=payload,
     )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
     print(
         f"{icons.green_dot} The '{report}' report has been successfully cloned as the '{cloned_report}' report within the '{target_workspace}' workspace."
     )
@@ -554,9 +554,14 @@ def list_report_pages(report: str, workspace: Optional[str | UUID] = None):
         }
         df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    df["Hidden"] = df["Hidden"].astype(bool)
-    intCol = ["Width", "Height", "Visual Count"]
-    df[intCol] = df[intCol].astype(int)
+    column_map = {
+        "Hidden": "bool",
+        "Width": "int",
+        "Height": "int",
+        "Visual Count": "int",
+    }
+
+    _update_dataframe_datatypes(dataframe=df, column_map=column_map)
 
     return df
 

sempy_labs/report/_report_list_functions.py

@@ -38,6 +38,8 @@ def list_unused_objects_in_reports(
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     (dataset_name, dataset_id) = resolve_dataset_name_and_id(dataset, workspace_id)
 
+    fabric.refresh_tom_cache(workspace=workspace)
+
     dfR = _list_all_report_semantic_model_objects(
         dataset=dataset_id, workspace=workspace_id
     )

sempy_labs/report/_report_rebind.py

@@ -3,11 +3,11 @@ from sempy_labs._helper_functions import (
     resolve_dataset_id,
     resolve_workspace_name_and_id,
     resolve_report_id,
+    _base_api,
 )
 from typing import Optional, List
 from sempy._utils._log import log
 import sempy_labs._icons as icons
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -46,8 +46,6 @@ def report_rebind(
     if dataset_workspace is None:
         dataset_workspace = report_workspace_name
 
-    client = fabric.PowerBIRestClient()
-
     if isinstance(report, str):
         report = [report]
 
@@ -55,16 +53,14 @@ def report_rebind(
         report_id = resolve_report_id(report=rpt, workspace=report_workspace_id)
         dataset_id = resolve_dataset_id(dataset=dataset, workspace=dataset_workspace)
 
-        # Prepare API
-        request_body = {"datasetId": dataset_id}
+        payload = {"datasetId": dataset_id}
 
-        response = client.post(
-            f"/v1.0/myorg/groups/{report_workspace_id}/reports/{report_id}/Rebind",
-            json=request_body,
+        _base_api(
+            request=f"v1.0/myorg/groups/{report_workspace_id}/reports/{report_id}/Rebind",
+            method="post",
+            json=payload,
         )
 
-        if response.status_code != 200:
-            raise FabricHTTPException(response)
         print(
             f"{icons.green_dot} The '{rpt}' report has been successfully rebinded to the '{dataset}' semantic model."
         )