semantic-link-labs 0.8.5__py3-none-any.whl → 0.8.7__py3-none-any.whl

sempy_labs/report/_generate_report.py

@@ -179,7 +179,9 @@ def update_report_from_reportjson(
     )
 
 
-def get_report_definition(report: str, workspace: Optional[str] = None) -> pd.DataFrame:
+def get_report_definition(
+    report: str, workspace: Optional[str] = None, return_dataframe: bool = True
+) -> pd.DataFrame | dict:
     """
     Gets the collection of definition files of a report.
 
@@ -193,10 +195,12 @@ def get_report_definition(report: str, workspace: Optional[str] = None) -> pd.Da
         The Fabric workspace name 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.
+    return_dataframe : bool, default=True
+        If True, returns a dataframe. If False, returns a json dictionary.
 
     Returns
     -------
-    pandas.DataFrame
+    pandas.DataFrame | dict
         The collection of report definition files within a pandas dataframe.
     """
 
@@ -209,9 +213,11 @@ def get_report_definition(report: str, workspace: Optional[str] = None) -> pd.Da
     )
 
     result = lro(client, response).json()
-    rdef = pd.json_normalize(result["definition"]["parts"])
 
-    return rdef
+    if return_dataframe:
+        return pd.json_normalize(result["definition"]["parts"])
+    else:
+        return result
 
 
 @log

sempy_labs/report/_report_bpa.py

@@ -29,6 +29,7 @@ def run_report_bpa(
 ):
     """
     Displays an HTML visualization of the results of the Best Practice Analyzer scan for a report.
+    Note: As with all functions which rely on the ReportWrapper, this function requires the report to be in the 'PBIR' format.
 
     Parameters
     ----------

sempy_labs/report/_report_helper.py

@@ -252,3 +252,61 @@ def find_entity_property_pairs(data, result=None, keys_path=None):
             find_entity_property_pairs(item, result, keys_path)
 
     return result
+
+
+def _get_agg_type_mapping() -> dict:
+    """
+    This function extracts a mapping dictionary like this:
+    {
+        "0": "Sum",
+        "1": "Average",
+        "2": "Distinct count",
+    }
+    """
+
+    schema_url = "https://developer.microsoft.com/json-schemas/fabric/item/report/definition/semanticQuery/1.2.0/schema.json"
+    response = requests.get(schema_url)
+    schema = response.json()
+    aggtypes_schema = schema.get("definitions", {}).get("QueryAggregateFunction", {})
+
+    agg_type_map = {}
+    agg_type_map = {
+        a.get("const"): a.get("description")
+        for a in aggtypes_schema.get("anyOf", [])
+        if "const" in a and "description" in a
+    }
+    agg_type_map["-1"] = "Unknown"
+
+    return agg_type_map
+
+
+def _get_expression(expr_json, agg_type_map):
+
+    expr_type = list(expr_json.keys())[0]
+    if expr_type == "Literal":
+        expr = expr_json.get("Literal", {}).get("Value")[1:-1]
+    elif expr_type == "Aggregation":
+        entity = (
+            expr_json.get("Aggregation", {})
+            .get("Expression", {})
+            .get("Column", {})
+            .get("Expression", {})
+            .get("SourceRef", {})
+            .get("Entity", "Unknown")
+        )
+        column = (
+            expr_json.get("Aggregation", {})
+            .get("Expression", {})
+            .get("Column", {})
+            .get("Property", "Unknown")
+        )
+        function_id = expr_json.get("Aggregation", {}).get("Function", "-1")
+        function = agg_type_map.get(function_id)
+        expr = f"{function}('{entity}'[{column}])"
+    elif expr_type == "Measure":
+        measure = expr_json.get("Measure", {}).get("Property", "Unknown")
+        expr = f"[{measure}]"
+    else:
+        expr = "Unknown"
+
+    return expr

sempy_labs/report/_report_list_functions.py

@@ -13,6 +13,7 @@ def list_unused_objects_in_reports(
 ) -> pd.DataFrame:
     """
     Shows a list of all columns in the semantic model which are not used in any related Power BI reports (including dependencies).
+    Note: As with all functions which rely on the ReportWrapper, this function requires the report to be in the 'PBIR' format.
 
     Parameters
     ----------
@@ -55,6 +56,7 @@ def _list_all_report_semantic_model_objects(
 ) -> pd.DataFrame:
     """
     Shows a unique list of all semantic model objects (columns, measures, hierarchies) which are used in all reports which leverage the semantic model.
+    Note: As with all functions which rely on the ReportWrapper, this function requires the report to be in the 'PBIR' format.
 
     Parameters
     ----------