semantic-link-labs 0.8.2__py3-none-any.whl → 0.8.4__py3-none-any.whl

sempy_labs/migration/_refresh_calc_tables.py

@@ -26,6 +26,7 @@ def refresh_calc_tables(dataset: str, workspace: Optional[str] = None):
 
     spark = SparkSession.builder.getOrCreate()
     workspace = fabric.resolve_workspace_name(workspace)
+    icons.sll_tags.append("DirectLakeMigration")
 
     @retry(
         sleep_time=1,

sempy_labs/report/__init__.py

@@ -1,7 +1,9 @@
 from sempy_labs.report._reportwrapper import (
     ReportWrapper,
 )
-
+from sempy_labs.report._paginated import (
+    get_report_datasources,
+)
 from sempy_labs.report._generate_report import (
     create_report_from_reportjson,
     get_report_definition,
@@ -39,4 +41,5 @@ __all__ = [
     "ReportWrapper",
     "report_bpa_rules",
     "run_report_bpa",
+    "get_report_datasources",
 ]

sempy_labs/report/_generate_report.py

@@ -2,7 +2,6 @@ import sempy.fabric as fabric
 import pandas as pd
 import json
 import os
-import time
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
@@ -12,7 +11,6 @@ from sempy_labs._helper_functions import (
 )
 import sempy_labs._icons as icons
 from sempy._utils._log import log
-from sempy.fabric.exceptions import FabricHTTPException
 
 
 def create_report_from_reportjson(
@@ -25,6 +23,8 @@ def create_report_from_reportjson(
     """
     Creates a report based on a report.json file (and an optional themes.json file).
 
+    This is a wrapper function for the following API: `Items - Create Report <https://learn.microsoft.com/rest/api/fabric/report/items/create-report`_.
+
     Parameters
     ----------
     report : str
@@ -113,7 +113,7 @@ def create_report_from_reportjson(
 
     response = client.post(f"/v1/workspaces/{workspace_id}/reports", json=request_body)
 
-    lro(client, response, status_codes=[201, 202])
+    lro(client, response, status_codes=[201, 202], return_status_code=True)
 
     print(
         f"{icons.green_dot} Succesfully created the '{report}' report within the '{workspace}' workspace."
@@ -126,6 +126,8 @@ def update_report_from_reportjson(
     """
     Updates a report based on a report.json file.
 
+    This is a wrapper function for the following API: `Items - Update Report Definition <https://learn.microsoft.com/rest/api/fabric/report/items/update-report-definition`_.
+
     Parameters
     ----------
     report : str
@@ -181,6 +183,8 @@ def get_report_definition(report: str, workspace: Optional[str] = None) -> pd.Da
     """
     Gets the collection of definition files of a report.
 
+    This is a wrapper function for the following API: `Items - Get Report Definition <https://learn.microsoft.com/rest/api/fabric/report/items/get-report-definition`_.
+
     Parameters
     ----------
     report : str
@@ -313,50 +317,48 @@ def _create_report(
     dataset: str,
     dataset_workspace: Optional[str] = None,
     report_workspace: Optional[str] = None,
-    update_if_exists: bool = False,
+    overwrite: bool = False,
 ):
 
     from sempy_labs.report import report_rebind
 
     report_workspace = fabric.resolve_workspace_name(report_workspace)
     report_workspace_id = fabric.resolve_workspace_id(report_workspace)
-    client = fabric.FabricRestClient()
+    dataset_workspace = fabric.resolve_workspace_name(dataset_workspace)
 
     dfR = fabric.list_reports(workspace=report_workspace)
     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,
-            lro_wait=True,
         )
-        if response.status_code not in [200, 201]:
-            raise FabricHTTPException(response)
+
+        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 update_if_exists:
+    elif len(dfR_filt) > 0 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,
-            lro_wait=True,
         )
-        if response.status_code not in [200, 201]:
-            raise FabricHTTPException(response)
+        lro(client, response, return_status_code=True)
         print(
             f"{icons.green_dot} The '{report}' report has been updated within the '{report_workspace}'"
         )
         updated_report = True
     else:
         raise ValueError(
-            f"{icons.red_dot} The '{report}' report within the '{report_workspace}' workspace already exists and it was selected not to update it if the report already exists."
+            f"{icons.red_dot} The '{report}' report within the '{report_workspace}' workspace already exists and the 'overwrite' parameter was set to False."
         )
 
     # Rebind the report to the semantic model to make sure it is pointed at the correct semantic model

sempy_labs/report/_paginated.py

@@ -0,0 +1,74 @@
+import sempy.fabric as fabric
+from typing import Optional
+from sempy.fabric.exceptions import FabricHTTPException
+import pandas as pd
+
+
+def get_report_datasources(
+    report: str,
+    workspace: Optional[str] = None,
+) -> pd.DataFrame:
+    """
+    Returns a list of data sources for the specified paginated report (RDL) from the specified workspace.
+
+    Parameters
+    ----------
+    report : str | List[str]
+        Name(s) of the Power BI report(s).
+    workspace : str, default=None
+        The name of the Fabric workspace in which the report 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
+    -------
+    pandas.DataFrame
+        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",
+        ]
+    )
+
+    if workspace is None:
+        workspace_id = fabric.get_workspace_id()
+        workspace = fabric.resolve_workspace_name(workspace_id)
+    else:
+        workspace_id = fabric.resolve_workspace_id(workspace)
+
+    report_id = fabric.resolve_item_id(
+        item_name=report, type="PaginatedReport", workspace=workspace
+    )
+
+    client = fabric.PowerBIRestClient()
+
+    response = client.get(
+        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 = {
+            "Report Name": report,
+            "Report Id": report_id,
+            "Datasource Id": i.get("datasourceId"),
+            "Datasource Type": i.get("datasourceType"),
+            "Gateway Id": i.get("gatewayId"),
+            "Server": conn.get("server") if conn else None,
+            "Database": conn.get("database") if conn else None,
+        }
+
+        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df

sempy_labs/report/_report_bpa.py

@@ -10,6 +10,7 @@ from sempy_labs._helper_functions import (
     resolve_report_id,
     resolve_lakehouse_name,
     resolve_workspace_capacity,
+    _get_max_run_id,
 )
 from sempy_labs.lakehouse import get_lakehouse_tables, lakehouse_attached
 import sempy_labs._icons as icons
@@ -192,8 +193,6 @@ def run_report_bpa(
         return finalDF
 
     if export:
-        from pyspark.sql import SparkSession
-
         if not lakehouse_attached():
             raise ValueError(
                 f"{icons.red_dot} In order to export the BPA results, a lakehouse must be attached to the notebook."
@@ -202,7 +201,7 @@ def run_report_bpa(
         now = datetime.datetime.now()
         delta_table_name = "reportbparesults"
         lakehouse_id = fabric.get_lakehouse_id()
-        lake_workspace = fabric.get_workspace_id()
+        lake_workspace = fabric.resolve_workspace_name()
         lakehouse = resolve_lakehouse_name(
             lakehouse_id=lakehouse_id, workspace=lake_workspace
         )
@@ -210,15 +209,13 @@ def run_report_bpa(
         lakeT = get_lakehouse_tables(lakehouse=lakehouse, workspace=lake_workspace)
         lakeT_filt = lakeT[lakeT["Table Name"] == delta_table_name]
 
-        spark = SparkSession.builder.getOrCreate()
-        query = f"SELECT MAX(RunId) FROM {lakehouse}.{delta_table_name}"
-
         if len(lakeT_filt) == 0:
             runId = 1
         else:
-            dfSpark = spark.sql(query)
-            maxRunId = dfSpark.collect()[0][0]
-            runId = maxRunId + 1
+            max_run_id = _get_max_run_id(
+                lakehouse=lakehouse, table_name=delta_table_name
+            )
+            runId = max_run_id + 1
 
         export_df = finalDF.copy()
         capacity_id, capacity_name = resolve_workspace_capacity(workspace=workspace)
@@ -232,7 +229,7 @@ def run_report_bpa(
         export_df["Timestamp"] = now
         export_df["RunId"] = export_df["RunId"].astype(int)
 
-        export_df = [
+        export_df = export_df[
             [
                 "Capacity Name",
                 "Capacity Id",
@@ -249,6 +246,7 @@ def run_report_bpa(
                 "URL",
             ]
         ]
+
         save_as_delta_table(
             dataframe=export_df,
             delta_table_name=delta_table_name,

sempy_labs/report/_report_functions.py

@@ -33,6 +33,8 @@ def get_report_json(
     """
     Gets the report.json file content of a Power BI report.
 
+    This is a wrapper function for the following API: `Items - Get Report Definition <https://learn.microsoft.com/rest/api/fabric/report/items/get-report-definition`_.
+
     Parameters
     ----------
     report : str
@@ -157,6 +159,8 @@ def export_report(
     """
     Exports a Power BI report to a file in your lakehouse.
 
+    This is a wrapper function for the following APIs: `Reports - Export To File In Group <https://learn.microsoft.com/rest/api/power-bi/reports/export-to-file-in-group`_, `Reports - Get Export To File Status In Group <https://learn.microsoft.com/rest/api/power-bi/reports/get-export-to-file-status-in-group>`_, `Reports - Get File Of Export To File In Group <https://learn.microsoft.com/rest/api/power-bi/reports/get-file-of-export-to-file-in-group>`_.
+
     Parameters
     ----------
     report : str
@@ -181,6 +185,8 @@ def export_report(
     """
 
     # https://learn.microsoft.com/rest/api/power-bi/reports/export-to-file-in-group
+    # https://learn.microsoft.com/rest/api/power-bi/reports/get-export-to-file-status-in-group
+    # https://learn.microsoft.com/rest/api/power-bi/reports/get-file-of-export-to-file-in-group
 
     if not lakehouse_attached():
         raise ValueError(
@@ -222,7 +228,6 @@ def export_report(
     }
 
     export_format = export_format.upper()
-
     fileExt = validFormats.get(export_format)
     if fileExt is None:
         raise ValueError(
@@ -286,9 +291,6 @@ def export_report(
     reportId = dfI_filt["Id"].iloc[0]
     client = fabric.PowerBIRestClient()
 
-    dfVisual = list_report_visuals(report=report, workspace=workspace)
-    dfPage = list_report_pages(report=report, workspace=workspace)
-
     if (
         export_format in ["BMP", "EMF", "GIF", "JPEG", "TIFF"]
         and reportType == "PaginatedReport"
@@ -314,6 +316,7 @@ def export_report(
             request_body = {"format": export_format, "powerBIReportConfiguration": {}}
 
             request_body["powerBIReportConfiguration"]["pages"] = []
+            dfPage = list_report_pages(report=report, workspace=workspace)
 
             for page in page_name:
                 dfPage_filt = dfPage[dfPage["Page ID"] == page]
@@ -335,9 +338,11 @@ def export_report(
             request_body = {"format": export_format, "powerBIReportConfiguration": {}}
 
             request_body["powerBIReportConfiguration"]["pages"] = []
+            dfVisual = list_report_visuals(report=report, workspace=workspace)
             a = 0
             for page in page_name:
                 visual = visual_name[a]
+
                 dfVisual_filt = dfVisual[
                     (dfVisual["Page ID"] == page) & (dfVisual["Visual ID"] == visual)
                 ]
@@ -360,32 +365,25 @@ def export_report(
         request_body["powerBIReportConfiguration"]["reportLevelFilters"] = [
             report_level_filter
         ]
-    print(request_body)
-    response = client.post(
-        f"/v1.0/myorg/groups/{workspace_id}/reports/{reportId}/ExportTo",
-        json=request_body,
-    )
+
+    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)
-        exportId = response_body["id"]
-        response = client.get(
-            f"/v1.0/myorg/groups/{workspace_id}/reports/{reportId}/exports/{exportId}"
-        )
+        export_id = response_body["id"]
+        response = client.get(f"{base_url}/exports/{export_id}")
         response_body = json.loads(response.content)
         while response_body["status"] not in ["Succeeded", "Failed"]:
             time.sleep(3)
-            response = client.get(
-                f"/v1.0/myorg/groups/{workspace_id}/reports/{reportId}/exports/{exportId}"
-            )
+            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}' workspace in the '{export_format}' format has failed."
             )
         else:
-            response = client.get(
-                f"/v1.0/myorg/groups/{workspace_id}/reports/{reportId}/exports/{exportId}/file"
-            )
+            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}' workspace to the lakehouse..."
             )
@@ -407,6 +405,8 @@ def clone_report(
     """
     Clones a Power BI report.
 
+    This is a wrapper function for the following API: `Reports - Clone Report In Group <https://learn.microsoft.com/rest/api/power-bi/reports/clone-report-in-group`_.
+
     Parameters
     ----------
     report : str

sempy_labs/report/_report_rebind.py

@@ -1,5 +1,8 @@
 import sempy.fabric as fabric
-from sempy_labs._helper_functions import resolve_dataset_id, resolve_report_id
+from sempy_labs._helper_functions import (
+    resolve_dataset_id,
+    resolve_report_id,
+)
 from typing import Optional, List
 from sempy._utils._log import log
 import sempy_labs._icons as icons
@@ -16,6 +19,8 @@ def report_rebind(
     """
     Rebinds a report to a semantic model.
 
+    This is a wrapper function for the following API: `Reports - Rebind Report In Group <https://learn.microsoft.com/rest/api/power-bi/reports/rebind-report-in-group`_.
+
     Parameters
     ----------
     report : str | List[str]

sempy_labs/report/_reportwrapper.py

@@ -7,7 +7,7 @@ from sempy_labs._helper_functions import (
     _extract_json,
     _add_part,
     lro,
-    make_clickable,
+    # _make_clickable,
 )
 from typing import Optional, List
 import pandas as pd
@@ -370,7 +370,7 @@ class ReportWrapper:
             df = self._add_extended(dataframe=df)
 
         return df
-        # return df.style.format({"Page URL": make_clickable})
+        # return df.style.format({"Page URL": _make_clickable})
 
     def list_visual_filters(self, extended: bool = False) -> pd.DataFrame:
         """
@@ -642,7 +642,7 @@ class ReportWrapper:
         )
 
         return df
-        # return df.style.format({"Page URL": make_clickable})
+        # return df.style.format({"Page URL": _make_clickable})
 
     def list_visuals(self) -> pd.DataFrame:
         """