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

sempy_labs/report/_reportwrapper.py

@@ -7,6 +7,7 @@ from sempy_labs._helper_functions import (
     _extract_json,
     _add_part,
     lro,
+    make_clickable,
 )
 from typing import Optional, List
 import pandas as pd
@@ -134,21 +135,17 @@ class ReportWrapper:
 
     def get_theme(self, theme_type: str = "baseTheme") -> dict:
         """
-        Obtains
+        Obtains the theme file of the report.
 
         Parameters
         ----------
-        dataset : str
-            Name of the semantic model.
-        workspace : str, default=None
-            The Fabric workspace name.
-            Defaults to None which resolves to the workspace of the attached lakehouse
-            or if no lakehouse attached, resolves to the workspace of the notebook.
+        theme_type : str, default="baseTheme"
+            The theme type. Options: "baseTheme", "customTheme".
 
         Returns
         -------
-        pandas.DataFrame
-            A pandas dataframe showing a list of all columns in the semantic model which are not used in any related Power BI reports (including dependencies).
+        dict
+            The theme.json file
         """
 
         theme_types = ["baseTheme", "customTheme"]
@@ -362,8 +359,8 @@ class ReportWrapper:
                                 ignore_index=True,
                             )
 
-        df["Page URL"] = (
-            f"{helper.get_web_url(report=self._report, workspace=self._workspace)}/{df['Page Name']}"
+        df["Page URL"] = df["Page Name"].apply(
+            lambda page_name: f"{helper.get_web_url(report=self._report, workspace=self._workspace)}/{page_name}"
         )
 
         bool_cols = ["Hidden", "Locked", "Used"]
@@ -373,6 +370,7 @@ class ReportWrapper:
             df = self._add_extended(dataframe=df)
 
         return df
+        # return df.style.format({"Page URL": make_clickable})
 
     def list_visual_filters(self, extended: bool = False) -> pd.DataFrame:
         """
@@ -639,11 +637,12 @@ class ReportWrapper:
         bool_cols = ["Hidden", "Active", "Drillthrough Target Page"]
         df[bool_cols] = df[bool_cols].astype(bool)
 
-        df["Page URL"] = (
-            f"{helper.get_web_url(report=self._report, workspace=self._workspace)}/{df['Page Name']}"
+        df["Page URL"] = df["Page Name"].apply(
+            lambda page_name: f"{helper.get_web_url(report=self._report, workspace=self._workspace)}/{page_name}"
         )
 
         return df
+        # return df.style.format({"Page URL": make_clickable})
 
     def list_visuals(self) -> pd.DataFrame:
         """
@@ -1306,9 +1305,8 @@ class ReportWrapper:
         ----------
         theme_file_path : str
             The file path of the theme.json file. This can either be from a Fabric lakehouse or from the web.
-            Examples:
-                file_path = '/lakehouse/default/Files/CY23SU09.json'
-                file_path = 'https://raw.githubusercontent.com/PowerBiDevCamp/FabricUserApiDemo/main/FabricUserApiDemo/DefinitionTemplates/Shared/Reports/StaticResources/SharedResources/BaseThemes/CY23SU08.json'
+            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'
         """
 
         import requests

sempy_labs/tom/_model.py

@@ -3,7 +3,10 @@ import sempy.fabric as fabric
 import pandas as pd
 import re
 from datetime import datetime
-from sempy_labs._helper_functions import format_dax_object_name
+from sempy_labs._helper_functions import (
+    format_dax_object_name,
+    generate_guid,
+)
 from sempy_labs._list_functions import list_relationships
 from sempy_labs._refresh_semantic_model import refresh_semantic_model
 from sempy_labs.directlake._dl_helper import check_fallback_reason
@@ -11,6 +14,7 @@ from contextlib import contextmanager
 from typing import List, Iterator, Optional, Union, TYPE_CHECKING
 from sempy._utils._log import log
 import sempy_labs._icons as icons
+from sempy.fabric.exceptions import FabricHTTPException
 
 if TYPE_CHECKING:
     import Microsoft.AnalysisServices.Tabular
@@ -226,7 +230,7 @@ class TOMWrapper:
         measure_name: str,
         expression: str,
         format_string: Optional[str] = None,
-        hidden: Optional[bool] = False,
+        hidden: bool = False,
         description: Optional[str] = None,
         display_folder: Optional[str] = None,
         format_string_expression: Optional[str] = None,
@@ -283,8 +287,12 @@ class TOMWrapper:
             obj.FormatStringDefinition = fsd
         if lineage_tag is not None:
             obj.LineageTag = lineage_tag
+        else:
+            obj.LineageTag = generate_guid()
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
+        else:
+            obj.SourceLineageTag = generate_guid()
         if detail_rows_expression is not None:
             drd = TOM.DetailRowsDefinition()
             drd.Expression = detail_rows_expression
@@ -301,11 +309,11 @@ class TOMWrapper:
         source_column: str,
         data_type: str,
         format_string: Optional[str] = None,
-        hidden: Optional[bool] = False,
+        hidden: bool = False,
         description: Optional[str] = None,
         display_folder: Optional[str] = None,
         data_category: Optional[str] = None,
-        key: Optional[bool] = False,
+        key: bool = False,
         summarize_by: Optional[str] = None,
         lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
@@ -376,8 +384,12 @@ class TOMWrapper:
             obj.DataCategory = data_category
         if lineage_tag is not None:
             obj.LineageTag = lineage_tag
+        else:
+            obj.LineageTag = generate_guid()
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
+        else:
+            obj.SourceLineageTag = generate_guid()
         self.model.Tables[table_name].Columns.Add(obj)
 
     def add_data_column(
@@ -387,11 +399,11 @@ class TOMWrapper:
         source_column: str,
         data_type: str,
         format_string: Optional[str] = None,
-        hidden: Optional[bool] = False,
+        hidden: bool = False,
         description: Optional[str] = None,
         display_folder: Optional[str] = None,
         data_category: Optional[str] = None,
-        key: Optional[bool] = False,
+        key: bool = False,
         summarize_by: Optional[str] = None,
         lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
@@ -462,8 +474,12 @@ class TOMWrapper:
             obj.DataCategory = data_category
         if lineage_tag is not None:
             obj.LineageTag = lineage_tag
+        else:
+            obj.LineageTag = generate_guid()
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
+        else:
+            obj.SourceLineagetTag = generate_guid()
         self.model.Tables[table_name].Columns.Add(obj)
 
     def add_calculated_column(
@@ -473,11 +489,11 @@ class TOMWrapper:
         expression: str,
         data_type: str,
         format_string: Optional[str] = None,
-        hidden: Optional[bool] = False,
+        hidden: bool = False,
         description: Optional[str] = None,
         display_folder: Optional[str] = None,
         data_category: Optional[str] = None,
-        key: Optional[bool] = False,
+        key: bool = False,
         summarize_by: Optional[str] = None,
         lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
@@ -548,8 +564,12 @@ class TOMWrapper:
             obj.DataCategory = data_category
         if lineage_tag is not None:
             obj.LineageTag = lineage_tag
+        else:
+            obj.LineageTag = generate_guid()
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
+        else:
+            obj.SourceLineagetTag = generate_guid()
         self.model.Tables[table_name].Columns.Add(obj)
 
     def add_calculation_item(
@@ -708,7 +728,7 @@ class TOMWrapper:
         columns: List[str],
         levels: Optional[List[str]] = None,
         hierarchy_description: Optional[str] = None,
-        hierarchy_hidden: Optional[bool] = False,
+        hierarchy_hidden: bool = False,
         lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
     ):
@@ -761,8 +781,12 @@ class TOMWrapper:
             obj.Description = hierarchy_description
         if lineage_tag is not None:
             obj.LineageTag = lineage_tag
+        else:
+            obj.LineageTag = generate_guid()
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
+        else:
+            obj.SourceLineagetTag = generate_guid()
         self.model.Tables[table_name].Hierarchies.Add(obj)
 
         for col in columns:
@@ -770,6 +794,8 @@ class TOMWrapper:
             lvl.Column = self.model.Tables[table_name].Columns[col]
             lvl.Name = levels[columns.index(col)]
             lvl.Ordinal = columns.index(col)
+            lvl.LineageTag = generate_guid()
+            lvl.SourceLineageTag = generate_guid()
             self.model.Tables[table_name].Hierarchies[hierarchy_name].Levels.Add(lvl)
 
     def add_relationship(
@@ -781,9 +807,9 @@ class TOMWrapper:
         from_cardinality: str,
         to_cardinality: str,
         cross_filtering_behavior: Optional[str] = None,
-        is_active: Optional[bool] = True,
+        is_active: bool = True,
         security_filtering_behavior: Optional[str] = None,
-        rely_on_referential_integrity: Optional[bool] = False,
+        rely_on_referential_integrity: bool = False,
     ):
         """
         Adds a `relationship <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.singlecolumnrelationship?view=analysisservices-dotnet>`_ to a semantic model.
@@ -855,7 +881,7 @@ class TOMWrapper:
         name: str,
         precedence: int,
         description: Optional[str] = None,
-        hidden: Optional[bool] = False,
+        hidden: bool = False,
     ):
         """
         Adds a `calculation group <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.calculationgroup?view=analysisservices-dotnet>`_ to a semantic model.
@@ -939,8 +965,12 @@ class TOMWrapper:
             exp.Description = description
         if lineage_tag is not None:
             exp.LineageTag = lineage_tag
+        else:
+            exp.LineageTag = generate_guid()
         if source_lineage_tag is not None:
             exp.SourceLineageTag = source_lineage_tag
+        else:
+            exp.SourceLineageTag = generate_guid()
         exp.Kind = TOM.ExpressionKind.M
         exp.Expression = expression
 
@@ -1034,7 +1064,7 @@ class TOMWrapper:
         entity_name: str,
         expression: Optional[str] = None,
         description: Optional[str] = None,
-        schema_name: Optional[str] = None,
+        schema_name: str = "dbo",
     ):
         """
         Adds an entity partition to a table within a semantic model.
@@ -1050,7 +1080,7 @@ class TOMWrapper:
             Defaults to None which resolves to the 'DatabaseQuery' expression.
         description : str, default=None
             A description for the partition.
-        schema_name : str, default=None
+        schema_name : str, default="dbo"
             The schema name.
         """
         import Microsoft.AnalysisServices.Tabular as TOM
@@ -1062,8 +1092,7 @@ class TOMWrapper:
             ep.ExpressionSource = self.model.Expressions["DatabaseQuery"]
         else:
             ep.ExpressionSource = self.model.Expressions[expression]
-        if schema_name is not None:
-            ep.SchemaName = schema_name
+        ep.SchemaName = schema_name
         p = TOM.Partition()
         p.Name = table_name
         p.Source = ep
@@ -1072,6 +1101,9 @@ class TOMWrapper:
             p.Description = description
 
         self.model.Tables[table_name].Partitions.Add(p)
+        self.model.Tables[table_name].SourceLineageTag = (
+            f"[{schema_name}].[{entity_name}]"
+        )
 
     def set_alternate_of(
         self,
@@ -2483,7 +2515,7 @@ class TOMWrapper:
             )
 
     def set_is_available_in_mdx(
-        self, table_name: str, column_name: str, value: Optional[bool] = False
+        self, table_name: str, column_name: str, value: bool = False
     ):
         """
         Sets the `IsAvailableInMDX <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.column.isavailableinmdx?view=analysisservices-dotnet#microsoft-analysisservices-tabular-column-isavailableinmdx>`_ property on a column.
@@ -2586,7 +2618,7 @@ class TOMWrapper:
         name: str,
         description: Optional[str] = None,
         data_category: Optional[str] = None,
-        hidden: Optional[bool] = False,
+        hidden: bool = False,
         lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
     ):
@@ -2618,8 +2650,12 @@ class TOMWrapper:
             t.DataCategory = data_category
         if lineage_tag is not None:
             t.LineageTag = lineage_tag
+        else:
+            t.LineageTag = generate_guid()
         if source_lineage_tag is not None:
             t.SourceLineageTag = source_lineage_tag
+        else:
+            t.SourceLineagetTag = generate_guid()
         t.Hidden = hidden
         self.model.Tables.Add(t)
 
@@ -2629,9 +2665,9 @@ class TOMWrapper:
         expression: str,
         description: Optional[str] = None,
         data_category: Optional[str] = None,
-        hidden: Optional[bool] = False,
-        lineage_tag: Optional[bool] = None,
-        source_lineage_tag: Optional[bool] = None,
+        hidden: bool = False,
+        lineage_tag: Optional[str] = None,
+        source_lineage_tag: Optional[str] = None,
     ):
         """
         Adds a calculated table to the semantic model.
@@ -2670,8 +2706,12 @@ class TOMWrapper:
             t.DataCategory = data_category
         if lineage_tag is not None:
             t.LineageTag = lineage_tag
+        else:
+            t.LineageTag = generate_guid()
         if source_lineage_tag is not None:
             t.SourceLineageTag = source_lineage_tag
+        else:
+            t.SourceLineagetTag = generate_guid()
         t.Hidden = hidden
         t.Partitions.Add(par)
         self.model.Tables.Add(t)
@@ -3378,7 +3418,7 @@ class TOMWrapper:
         incremental_periods: int,
         rolling_window_granularity: str,
         rolling_window_periods: int,
-        only_refresh_complete_days: Optional[bool] = False,
+        only_refresh_complete_days: bool = False,
         detect_data_changes_column: Optional[str] = None,
     ):
         """
@@ -3483,7 +3523,7 @@ class TOMWrapper:
         incremental_periods: int,
         rolling_window_granularity: str,
         rolling_window_periods: int,
-        only_refresh_complete_days: Optional[bool] = False,
+        only_refresh_complete_days: bool = False,
         detect_data_changes_column: Optional[str] = None,
     ):
         """
@@ -3652,7 +3692,7 @@ class TOMWrapper:
         self,
         table_name: str,
         effective_date: Optional[datetime] = None,
-        refresh: Optional[bool] = True,
+        refresh: bool = True,
         max_parallelism: Optional[int] = 0,
     ):
         """
@@ -3970,6 +4010,8 @@ class TOMWrapper:
         data_category: Optional[str] = None,
         key: Optional[bool] = None,
         summarize_by: Optional[str] = None,
+        is_nullable: Optional[bool] = None,
+        is_available_in_mdx: Optional[bool] = None,
     ):
         """
         Updates a column within a semantic model.
@@ -4010,6 +4052,10 @@ class TOMWrapper:
         summarize_by : str, default=None
             Sets the value for the Summarize By property of the column.
             Defaults to None which keeps the existing setting.
+        is_nullable : bool, default=None
+            If False, the column cannot contain nulls. Even if True, it may still not allow nulls if it's a key column.
+        is_available_in_mdx : bool, default=None
+            A boolean value that indicates whether the column can be excluded from usage in MDX query tools. False if the column can be excluded from usage in MDX query tools; otherwise true.
         """
 
         import Microsoft.AnalysisServices.Tabular as TOM
@@ -4038,6 +4084,10 @@ class TOMWrapper:
             c.DataCategory = data_category
         if summarize_by is not None:
             c.SummarizeBy = System.Enum.Parse(TOM.AggregateFunction, summarize_by)
+        if is_nullable is not None:
+            c.IsNullable = is_nullable
+        if is_available_in_mdx is not None:
+            c.IsAvailableInMDX = is_available_in_mdx
 
     def update_role(
         self,
@@ -4160,6 +4210,28 @@ class TOMWrapper:
 
         self.model.Tables[table_name].Columns[column_name].SortByColumn = None
 
+    def is_calculated_column(self, table_name: str, column_name: str):
+        """
+        Identifies if a column is a calculated column.
+
+        Parameters
+        ----------
+        table_name : str
+            Name of the table in which the column resides.
+        column_name : str
+            Name of the column.
+
+        Returns
+        -------
+        bool
+            A boolean value indicating whether the column is a calculated column.
+        """
+
+        import Microsoft.AnalysisServices.Tabular as TOM
+
+        c = self.model.Tables[table_name].Columns[column_name]
+        return c.Type == TOM.ColumnType.Calculated
+
     def is_calculated_table(self, table_name: str):
         """
         Identifies if a table is a calculated table.
@@ -4186,6 +4258,171 @@ class TOMWrapper:
                 isCalcTable = True
         return isCalcTable
 
+    def update_lineage_tags(self):
+        """
+        Adds lineage and source lineage tags for relevant semantic model objects if they do not exist. Also updates schema name for Direct Lake (entity) partitions.
+        """
+
+        import Microsoft.AnalysisServices.Tabular as TOM
+
+        for t in self.model.Tables:
+            if len(t.LineageTag) == 0:
+                t.LineageTag = generate_guid()
+            if len(t.SourceLineageTag) == 0:
+                if next(p.Mode for p in t.Partitions) == TOM.ModeType.DirectLake:
+                    partition_name = next(p.Name for p in t.Partitions)
+                    entity_name = t.Partitions[partition_name].Source.EntityName
+                    schema_name = t.Partitions[partition_name].Source.SchemaName
+
+                    # Update schema name and source lineage tag for DL (entity) partitions
+                    if len(schema_name) == 0:
+                        schema_name = icons.default_schema
+                        t.Partitions[partition_name].Source.SchemaName = (
+                            icons.default_schema
+                        )
+                    t.SourceLineageTag = f"[{schema_name}].[{entity_name}]"
+                else:
+                    t.SourceLineageTag = generate_guid()
+        for c in self.all_columns():
+            if len(c.LineageTag) == 0:
+                c.LineageTag = generate_guid()
+            if len(c.SourceLineageTag) == 0:
+                c.SourceLineageTag = generate_guid()
+        for m in self.all_measures():
+            if len(m.LineageTag) == 0:
+                m.LineageTag = generate_guid()
+            if len(m.SourceLineageTag) == 0:
+                m.SourceLineageTag = generate_guid()
+        for h in self.all_hierarchies():
+            if len(h.LineageTag) == 0:
+                h.LineageTag = generate_guid()
+            if len(h.SourceLineageTag) == 0:
+                h.SourceLineageTag = generate_guid()
+        for lvl in self.all_levels():
+            if len(lvl.LineageTag) == 0:
+                lvl.LineageTag = generate_guid()
+            if len(lvl.SourceLineageTag) == 0:
+                lvl.SourceLineageTag = generate_guid()
+        for e in self.model.Expressions():
+            if len(e.LineageTag) == 0:
+                e.LineageTag = generate_guid()
+            if len(e.SourceLineageTag) == 0:
+                e.SourceLineageTag = generate_guid()
+
+    def generate_measure_descriptions(
+        self,
+        measure_name: Optional[str | List[str]] = None,
+        max_batch_size: Optional[int] = 5,
+    ):
+        """
+        Auto-generates descriptions for measures using an LLM.
+
+        Parameters
+        ----------
+        measure_name : str | List[str], default=None
+            The measure name (or a list of measure names).
+            Defaults to None which generates descriptions for all measures in the semantic model.
+        max_batch_size : int, default=5
+            Sets the max batch size for each API call.
+        """
+
+        # import concurrent.futures
+
+        if isinstance(measure_name, str):
+            measure_name = [measure_name]
+
+        workspace_id = fabric.resolve_workspace_id(self._workspace)
+        client = fabric.FabricRestClient()
+
+        if len(measure_name) > max_batch_size:
+            measure_lists = [
+                measure_name[i : i + max_batch_size]
+                for i in range(0, len(measure_name), max_batch_size)
+            ]
+        else:
+            measure_lists = [measure_name]
+
+        # Each API call can have a max of 5 measures
+        for measure_list in measure_lists:
+            payload = {
+                "scenarioDefinition": {
+                    "generateModelItemDescriptions": {
+                        "modelItems": [],
+                    },
+                },
+                "workspaceId": workspace_id,
+                "artifactInfo": {"artifactType": "SemanticModel"},
+            }
+            for m_name in measure_list:
+                expr, t_name = next(
+                    (ms.Expression, ms.Parent.Name)
+                    for ms in self.all_measures()
+                    if ms.Name == m_name
+                )
+                if t_name is None:
+                    raise ValueError(
+                        f"{icons.red_dot} The '{m_name}' measure does not exist in the '{self._dataset}' semantic model within the '{self._workspace}' workspace."
+                    )
+
+                new_item = {
+                    "urn": m_name,
+                    "type": 1,
+                    "name": m_name,
+                    "expression": expr,
+                }
+                payload["scenarioDefinition"]["generateModelItemDescriptions"][
+                    "modelItems"
+                ].append(new_item)
+
+            response = client.post("/explore/v202304/nl2nl/completions", json=payload)
+            if response.status_code != 200:
+                raise FabricHTTPException(response)
+
+            for item in response.json().get("modelItems", []):
+                ms_name = item["urn"]
+                if ms_name.startswith("urn: "):
+                    ms_name = ms_name[5:]
+                desc = item.get("description")
+                table_name = next(
+                    m.Parent.Name for m in self.all_measures() if m.Name == ms_name
+                )
+                self.model.Tables[table_name].Measures[ms_name].Description = desc
+
+        # def process_measure(m):
+        #     table_name = m.Parent.Name
+        #     m_name = m.Name
+        #     m_name_fixed = "1"
+        #     expr = m.Expression
+        #     if measure_name is None or m_name in measure_name:
+        #         payload = {
+        #             "scenarioDefinition": {
+        #                 "generateModelItemDescriptions": {
+        #                     "modelItems": [
+        #                         {
+        #                             "urn": f"modelobject://Table/{table_name}/Measure/{m_name_fixed}",
+        #                             "type": 1,
+        #                             "name": m_name,
+        #                             "expression": expr,
+        #                         }
+        #                     ]
+        #                 }
+        #             },
+        #             "workspaceId": workspace_id,
+        #             "artifactInfo": {"artifactType": "SemanticModel"},
+        #         }
+
+        #         response = client.post(
+        #             "/explore/v202304/nl2nl/completions", json=payload
+        #         )
+        #         if response.status_code != 200:
+        #             raise FabricHTTPException(response)
+
+        #         desc = response.json()["modelItems"][0]["description"]
+        #         m.Description = desc
+
+        # with concurrent.futures.ThreadPoolExecutor() as executor:
+        #     executor.map(process_measure, self.all_measures())
+
     def close(self):
         if not self._readonly and self.model is not None:
             self.model.SaveChanges()