semantic-link-labs 0.10.0__py3-none-any.whl → 0.11.0__py3-none-any.whl

sempy_labs/report/_report_bpa.py

@@ -2,7 +2,7 @@ from typing import Optional
 import pandas as pd
 import datetime
 from sempy._utils._log import log
-from sempy_labs.report import ReportWrapper, report_bpa_rules
+from sempy_labs.report import connect_report, report_bpa_rules
 from sempy_labs._helper_functions import (
     format_dax_object_name,
     save_as_delta_table,
@@ -14,7 +14,6 @@ from sempy_labs._helper_functions import (
 from sempy_labs.lakehouse import get_lakehouse_tables, lakehouse_attached
 import sempy_labs._icons as icons
 from IPython.display import display, HTML
-import sempy_labs.report._report_helper as helper
 from uuid import UUID
 
 
@@ -52,124 +51,114 @@ def run_report_bpa(
         A pandas dataframe in HTML format showing report objects which violated the best practice analyzer rules.
     """
 
-    rpt = ReportWrapper(report=report, workspace=workspace)
+    with connect_report(
+        report=report, workspace=workspace, readonly=True, show_diffs=False
+    ) as rpt:
 
-    dfCV = rpt.list_custom_visuals()
-    dfP = rpt.list_pages()
-    dfRF = rpt.list_report_filters()
-    dfRF["Filter Object"] = format_dax_object_name(
-        dfRF["Table Name"], dfRF["Object Name"]
-    )
-    dfPF = rpt.list_page_filters()
-    # Convert back to dataframe
-    # if isinstance(dfPF, pd.io.formats.style.Styler):
-    #    dfPF = dfPF.data
-    # if isinstance(dfP, pd.io.formats.style.Styler):
-    #    dfP = dfP.data
-
-    dfPF["Filter Object"] = (
-        dfPF["Page Display Name"]
-        + " : "
-        + format_dax_object_name(dfPF["Table Name"], dfPF["Object Name"])
-    )
-    dfVF = rpt.list_visual_filters()
-    dfVF["Filter Object"] = (
-        format_dax_object_name(dfVF["Page Display Name"], dfVF["Visual Name"])
-        + " : "
-        + format_dax_object_name(dfVF["Table Name"], dfVF["Object Name"])
-    )
-    dfRLM = rpt.list_report_level_measures()
-    dfV = rpt.list_visuals()
-    dfV["Visual Full Name"] = format_dax_object_name(
-        dfV["Page Display Name"], dfV["Visual Name"]
-    )
-    dfSMO = rpt.list_semantic_model_objects(extended=True)
-
-    # Translations
-    if rules is None:
-        rules = report_bpa_rules()
-
-    scope_to_dataframe = {
-        "Custom Visual": (dfCV, ["Custom Visual Display Name"]),
-        "Page": (dfP, ["Page Display Name"]),
-        "Visual": (dfV, ["Visual Full Name"]),
-        "Report Filter": (dfRF, ["Filter Object"]),
-        "Page Filter": (dfPF, ["Filter Object"]),
-        "Visual Filter": (dfVF, ["Filter Object"]),
-        "Report Level Measure": (dfRLM, ["Measure Name"]),
-        "Semantic Model": (dfSMO, ["Report Source Object"]),
-    }
-
-    def execute_rule(row):
-        scopes = row["Scope"]
-
-        # support both str and list as scope type
-        if isinstance(scopes, str):
-            scopes = [scopes]
-
-        # collect output dataframes
-        df_outputs = []
-
-        for scope in scopes:
-            # common fields for each scope
-            (df, violation_cols_or_func) = scope_to_dataframe[scope]
-
-            # execute rule and subset df
-            df_violations = df[row["Expression"](df)]
-
-            # subset the right output columns (e.g. Table Name & Column Name)
-            if isinstance(violation_cols_or_func, list):
-                violation_func = lambda violations: violations[violation_cols_or_func]
-            else:
-                violation_func = violation_cols_or_func
-
-            # build output data frame
-            df_output = violation_func(df_violations).copy()
-
-            df_output.columns = ["Object Name"]
-            df_output["Rule Name"] = row["Rule Name"]
-            df_output["Category"] = row["Category"]
-
-            # Handle 'Object Type' based on scope
-            if scope == "Semantic Model":
-                # Ensure 'Report Source Object' is unique in dfSMO
-                dfSMO_unique = dfSMO.drop_duplicates(subset="Report Source Object")
-                # Map 'Object Name' to the 'Report Source' column in dfSMO
-                df_output["Object Type"] = df_output["Object Name"].map(
-                    dfSMO_unique.set_index("Report Source Object")["Report Source"]
-                )
-            else:
-                df_output["Object Type"] = scope
-
-            df_output["Severity"] = row["Severity"]
-            df_output["Description"] = row["Description"]
-            df_output["URL"] = row["URL"]
-            df_output["Report URL"] = helper.get_web_url(
-                report=report, workspace=workspace
-            )
-
-            page_mapping_dict = dfP.set_index("Page Display Name")["Page URL"].to_dict()
-
-            if scope == "Page":
-                df_output["Report URL"] = df_output["Object Name"].map(
-                    page_mapping_dict
-                )
-            elif scope == "Page Filter":
-                df_output["Page Name"] = df_output["Object Name"].str.extract(
-                    r"(.*?) : '"
-                )
-                df_output["Report URL"] = df_output["Page Name"].map(page_mapping_dict)
-                df_output.drop(columns=["Page Name"], inplace=True)
-            elif scope in ["Visual", "Visual Filter"]:
-                df_output["Page Name"] = df_output["Object Name"].str.extract(
-                    r"'(.*?)'\[.*?\]"
-                )
-                df_output["Report URL"] = df_output["Page Name"].map(page_mapping_dict)
-                df_output.drop(columns=["Page Name"], inplace=True)
+        dfCV = rpt.list_custom_visuals()
+        dfP = rpt.list_pages()
+        dfRF = rpt.list_report_filters()
+        dfRF["Filter Object"] = format_dax_object_name(
+            dfRF["Table Name"], dfRF["Object Name"]
+        )
+        dfPF = rpt.list_page_filters()
 
-            df_outputs.append(df_output)
+        dfPF["Filter Object"] = (
+            dfPF["Page Display Name"]
+            + " : "
+            + format_dax_object_name(dfPF["Table Name"], dfPF["Object Name"])
+        )
+        dfVF = rpt.list_visual_filters()
+        dfVF["Filter Object"] = (
+            format_dax_object_name(dfVF["Page Display Name"], dfVF["Visual Name"])
+            + " : "
+            + format_dax_object_name(dfVF["Table Name"], dfVF["Object Name"])
+        )
+        dfRLM = rpt.list_report_level_measures()
+        dfV = rpt.list_visuals()
+        dfV["Visual Full Name"] = format_dax_object_name(
+            dfV["Page Display Name"], dfV["Visual Name"]
+        )
+        dfSMO = rpt.list_semantic_model_objects(extended=True)
+
+        # Translations
+        if rules is None:
+            rules = report_bpa_rules()
+
+        scope_to_dataframe = {
+            "Custom Visual": (dfCV, ["Custom Visual Display Name"]),
+            "Page": (dfP, ["Page Display Name"]),
+            "Visual": (dfV, ["Visual Full Name"]),
+            "Report Filter": (dfRF, ["Filter Object"]),
+            "Page Filter": (dfPF, ["Filter Object"]),
+            "Visual Filter": (dfVF, ["Filter Object"]),
+            "Report Level Measure": (dfRLM, ["Measure Name"]),
+            "Semantic Model": (dfSMO, ["Report Source Object"]),
+        }
 
-        return df_outputs
+        def execute_rule(row):
+            scopes = row["Scope"]
+
+            # support both str and list as scope type
+            if isinstance(scopes, str):
+                scopes = [scopes]
+
+            # collect output dataframes
+            df_outputs = []
+
+            for scope in scopes:
+                # common fields for each scope
+                (df, violation_cols_or_func) = scope_to_dataframe[scope]
+
+                # execute rule and subset df
+                df_violations = df[row["Expression"](df)]
+
+                # subset the right output columns (e.g. Table Name & Column Name)
+                if isinstance(violation_cols_or_func, list):
+                    violation_func = lambda violations: violations[
+                        violation_cols_or_func
+                    ]
+                else:
+                    violation_func = violation_cols_or_func
+
+                # build output data frame
+                df_output = violation_func(df_violations).copy()
+
+                df_output.columns = ["Object Name"]
+                df_output["Rule Name"] = row["Rule Name"]
+                df_output["Category"] = row["Category"]
+
+                # Handle 'Object Type' based on scope
+                if scope == "Semantic Model":
+                    # Ensure 'Report Source Object' is unique in dfSMO
+                    dfSMO_unique = dfSMO.drop_duplicates(subset="Report Source Object")
+                    # Map 'Object Name' to the 'Report Source' column in dfSMO
+                    df_output["Object Type"] = df_output["Object Name"].map(
+                        dfSMO_unique.set_index("Report Source Object")["Report Source"]
+                    )
+                else:
+                    df_output["Object Type"] = scope
+
+                df_output["Severity"] = row["Severity"]
+                df_output["Description"] = row["Description"]
+                if scope in ["Page", "Page Filter"]:
+                    if not df_output.empty:
+                        for idx, r in df_output.iterrows():
+                            df_output.loc[idx, "URL"] = rpt._get_url(
+                                page_name=r["Object Name"]
+                            )
+                elif scope in ["Visual", "Visual Filter"]:
+                    if not df_output.empty:
+                        for idx, r in df_output.iterrows():
+                            df_output.loc[idx, "URL"] = rpt._get_url(
+                                page_name=r["Object Name"].split("[")[0][1:-1],
+                                visual_name=r["Object Name"].split("[")[1].rstrip("]"),
+                            )
+                else:
+                    df_output["URL"] = rpt._get_url()
+                df_outputs.append(df_output)
+
+            return df_outputs
 
     # flatten list of lists
     flatten_dfs = [
@@ -186,7 +175,7 @@ def run_report_bpa(
             "Severity",
             "Description",
             "URL",
-            "Report URL",
+            # "Report URL",
         ]
     ]
 
@@ -271,7 +260,7 @@ def run_report_bpa(
                 "Severity",
                 "Description",
                 "URL",
-                "Report URL",
+                # "Report URL",
             ]
         ]
         .sort_values(["Category", "Rule Name", "Object Type", "Object Name"])
@@ -347,13 +336,12 @@ def run_report_bpa(
             else:
                 content_html += f'<td>{row["Rule Name"]}</td>'
             content_html += f'<td>{row["Object Type"]}</td>'
-            if pd.notnull(row["Report URL"]):
+            if pd.notnull(row["URL"]):
                 content_html += (
-                    f'<td><a href="{row["Report URL"]}">{row["Object Name"]}</a></td>'
+                    f'<td><a href="{row["URL"]}">{row["Object Name"]}</a></td>'
                 )
             else:
                 content_html += f'<td>{row["Object Name"]}</td>'
-            # content_html += f'<td>{row["Object Name"]}</td>'
             content_html += f'<td style="text-align: center;">{row["Severity"]}</td>'
             content_html += "</tr>"
         content_html += "</table>"

sempy_labs/report/_report_bpa_rules.py

@@ -1,6 +1,8 @@
 import pandas as pd
+from sempy._utils._log import log
 
 
+@log
 def report_bpa_rules() -> pd.DataFrame:
     """
     Shows the default rules for the report BPA used by the run_report_bpa function.

sempy_labs/report/_report_functions.py

@@ -26,6 +26,7 @@ import sempy_labs._icons as icons
 from uuid import UUID
 
 
+@log
 def get_report_json(
     report: str,
     workspace: Optional[str | UUID] = None,
@@ -90,6 +91,7 @@ def get_report_json(
     return report_json
 
 
+@log
 def report_dependency_tree(workspace: Optional[str | UUID] = None):
     """
     Prints a dependency between reports and semantic models.
@@ -142,6 +144,7 @@ def report_dependency_tree(workspace: Optional[str | UUID] = None):
         print(f"{pre}{node.custom_property}'{node.name}'")
 
 
+@log
 def clone_report(
     report: str,
     cloned_report: str,
@@ -221,6 +224,7 @@ def clone_report(
     )
 
 
+@log
 def launch_report(report: str, workspace: Optional[str | UUID] = None):
     """
     Shows a Power BI report within a Fabric notebook.
@@ -249,6 +253,7 @@ def launch_report(report: str, workspace: Optional[str | UUID] = None):
     return report
 
 
+@log
 def list_report_pages(report: str, workspace: Optional[str | UUID] = None):
     """
     Shows the properties of all pages within a Power BI report.
@@ -316,6 +321,7 @@ def list_report_pages(report: str, workspace: Optional[str | UUID] = None):
     return df
 
 
+@log
 def list_report_visuals(report: str, workspace: Optional[str | UUID] = None):
     """
     Shows the properties of all visuals within a Power BI report.
@@ -369,6 +375,7 @@ def list_report_visuals(report: str, workspace: Optional[str | UUID] = None):
     return df
 
 
+@log
 def list_report_bookmarks(report: str, workspace: Optional[str | UUID] = None):
     """
     Shows the properties of all bookmarks within a Power BI report.

sempy_labs/report/_reportwrapper.py

@@ -17,6 +17,7 @@ from sempy_labs._helper_functions import (
     get_jsonpath_value,
     set_json_value,
     remove_json_value,
+    get_tenant_id,
 )
 from sempy_labs._dictionary_diffs import (
     diff_parts,
@@ -425,7 +426,9 @@ class ReportWrapper:
             ]
         )
 
-    def _get_url(self, page_name: Optional[str] = None) -> str:
+    def _get_url(
+        self, page_name: Optional[str] = None, visual_name: Optional[str] = None
+    ) -> str:
         """
         Gets the URL of the report. If specified, gets the URL of the specified page.
 
@@ -444,8 +447,16 @@ class ReportWrapper:
         url = f"https://app.powerbi.com/groups/{self._workspace_id}/reports/{self._report_id}"
 
         if page_name:
+            if page_name in [page["payload"]["name"] for page in self.__all_pages()]:
+                pass
+            else:
+                page_name = self.resolve_page_name(page_name)
             url += f"/{page_name}"
 
+            if visual_name:
+                tenant_id = get_tenant_id()
+                url += f"?ctid={tenant_id}&pbi_source=shareVisual&visual={visual_name}"
+
         return url
 
     def __resolve_page_name_and_display_name_file_path(
@@ -1120,6 +1131,7 @@ class ReportWrapper:
             "Has Sparkline": "bool",
             "Visual Filter Count": "int",
             "Data Limit": "int",
+            "URL": "str",
         }
         df = _create_dataframe(columns=columns)
 
@@ -1247,12 +1259,13 @@ class ReportWrapper:
 
             # Sparkline
             has_sparkline = contains_key(payload, ["SparklineData"])
+            visual_name = payload.get("name")
 
             new_data = {
                 "File Path": path,
                 "Page Name": page_id,
                 "Page Display Name": page_display,
-                "Visual Name": payload.get("name"),
+                "Visual Name": visual_name,
                 "X": pos.get("x"),
                 "Y": pos.get("y"),
                 "Z": pos.get("z"),
@@ -1275,6 +1288,7 @@ class ReportWrapper:
                 "Has Sparkline": has_sparkline,
                 "Visual Filter Count": visual_filter_count,
                 "Data Limit": data_limit,
+                "URL": self._get_url(page_name=page_id, visual_name=visual_name),
             }
             dfs.append(pd.DataFrame(new_data, index=[0]))
 
@@ -1361,6 +1375,7 @@ class ReportWrapper:
                     if isinstance(expression, dict)
                     else {}
                 )
+
                 if (
                     isinstance(source_ref, dict)
                     and "Entity" in source_ref
@@ -1374,9 +1389,15 @@ class ReportWrapper:
                         if keys_path
                         else "Unknown"
                     )
-                    is_agg = keys_path[-3] == "Aggregation"
-                    is_viz_calc = keys_path[-3] == "NativeVisualCalculation"
-                    is_sparkline = keys_path[-3] == "SparklineData"
+                    is_agg = len(keys_path) > 2 and keys_path[-3] == "Aggregation"
+                    is_viz_calc = (
+                        len(keys_path) > 2
+                        and keys_path[-3] == "NativeVisualCalculation"
+                    )
+                    is_sparkline = (
+                        len(keys_path) > 2 and keys_path[-3] == "SparklineData"
+                    )
+
                     result[property_value] = (
                         entity,
                         object_type,
@@ -1384,13 +1405,10 @@ class ReportWrapper:
                         is_viz_calc,
                         is_sparkline,
                     )
-                    if keys_path:
-                        keys_path.pop()
 
                 # Recursively search the rest of the dictionary
                 for key, value in data.items():
-                    keys_path.append(key)
-                    find_entity_property_pairs(value, result, keys_path)
+                    find_entity_property_pairs(value, result, keys_path + [key])
 
             elif isinstance(data, list):
                 for item in data:
@@ -1712,31 +1730,36 @@ class ReportWrapper:
             "Expression": "str",
             "Data Type": "str",
             "Format String": "str",
+            "Data Category": "str",
         }
 
         df = _create_dataframe(columns=columns)
 
+        # If no report extensions path, return empty DataFrame
+        if self._report_extensions_path not in self.list_paths()["Path"].values:
+            return df
+
         report_file = self.get(file_path=self._report_extensions_path)
 
         dfs = []
-        if report_file:
-            payload = report_file.get("payload")
-            for e in payload.get("entities", []):
-                table_name = e.get("name")
-                for m in e.get("measures", []):
-                    measure_name = m.get("name")
-                    expr = m.get("expression")
-                    data_type = m.get("dataType")
-                    format_string = m.get("formatString")
+        for e in report_file.get("entities", []):
+            table_name = e.get("name")
+            for m in e.get("measures", []):
+                measure_name = m.get("name")
+                expr = m.get("expression")
+                data_type = m.get("dataType")
+                format_string = m.get("formatString")
+                data_category = m.get("dataCategory")
 
-                    new_data = {
-                        "Measure Name": measure_name,
-                        "Table Name": table_name,
-                        "Expression": expr,
-                        "Data Type": data_type,
-                        "Format String": format_string,
-                    }
-                    dfs.append(pd.DataFrame(new_data, index=[0]))
+                new_data = {
+                    "Measure Name": measure_name,
+                    "Table Name": table_name,
+                    "Expression": expr,
+                    "Data Type": data_type,
+                    "Format String": format_string,
+                    "Data Category": data_category,
+                }
+                dfs.append(pd.DataFrame(new_data, index=[0]))
 
         if dfs:
             df = pd.concat(dfs, ignore_index=True)
@@ -1792,46 +1815,61 @@ class ReportWrapper:
         return self.get(file_path=theme_file_path)
 
     # Action functions
-    def set_theme(self, theme_file_path: str):
+    def set_theme(
+        self, theme_file_path: Optional[str] = None, theme_json: Optional[dict] = None
+    ):
         """
         Sets a custom theme for a report based on a theme .json file.
 
         Parameters
         ----------
-        theme_file_path : str
+        theme_file_path : str, default=None
             The file path of the theme.json file. This can either be from a Fabric lakehouse or from the web.
             Example for lakehouse: file_path = '/lakehouse/default/Files/CY23SU09.json'
             Example for web url: file_path = 'https://raw.githubusercontent.com/PowerBiDevCamp/FabricUserApiDemo/main/FabricUserApiDemo/DefinitionTemplates/Shared/Reports/StaticResources/SharedResources/BaseThemes/CY23SU08.json'
+        theme_json : dict, default=None
+            The theme file in .json format. Must specify either the theme_file_path or the theme_json.
         """
 
-        self._ensure_pbir()
-        theme_version = "5.6.4"
-
-        # Open file
-        if not theme_file_path.endswith(".json"):
+        if theme_file_path and theme_json:
             raise ValueError(
-                f"{icons.red_dot} The '{theme_file_path}' theme file path must be a .json file."
+                f"{icons.red_dot} Please specify either the 'theme_file_path' or the 'theme_json' parameter, not both."
             )
-        elif theme_file_path.startswith("https://"):
-            response = requests.get(theme_file_path)
-            theme_file = response.json()
-        elif theme_file_path.startswith("/lakehouse") or theme_file_path.startswith(
-            "/synfs/"
-        ):
-            with open(theme_file_path, "r", encoding="utf-8-sig") as file:
-                theme_file = json.load(file)
-        else:
-            ValueError(
-                f"{icons.red_dot} Incorrect theme file path value '{theme_file_path}'."
+        if not theme_file_path and not theme_json:
+            raise ValueError(
+                f"{icons.red_dot} Please specify either the 'theme_file_path' or the 'theme_json' parameter."
             )
 
-        theme_name = theme_file.get("name")
+        self._ensure_pbir()
+        theme_version = "5.6.4"
+
+        # Extract theme_json from theme_file_path
+        if theme_file_path:
+            # Open file
+            if not theme_file_path.endswith(".json"):
+                raise ValueError(
+                    f"{icons.red_dot} The '{theme_file_path}' theme file path must be a .json file."
+                )
+            elif theme_file_path.startswith("https://"):
+                response = requests.get(theme_file_path)
+                theme_json = response.json()
+            elif theme_file_path.startswith("/lakehouse") or theme_file_path.startswith(
+                "/synfs/"
+            ):
+                with open(theme_file_path, "r", encoding="utf-8-sig") as file:
+                    theme_json = json.load(file)
+            else:
+                ValueError(
+                    f"{icons.red_dot} Incorrect theme file path value '{theme_file_path}'."
+                )
+
+        theme_name = theme_json.get("name")
         theme_name_full = f"{theme_name}.json"
 
         # Add theme.json file
         self.add(
             file_path=f"StaticResources/RegisteredResources/{theme_name_full}",
-            payload=theme_file,
+            payload=theme_json,
         )
 
         custom_theme = {
@@ -2102,7 +2140,7 @@ class ReportWrapper:
                 format_string = r["Format String"]
                 # Add measures to the model
                 if (
-                    measure_name in measures or measures is None
+                    measures is None or measure_name in measures
                 ) and measure_name not in existing_measures:
                     tom.add_measure(
                         table_name=table_name,

sempy_labs/theme/__init__.py

@@ -0,0 +1,12 @@
+from ._org_themes import (
+    list_org_themes,
+    get_org_theme_json,
+    resolve_theme_id,
+)
+
+
+__all__ = [
+    "list_org_themes",
+    "get_org_theme_json",
+    "resolve_theme_id",
+]