semantic-link-labs 0.6.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

sempy_labs/tom/_model.py

@@ -6,7 +6,7 @@ from datetime import datetime
 from sempy_labs._helper_functions import format_dax_object_name
 from sempy_labs._list_functions import list_relationships
 from sempy_labs._refresh_semantic_model import refresh_semantic_model
-from sempy_labs.directlake._fallback import check_fallback_reason
+from sempy_labs.directlake._dl_helper import check_fallback_reason
 from contextlib import contextmanager
 from typing import List, Iterator, Optional, Union, TYPE_CHECKING
 from sempy._utils._log import log
@@ -229,6 +229,7 @@ class TOMWrapper:
         hidden: Optional[bool] = False,
         description: Optional[str] = None,
         display_folder: Optional[str] = None,
+        format_string_expression: Optional[str] = None,
     ):
         """
         Adds a measure to the semantic model.
@@ -249,6 +250,8 @@ class TOMWrapper:
             A description of the measure.
         display_folder : str, default=None
             The display folder in which the measure will reside.
+        format_string_expression : str, default=None
+            The format string expression.
         """
         import Microsoft.AnalysisServices.Tabular as TOM
 
@@ -262,6 +265,10 @@ class TOMWrapper:
             obj.Description = description
         if display_folder is not None:
             obj.DisplayFolder = display_folder
+        if format_string_expression is not None:
+            fsd = TOM.FormatStringDefinition()
+            fsd.Expression = format_string_expression
+            obj.FormatStringDefinition = fsd
 
         self.model.Tables[table_name].Measures.Add(obj)
 
@@ -499,8 +506,8 @@ class TOMWrapper:
         calculation_item_name: str,
         expression: str,
         ordinal: Optional[int] = None,
-        format_string_expression: Optional[str] = None,
         description: Optional[str] = None,
+        format_string_expression: Optional[str] = None,
     ):
         """
         Adds a `calculation item <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.calculationitem?view=analysisservices-dotnet>`_ to
@@ -524,7 +531,6 @@ class TOMWrapper:
         import Microsoft.AnalysisServices.Tabular as TOM
 
         obj = TOM.CalculationItem()
-        fsd = TOM.FormatStringDefinition()
         obj.Name = calculation_item_name
         obj.Expression = expression
         if ordinal is not None:
@@ -532,7 +538,9 @@ class TOMWrapper:
         if description is not None:
             obj.Description = description
         if format_string_expression is not None:
-            obj.FormatStringDefinition = fsd.Expression = format_string_expression
+            fsd = TOM.FormatStringDefinition()
+            fsd.Expression = format_string_expression
+            obj.FormatStringDefinition = fsd
         self.model.Tables[table_name].CalculationGroup.CalculationItems.Add(obj)
 
     def add_role(
@@ -1579,7 +1587,9 @@ class TOMWrapper:
                 except Exception:
                     pass
 
-        if objType == TOM.ObjectType.Column:
+        if objType == TOM.ObjectType.Table:
+            object.Parent.Tables.Remove(object.Name)
+        elif objType == TOM.ObjectType.Column:
             object.Parent.Columns.Remove(object.Name)
         elif objType == TOM.ObjectType.Measure:
             object.Parent.Measures.Remove(object.Name)
@@ -2554,7 +2564,9 @@ class TOMWrapper:
         t.Partitions.Add(par)
         self.model.Tables.Add(t)
 
-    def add_field_parameter(self, table_name: str, objects: List[str]):
+    def add_field_parameter(
+        self, table_name: str, objects: List[str], object_names: List[str] = None
+    ):
         """
         Adds a `field parameter <https://learn.microsoft.com/power-bi/create-reports/power-bi-field-parameters>`_ to the semantic model.
 
@@ -2566,6 +2578,9 @@ class TOMWrapper:
             The columns/measures to be included in the field parameter.
             Columns must be specified as such : 'Table Name'[Column Name].
             Measures may be formatted as '[Measure Name]' or 'Measure Name'.
+        object_names : List[str], default=None
+            The corresponding visible name for the measures/columns in the objects list.
+            Defaults to None which shows the measure/column name.
         """
 
         import Microsoft.AnalysisServices.Tabular as TOM
@@ -2580,38 +2595,30 @@ class TOMWrapper:
                 f"{icons.red_dot} There must be more than one object (column/measure) within the objects parameter."
             )
 
+        if object_names is not None and len(objects) != len(object_names):
+            raise ValueError(
+                f"{icons.red_dot} If the 'object_names' parameter is specified, it must correspond exactly to the 'objects' parameter."
+            )
+
         expr = ""
         i = 0
         for obj in objects:
+            index = objects.index(obj)
             success = False
             for m in self.all_measures():
-                if obj == "[" + m.Name + "]" or obj == m.Name:
-                    expr = (
-                        expr
-                        + "\n\t"
-                        + '("'
-                        + m.Name
-                        + '", NAMEOF(['
-                        + m.Name
-                        + "]), "
-                        + str(i)
-                        + "),"
-                    )
+                obj_name = m.Name
+                if obj == f"[{obj_name}]" or obj == obj_name:
+                    if object_names is not None:
+                        obj_name = object_names[index]
+                    expr = f'{expr}\n\t("{obj_name}", NAMEOF([{m.Name}]), {str(i)}),'
                     success = True
             for c in self.all_columns():
+                obj_name = c.Name
                 fullObjName = format_dax_object_name(c.Parent.Name, c.Name)
                 if obj == fullObjName or obj == c.Parent.Name + "[" + c.Name + "]":
-                    expr = (
-                        expr
-                        + "\n\t"
-                        + '("'
-                        + c.Name
-                        + '", NAMEOF('
-                        + fullObjName
-                        + "), "
-                        + str(i)
-                        + "),"
-                    )
+                    if object_names is not None:
+                        obj_name = object_names[index]
+                    expr = f'{expr}\n\t("{obj_name}", NAMEOF({fullObjName}), {str(i)}),'
                     success = True
             if not success:
                 raise ValueError(
@@ -3737,9 +3744,9 @@ class TOMWrapper:
         self,
         table_name: str,
         partition_name: str,
-        expression: Optional[str | None] = None,
-        mode: Optional[str | None] = None,
-        description: Optional[str | None] = None,
+        expression: Optional[str] = None,
+        mode: Optional[str] = None,
+        description: Optional[str] = None,
     ):
         """
         Updates an M partition for a table within a semantic model.
@@ -3779,11 +3786,12 @@ class TOMWrapper:
     def update_measure(
         self,
         measure_name: str,
-        expression: Optional[str | None] = None,
-        format_string: Optional[str | None] = None,
-        hidden: Optional[bool | None] = None,
-        description: Optional[str | None] = None,
-        display_folder: Optional[str | None] = None,
+        expression: Optional[str] = None,
+        format_string: Optional[str] = None,
+        hidden: Optional[bool] = None,
+        description: Optional[str] = None,
+        display_folder: Optional[str] = None,
+        format_string_expression: Optional[str] = None,
     ):
         """
         Updates a measure within a semantic model.
@@ -3807,6 +3815,9 @@ class TOMWrapper:
         display_folder : str, default=None
             The display folder in which the measure will reside.
             Defaults to None which keeps the existing setting.
+        format_string_expression : str, default=None
+            The format string expression for the calculation item.
+            Defaults to None which keeps the existing setting.
         """
 
         table_name = next(
@@ -3823,21 +3834,25 @@ class TOMWrapper:
             m.Description = description
         if display_folder is not None:
             m.DisplayFolder = display_folder
+        if format_string_expression is not None:
+            fsd = TOM.FormatStringDefinition()
+            fsd.Expression = format_string_expression
+            m.FormatStringDefinition = fsd
 
     def update_column(
         self,
         table_name: str,
         column_name: str,
-        source_column: Optional[str | None] = None,
-        data_type: Optional[str | None] = None,
-        expression: Optional[str | None] = None,
-        format_string: Optional[str | None] = None,
-        hidden: Optional[bool | None] = None,
-        description: Optional[str | None] = None,
-        display_folder: Optional[str | None] = None,
-        data_category: Optional[str | None] = None,
-        key: Optional[bool | None] = None,
-        summarize_by: Optional[str | None] = None,
+        source_column: Optional[str] = None,
+        data_type: Optional[str] = None,
+        expression: Optional[str] = None,
+        format_string: Optional[str] = None,
+        hidden: Optional[bool] = None,
+        description: Optional[str] = None,
+        display_folder: Optional[str] = None,
+        data_category: Optional[str] = None,
+        key: Optional[bool] = None,
+        summarize_by: Optional[str] = None,
     ):
         """
         Updates a column within a semantic model.
@@ -3910,8 +3925,8 @@ class TOMWrapper:
     def update_role(
         self,
         role_name: str,
-        model_permission: Optional[str | None] = None,
-        description: Optional[str | None] = None,
+        model_permission: Optional[str] = None,
+        description: Optional[str] = None,
     ):
         """
         Updates a role within a semantic model.
@@ -3944,10 +3959,10 @@ class TOMWrapper:
         self,
         table_name: str,
         calculation_item_name: str,
-        expression: Optional[str | None] = None,
-        ordinal: Optional[int | None] = None,
-        format_string_expression: Optional[str | None] = None,
-        description: Optional[str | None] = None,
+        expression: Optional[str] = None,
+        ordinal: Optional[int] = None,
+        description: Optional[str] = None,
+        format_string_expression: Optional[str] = None,
     ):
         """
         Updates a calculation item within a semantic model.
@@ -3964,22 +3979,24 @@ class TOMWrapper:
         ordinal : int, default=None
             The ordinal of the calculation item.
             Defaults to None which keeps the existing setting.
-        format_string_expression : str, default=None
-            The format string expression for the calculation item.
-            Defaults to None which keeps the existing setting.
         description : str, default=None
             The description of the role.
             Defaults to None which keeps the existing setting.
+        format_string_expression : str, default=None
+            The format string expression for the calculation item.
+            Defaults to None which keeps the existing setting.
         """
 
-        obj = self.Tables[table_name].CalculationGroup.CalculationItems[
+        obj = self.model.Tables[table_name].CalculationGroup.CalculationItems[
             calculation_item_name
         ]
 
         if expression is not None:
             obj.Expression = expression
         if format_string_expression is not None:
-            obj.FormatStringDefinition.Expression = format_string_expression
+            fsd = TOM.FormatStringDefinition()
+            fsd.Expression = format_string_expression
+            obj.FormatStringDefinition.Expression = fsd
         if ordinal is not None:
             obj.Ordinal = ordinal
         if description is not None:

semantic_link_labs-0.6.0.dist-info/METADATA

@@ -1,22 +0,0 @@
-Metadata-Version: 2.1
-Name: semantic-link-labs
-Version: 0.6.0
-Summary: Semantic Link Labs project
-Author: Microsoft Corporation
-License: MIT License
-Project-URL: Repository, https://github.com/microsoft/semantic-link-labs.git
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Education
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Framework :: Jupyter
-Requires-Python: <3.12,>=3.10
-License-File: LICENSE
-Requires-Dist: semantic-link-sempy >=0.7.6
-Requires-Dist: anytree
-Requires-Dist: powerbiclient
-Provides-Extra: test
-Requires-Dist: pytest >=8.2.1 ; extra == 'test'
-

semantic_link_labs-0.6.0.dist-info/RECORD

@@ -1,54 +0,0 @@
-sempy_labs/__init__.py,sha256=T_5thSoxVg83rUR_aac7P4kBKPrf5wylwRAxNMzYkjw,4976
-sempy_labs/_ai.py,sha256=1sWyWxM_fAqdT5Ih2F3QjqWepJ0R48RvffNHSZKfuXs,18079
-sempy_labs/_clear_cache.py,sha256=AfTCAwSK5EYhI2aBPsSun8FxJy-GHlByxH-rBxHfHzM,1362
-sempy_labs/_connections.py,sha256=w1dFC4WeTNFmLGD2EL_Syk0Wb1Eij18we2FVn_VaCD8,7641
-sempy_labs/_dax.py,sha256=dt1GgHceyM7f6phRBPxRKnmQy_KYKpcgFQHuOjGbpLo,2029
-sempy_labs/_generate_semantic_model.py,sha256=qdWL6GDuCstzGLzChNRZ_nr9CndIl-sKmYG1WrZHXcw,9689
-sempy_labs/_helper_functions.py,sha256=bcDDwy7LqOVV3x4scCSBxzMQuU2sLWBzgMSaluDrxEk,14306
-sempy_labs/_icons.py,sha256=RfKaIzFHvu9mtQo6N10w9BQUa9JPHQ6NtJUyASZBdTo,536
-sempy_labs/_list_functions.py,sha256=uNZsQD32jQqQYgOegLYO1m28pRqCpCqZMIm0fyA2QW0,82709
-sempy_labs/_model_auto_build.py,sha256=fX3bCLFCOMQHuheKIoB48fUABG7XAT7qqsMbUiWSrY0,5071
-sempy_labs/_model_bpa.py,sha256=PTC_vKKg-r66o0cXIGsx-0cW2ms-S1mWOLPZW8vGa2Q,14080
-sempy_labs/_model_bpa_rules.py,sha256=aDNudcvBLaKaDLy82MF2D8gbrAtVvrOt9u5AqDkltnk,47291
-sempy_labs/_model_dependencies.py,sha256=0uOhTMLpfhZ0mjIjhKacrvzOYs1uHoFfzc2hqTGAY50,12965
-sempy_labs/_one_lake_integration.py,sha256=r9gnLoFjzfJroAzlJ5aWpKs-rxemzJxnN7tADML0IQc,6246
-sempy_labs/_query_scale_out.py,sha256=-RMDO7T8QsIaDK3xXLyg1eOKXK5sKOBTrIISaKoSFRI,14901
-sempy_labs/_refresh_semantic_model.py,sha256=TGGdqMzpR0POXgaXkqxfD2ene-SwEvU3aujsVlkWX7E,6734
-sempy_labs/_translations.py,sha256=bWlLfz9ynFIQEBRHAWAyV1XZdYTUzLCTtipZKk6Fd_U,12920
-sempy_labs/_vertipaq.py,sha256=pIRfJKjsShxVDdMBoeO97vDvurZ98iblcSdtowSJgxQ,33303
-sempy_labs/directlake/__init__.py,sha256=yDoHDd4TyP7wTTjgMASTsjyXgRrTJwJjgml-IjVl460,1781
-sempy_labs/directlake/_directlake_schema_compare.py,sha256=xljJ60aymEJeQV9w-0NQTzFGA8AUiYvsByX7QqHxglg,4716
-sempy_labs/directlake/_directlake_schema_sync.py,sha256=VzTT9o6xceVfx_8wJkvXwy1jGwjH5HztIrQ_Vwh4B4Q,4940
-sempy_labs/directlake/_fallback.py,sha256=o6FswFiisMVbDqRTCJ2hHa1M65KafkGjaqQl5PQ6szQ,1992
-sempy_labs/directlake/_get_directlake_lakehouse.py,sha256=IkkpJe7iFbKT_9KCMdaLucuw_WCcdmEQd3bz6-Wmgx0,2346
-sempy_labs/directlake/_get_shared_expression.py,sha256=3KIrsaCX-t2r4_anC8Z4MMlbu3Iaa_gCHCC8Ok7NDxA,1936
-sempy_labs/directlake/_guardrails.py,sha256=pnLYM7ZO6_hq38UMNeJRx5Fp9XbcIpgPuAS3py24oA8,2259
-sempy_labs/directlake/_list_directlake_model_calc_tables.py,sha256=_rpnbgsFAz2W16PpgIOB0Rj_Fs1ZKrDbz3DUaaR_bfU,2143
-sempy_labs/directlake/_show_unsupported_directlake_objects.py,sha256=QNj2wHzFGtjnsAICmlc7BuhCYkw0An0XnditDTCG2JM,3358
-sempy_labs/directlake/_update_directlake_model_lakehouse_connection.py,sha256=b_Y5_GSfWC25wH6R7L37-AHO9fvKkmxRGaP6dVDC7-w,3233
-sempy_labs/directlake/_update_directlake_partition_entity.py,sha256=nMh2CqQrp64NipmryuLKewljmFt6aVKaecIwSedIFIw,7687
-sempy_labs/directlake/_warm_cache.py,sha256=RjpRjtzSaKw6gHKPw4O6phBwmnk7LHp4B1yrW8Z6VEY,8242
-sempy_labs/lakehouse/__init__.py,sha256=i6VRx4dR1SIN-1GxioiNwhC4FxbozRCIz5TfXjb9rKc,587
-sempy_labs/lakehouse/_get_lakehouse_columns.py,sha256=Bb_iCTlNwl0wdN4dW_E7tVnfbHhHwQT_l0SUqvcbYpo,2582
-sempy_labs/lakehouse/_get_lakehouse_tables.py,sha256=c2pqEyhiEJhnRaE3Zlz3EHRmR9bFI6J7CZxqLVa87iE,9091
-sempy_labs/lakehouse/_lakehouse.py,sha256=kUMiGi8SyY4oTWAB4OFzGQzlqUdAF2EolpZza15gFrE,2763
-sempy_labs/lakehouse/_shortcuts.py,sha256=oDYexjMxZX2JoaEqSyO1R_PQ2c5qTUNVbHGtVQJZorg,6977
-sempy_labs/migration/__init__.py,sha256=w4vvGk6wTWXVfofJDmio2yIFvSSJsxOpjv6mvNGmrOI,1043
-sempy_labs/migration/_create_pqt_file.py,sha256=XTG1BQJbfgKpwT8jKWrlCfDuMYdecM94qTLzrpQ7wck,9035
-sempy_labs/migration/_migrate_calctables_to_lakehouse.py,sha256=6Z1DIdZCi_LX0o-SfPO5zzqWa0hd_zEwcQzIsOer9SM,20551
-sempy_labs/migration/_migrate_calctables_to_semantic_model.py,sha256=Ne-2_PwW_LUR8vG2pNY3lxa9iib1dIpYkDHRaqyqyY8,6420
-sempy_labs/migration/_migrate_model_objects_to_semantic_model.py,sha256=T7Ijo9g9AmB8KMyqvYOTurSdabUKKaRcfdstSgL1QQ8,24399
-sempy_labs/migration/_migrate_tables_columns_to_semantic_model.py,sha256=1ZWQ9sawd2_ojTnWTsRaDEj7yMnUVOpCQZeI0YHhb-g,7066
-sempy_labs/migration/_migration_validation.py,sha256=phbUUIYA5z4dZvEKrVbByMTPPwMscY7Dy9HVxE8z_HM,2483
-sempy_labs/migration/_refresh_calc_tables.py,sha256=pImD8wMOMxs043e6s4G2TPrFzsGVHklK1aez_oVOgro,6086
-sempy_labs/report/__init__.py,sha256=78lLE4UlmwfSY-6FxMIgnshMQF90Qfq_qM7A3vrNtHw,848
-sempy_labs/report/_generate_report.py,sha256=fJUiUgsF2mS-dyaVjRvwAASvbSrSm8BUDB53Ru3rhQI,8545
-sempy_labs/report/_report_functions.py,sha256=6xpLyVrRkA2ZwwCj2By8_HX2k-EHoQUZtuUaTy0d7vM,30004
-sempy_labs/report/_report_rebind.py,sha256=PmZ3f3Rf3Yka8Eaea87JosSiFvEtzjfbUDQOzRx_vlQ,4614
-sempy_labs/tom/__init__.py,sha256=Qbs8leW0fjzvWwOjyWK3Hjeehu7IvpB1beASGsi28bk,121
-sempy_labs/tom/_model.py,sha256=kGRfpA6IHy8KX6QKVciekOa2Y97d6r0eRol5K8YMMIg,149938
-semantic_link_labs-0.6.0.dist-info/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
-semantic_link_labs-0.6.0.dist-info/METADATA,sha256=ZFdW982vsZ0btahdjKpAgiDMEXxnjn_nwiPY8iMMrdI,764
-semantic_link_labs-0.6.0.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
-semantic_link_labs-0.6.0.dist-info/top_level.txt,sha256=kiQX1y42Dbein1l3Q8jMUYyRulDjdlc2tMepvtrvixQ,11
-semantic_link_labs-0.6.0.dist-info/RECORD,,

sempy_labs/directlake/_fallback.py

@@ -1,60 +0,0 @@
-import sempy.fabric as fabric
-import numpy as np
-from typing import Optional
-import sempy_labs._icons as icons
-
-
-def check_fallback_reason(dataset: str, workspace: Optional[str] = None):
-    """
-    Shows the reason a table in a Direct Lake semantic model would fallback to DirectQuery.
-
-    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.
-
-    Returns
-    -------
-    pandas.DataFrame
-        The tables in the semantic model and their fallback reason.
-    """
-
-    workspace = fabric.resolve_workspace_name(workspace)
-
-    dfP = fabric.list_partitions(dataset=dataset, workspace=workspace)
-    dfP_filt = dfP[dfP["Mode"] == "DirectLake"]
-
-    if len(dfP_filt) == 0:
-        raise ValueError(
-            f"{icons.red_dot} The '{dataset}' semantic model is not in Direct Lake. This function is only applicable to Direct Lake semantic models."
-        )
-    else:
-        df = fabric.evaluate_dax(
-            dataset=dataset,
-            workspace=workspace,
-            dax_string="""
-        SELECT [TableName] AS [Table Name],[FallbackReason] AS [FallbackReasonID]
-        FROM $SYSTEM.TMSCHEMA_DELTA_TABLE_METADATA_STORAGES
-        """,
-        )
-
-        value_mapping = {
-            0: "No reason for fallback",
-            1: "This table is not framed",
-            2: "This object is a view in the lakehouse",
-            3: "The table does not exist in the lakehouse",
-            4: "Transient error",
-            5: "Using OLS will result in fallback to DQ",
-            6: "Using RLS will result in fallback to DQ",
-        }
-
-        # Create a new column based on the mapping
-        df["Fallback Reason Detail"] = np.vectorize(value_mapping.get)(
-            df["FallbackReasonID"]
-        )
-
-        return df