semantic-link-labs 0.4.1__py3-none-any.whl → 0.4.2__py3-none-any.whl

sempy_labs/{_tom.py → tom/_model.py}

@@ -8,7 +8,7 @@ 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 contextlib import contextmanager
-from typing import List, Optional, Union, TYPE_CHECKING
+from typing import List, Iterator, Optional, Union, TYPE_CHECKING
 from sempy._utils._log import log
 import sempy_labs._icons as icons
 
@@ -17,32 +17,28 @@ if TYPE_CHECKING:
     import Microsoft.AnalysisServices.Tabular as TOM
 
 
-checked = "\u2611"
-unchecked = "\u2610"
-start_bold = "\033[1m"
-end_bold = "\033[0m"
-
-
 class TOMWrapper:
     """
-    Convenience wrapper around the TOM object model for a semantic model. Always use connect_semantic_model function to make sure the TOM object is initialized correctly.
+    Convenience wrapper around the TOM object model for a semantic model. Always use the connect_semantic_model function to make sure the TOM object is initialized correctly.
+
+    `XMLA read/write endpoints <https://learn.microsoft.com/power-bi/enterprise/service-premium-connect-tools#to-enable-read-write-for-a-premium-capacity>`_ must be enabled if setting the readonly parameter to False.
     """
 
-    dataset: str
-    workspace: str
-    readonly: bool
-    tables_added: List[str]
+    _dataset: str
+    _workspace: str
+    _readonly: bool
+    _tables_added: List[str]
 
     def __init__(self, dataset, workspace, readonly):
-        self.dataset = dataset
-        self.workspace = workspace
-        self.readonly = readonly
-        self.tables_added = []
+        self._dataset = dataset
+        self._workspace = workspace
+        self._readonly = readonly
+        self._tables_added = []
 
-        self.tom_server = fabric.create_tom_server(
+        self._tom_server = fabric.create_tom_server(
             readonly=readonly, workspace=workspace
         )
-        self.model = self.tom_server.Databases.GetByName(dataset).Model
+        self.model = self._tom_server.Databases.GetByName(dataset).Model
 
     def all_columns(self):
         """
@@ -181,10 +177,10 @@ class TOMWrapper:
             All levels within the semantic model.
         """
 
-        for t in self.model.Tables:
-            for h in t.Hierarchies:
-                for l in h.Levels:
-                    yield l
+        for table in self.model.Tables:
+            for hierarchy in table.Hierarchies:
+                for level in hierarchy.Levels:
+                    yield level
 
     def all_calculation_items(self):
         """
@@ -459,7 +455,7 @@ class TOMWrapper:
             Marks the column as the primary key of the table.
         summarize_by : str, default=None
             Sets the value for the Summarize By property of the column.
-            Defaults to None resolves to 'Default'.
+            Defaults to None which resolves to 'Default'.
         """
         import Microsoft.AnalysisServices.Tabular as TOM
         import System
@@ -504,7 +500,7 @@ class TOMWrapper:
         description: Optional[str] = None,
     ):
         """
-        Adds a calculation item to a calculation group within a semantic model.
+        Adds a `calculation item <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.calculationitem?view=analysisservices-dotnet>`_ to a `calculation group <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.calculationgroup?view=analysisservices-dotnet>`_ within a semantic model.
 
         Parameters
         ----------
@@ -642,7 +638,7 @@ class TOMWrapper:
         hierarchy_hidden: Optional[bool] = False,
     ):
         """
-        Adds a hierarchy to a table within a semantic model.
+        Adds a `hierarchy <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.hierarchy?view=analysisservices-dotnet>`_ to a table within a semantic model.
 
         Parameters
         ----------
@@ -663,11 +659,11 @@ class TOMWrapper:
 
         if isinstance(columns, str):
             print(
-                f"The 'levels' parameter must be a list. For example: ['Continent', 'Country', 'City']"
+                f"{icons.red_dot} The 'levels' parameter must be a list. For example: ['Continent', 'Country', 'City']"
             )
             return
         if len(columns) == 1:
-            print(f"There must be at least 2 levels in order to create a hierarchy.")
+            print(f"{icons.red_dot} There must be at least 2 levels in order to create a hierarchy.")
             return
 
         if levels is None:
@@ -675,7 +671,7 @@ class TOMWrapper:
 
         if len(columns) != len(levels):
             print(
-                f"If specifying level names, you must specify a level for each column."
+                f"{icons.red_dot} If specifying level names, you must specify a level for each column."
             )
             return
 
@@ -707,7 +703,7 @@ class TOMWrapper:
         rely_on_referential_integrity: Optional[bool] = False,
     ):
         """
-        Adds a relationship to a semantic model.
+        Adds a `relationship <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.singlecolumnrelationship?view=analysisservices-dotnet>`_ to a semantic model.
 
         Parameters
         ----------
@@ -779,7 +775,7 @@ class TOMWrapper:
         hidden: Optional[bool] = False,
     ):
         """
-        Adds a calculation group to a semantic model.
+        Adds a `calculation group <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.calculationgroup?view=analysisservices-dotnet>`_ to a semantic model.
 
         Parameters
         ----------
@@ -832,7 +828,7 @@ class TOMWrapper:
         self, name: str, expression: str, description: Optional[str] = None
     ):
         """
-        Adds an expression to a semantic model.
+        Adds an `expression <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.namedexpression?view=analysisservices-dotnet>`_ to a semantic model.
 
         Parameters
         ----------
@@ -856,7 +852,7 @@ class TOMWrapper:
 
     def add_translation(self, language: str):
         """
-        Adds a translation language (culture) to a semantic model.
+        Adds a `translation language <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.culture?view=analysisservices-dotnet>`_ (culture) to a semantic model.
 
         Parameters
         ----------
@@ -875,7 +871,7 @@ class TOMWrapper:
 
     def add_perspective(self, perspective_name: str):
         """
-        Adds a perspective to a semantic model.
+        Adds a `perspective <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.perspective?view=analysisservices-dotnet>`_ to a semantic model.
 
         Parameters
         ----------
@@ -910,18 +906,22 @@ class TOMWrapper:
         mode : str, default=None
             The query mode for the partition.
             Defaults to None which resolves to 'Import'.
+            `Valid mode values <https://learn.microsoft.com/en-us/dotnet/api/microsoft.analysisservices.tabular.modetype?view=analysisservices-dotnet>`_
         description : str, default=None
             A description for the partition.
         """
         import Microsoft.AnalysisServices.Tabular as TOM
         import System
 
-        mode = (
-            mode.title()
-            .replace("query", "Query")
-            .replace(" ", "")
-            .replace("lake", "Lake")
-        )
+        if mode is None:
+            mode = "Default"
+        else:
+            mode = (
+                mode.title()
+                .replace("query", "Query")
+                .replace(" ", "")
+                .replace("lake", "Lake")
+            )
 
         mp = TOM.MPartitionSource()
         mp.Expression = expression
@@ -930,8 +930,6 @@ class TOMWrapper:
         p.Source = mp
         if description is not None:
             p.Description = description
-        if mode is None:
-            mode = "Default"
         p.Mode = System.Enum.Parse(TOM.ModeType, mode)
 
         self.model.Tables[table_name].Partitions.Add(p)
@@ -966,7 +964,7 @@ class TOMWrapper:
         if expression is None:
             ep.ExpressionSource = self.model.Expressions["DatabaseQuery"]
         else:
-            ep.ExpressionSource = expression
+            ep.ExpressionSource = self.model.Expressions[expression]
         p = TOM.Partition()
         p.Name = table_name
         p.Source = ep
@@ -985,7 +983,7 @@ class TOMWrapper:
         base_column: Optional[str] = None,
     ):
         """
-        Sets the 'alternate of' property on a column.
+        Sets the `alternate of <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.alternateof?view=analysisservices-dotnet>`_ property on a column.
 
         Parameters
         ----------
@@ -1006,7 +1004,7 @@ class TOMWrapper:
 
         if base_column is not None and base_table is None:
             print(
-                f"ERROR: If you specify the base table you must also specify the base column"
+                f"{icons.red_dot} If you specify the base table you must also specify the base column"
             )
 
         summarization_type = (
@@ -1018,7 +1016,7 @@ class TOMWrapper:
         summarizationTypes = ["Sum", "GroupBy", "Count", "Min", "Max"]
         if summarization_type not in summarizationTypes:
             print(
-                f"The 'summarization_type' parameter must be one of the following valuse: {summarizationTypes}."
+                f"{icons.red_dot} The 'summarization_type' parameter must be one of the following valuse: {summarizationTypes}."
             )
             return
 
@@ -1039,7 +1037,7 @@ class TOMWrapper:
 
     def remove_alternate_of(self, table_name: str, column_name: str):
         """
-        Removes the 'alternate of' property on a column.
+        Removes the `alternate of <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.alternateof?view=analysisservices-dotnet>`_ property on a column.
 
         Parameters
         ----------
@@ -1059,7 +1057,7 @@ class TOMWrapper:
         self, object
     ) -> "Microsoft.AnalysisServices.Tabular.Annotation":
         """
-        Shows all annotations for a given object within a semantic model.
+        Shows all `annotations <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.annotation?view=analysisservices-dotnet>`_ for a given object within a semantic model.
 
         Parameters
         ----------
@@ -1081,7 +1079,7 @@ class TOMWrapper:
 
     def set_annotation(self, object, name: str, value: str):
         """
-        Sets an annotation on an object within the semantic model.
+        Sets an `annotation <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.annotation?view=analysisservices-dotnet>`_ on an object within the semantic model.
 
         Parameters
         ----------
@@ -1105,7 +1103,7 @@ class TOMWrapper:
 
     def get_annotation_value(self, object, name: str):
         """
-        Obtains the annotation value for a given annotation on an object within the semantic model.
+        Obtains the `annotation <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.annotation?view=analysisservices-dotnet>`_ value for a given annotation on an object within the semantic model.
 
         Parameters
         ----------
@@ -1124,7 +1122,7 @@ class TOMWrapper:
 
     def remove_annotation(self, object, name: str):
         """
-        Removes an annotation on an object within the semantic model.
+        Removes an `annotation <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.annotation?view=analysisservices-dotnet>`_ on an object within the semantic model.
 
         Parameters
         ----------
@@ -1138,7 +1136,7 @@ class TOMWrapper:
 
     def clear_annotations(self, object):
         """
-        Removes all annotations on an object within the semantic model.
+        Removes all `annotations <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.annotation?view=analysisservices-dotnet>`_ on an object within the semantic model.
 
         Parameters
         ----------
@@ -1152,7 +1150,7 @@ class TOMWrapper:
         self, object
     ) -> "Microsoft.AnalysisServices.Tabular.ExtendedProperty":
         """
-        Retrieves all extended properties on an object within the semantic model.
+        Retrieves all `extended properties <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.extendedproperty?view=analysisservices-dotnet>`_ on an object within the semantic model.
 
         Parameters
         ----------
@@ -1172,7 +1170,7 @@ class TOMWrapper:
         self, object, extended_property_type: str, name: str, value: str
     ):
         """
-        Sets an extended property on an object within the semantic model.
+        Sets an `extended property <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.extendedproperty?view=analysisservices-dotnet>`_ on an object within the semantic model.
 
         Parameters
         ----------
@@ -1205,7 +1203,7 @@ class TOMWrapper:
 
     def get_extended_property_value(self, object, name: str):
         """
-        Retrieves the value of an extended property for an object within the semantic model.
+        Retrieves the value of an `extended property <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.extendedproperty?view=analysisservices-dotnet>`_ for an object within the semantic model.
 
         Parameters
         ----------
@@ -1224,7 +1222,7 @@ class TOMWrapper:
 
     def remove_extended_property(self, object, name: str):
         """
-        Removes an extended property on an object within the semantic model.
+        Removes an `extended property <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.extendedproperty?view=analysisservices-dotnet>`_ on an object within the semantic model.
 
         Parameters
         ----------
@@ -1238,7 +1236,7 @@ class TOMWrapper:
 
     def clear_extended_properties(self, object):
         """
-        Removes all extended properties on an object within the semantic model.
+        Removes all `extended properties <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.extendedproperty?view=analysisservices-dotnet>`_ on an object within the semantic model.
 
         Parameters
         ----------
@@ -1254,7 +1252,7 @@ class TOMWrapper:
         perspective_name: str,
     ):
         """
-        Indicates whether an object is contained within a given perspective.
+        Indicates whether an object is contained within a given `perspective <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.perspective?view=analysisservices-dotnet>`_.
 
         Parameters
         ----------
@@ -1280,7 +1278,7 @@ class TOMWrapper:
 
         if objectType not in validObjects:
             print(
-                f"Only the following object types are valid for perspectives: {validObjects}."
+                f"{icons.red_dot} Only the following object types are valid for perspectives: {validObjects}."
             )
             return
 
@@ -1313,7 +1311,7 @@ class TOMWrapper:
         perspective_name: str,
     ):
         """
-        Adds an object to a perspective.
+        Adds an object to a `perspective <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.perspective?view=analysisservices-dotnet>`_.
 
         Parameters
         ----------
@@ -1334,13 +1332,13 @@ class TOMWrapper:
 
         if objectType not in validObjects:
             print(
-                f"Only the following object types are valid for perspectives: {validObjects}."
+                f"{icons.red_dot} Only the following object types are valid for perspectives: {validObjects}."
             )
             return
         try:
             object.Model.Perspectives[perspective_name]
         except:
-            print(f"The '{perspective_name}' perspective does not exist.")
+            print(f"{icons.red_dot} The '{perspective_name}' perspective does not exist.")
             return
 
         # try:
@@ -1375,7 +1373,7 @@ class TOMWrapper:
         perspective_name: str,
     ):
         """
-        Removes an object from a perspective.
+        Removes an object from a `perspective <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.perspective?view=analysisservices-dotnet>`_.
 
         Parameters
         ----------
@@ -1396,13 +1394,13 @@ class TOMWrapper:
 
         if objectType not in validObjects:
             print(
-                f"Only the following object types are valid for perspectives: {validObjects}."
+                f"{icons.red_dot} Only the following object types are valid for perspectives: {validObjects}."
             )
             return
         try:
             object.Model.Perspectives[perspective_name]
         except:
-            print(f"The '{perspective_name}' perspective does not exist.")
+            print(f"{icons.red_dot} The '{perspective_name}' perspective does not exist.")
             return
 
         # try:
@@ -1449,7 +1447,7 @@ class TOMWrapper:
         value: str,
     ):
         """
-        Sets a translation value for an object's property.
+        Sets a `translation <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.culture?view=analysisservices-dotnet>`_ value for an object's property.
 
         Parameters
         ----------
@@ -1476,7 +1474,7 @@ class TOMWrapper:
         ]  # , 'Level'
 
         if object.ObjectType not in validObjects:
-            print(f"Translations can only be set to {validObjects}.")
+            print(f"{icons.red_dot} Translations can only be set to {validObjects}.")
             return
 
         mapping = {
@@ -1491,7 +1489,7 @@ class TOMWrapper:
             object.Model.Cultures[language]
         except:
             print(
-                f"The '{language}' translation language does not exist in the semantic model."
+                f"{icons.red_dot} The '{language}' translation language does not exist in the semantic model."
             )
             return
 
@@ -1505,7 +1503,7 @@ class TOMWrapper:
         language: str,
     ):
         """
-        Removes an object's translation value.
+        Removes an object's `translation <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.culture?view=analysisservices-dotnet>`_ value.
 
         Parameters
         ----------
@@ -1579,7 +1577,7 @@ class TOMWrapper:
 
     def used_in_relationships(self, object: Union["TOM.Table", "TOM.Column"]):
         """
-        Shows all relationships in which a table/column is used.
+        Shows all `relationships <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.singlecolumnrelationship?view=analysisservices-dotnet>`_ in which a table/column is used.
 
         Parameters
         ----------
@@ -1612,7 +1610,7 @@ class TOMWrapper:
 
     def used_in_levels(self, column: "TOM.Column"):
         """
-        Shows all levels in which a column is used.
+        Shows all `levels <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.level?view=analysisservices-dotnet>`_ in which a column is used.
 
         Parameters
         ----------
@@ -1629,16 +1627,16 @@ class TOMWrapper:
         objType = column.ObjectType
 
         if objType == TOM.ObjectType.Column:
-            for l in self.all_levels():
+            for level in self.all_levels():
                 if (
-                    l.Parent.Table.Name == column.Parent.Name
-                    and l.Column.Name == column.Name
+                    level.Parent.Table.Name == column.Parent.Name
+                    and level.Column.Name == column.Name
                 ):
-                    yield l
+                    yield level
 
     def used_in_hierarchies(self, column: "TOM.Column"):
         """
-        Shows all hierarchies in which a column is used.
+        Shows all `hierarchies <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.hierarchy?view=analysisservices-dotnet>`_ in which a column is used.
 
         Parameters
         ----------
@@ -1691,7 +1689,7 @@ class TOMWrapper:
         dependencies: pd.DataFrame,
     ):
         """
-        Identifies the filter expressions which reference a given object.
+        Identifies the row level security `filter expressions <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.tablepermission.filterexpression?view=analysisservices-dotnet#microsoft-analysisservices-tabular-tablepermission-filterexpression>`_ which reference a given object.
 
         Parameters
         ----------
@@ -1855,7 +1853,7 @@ class TOMWrapper:
 
     def hybrid_tables(self):
         """
-        Outputs the hybrid tables within a semantic model.
+        Outputs the `hybrid tables <https://learn.microsoft.com/power-bi/connect-data/service-dataset-modes-understand#hybrid-tables>`_ within a semantic model.
 
         Parameters
         ----------
@@ -1874,7 +1872,7 @@ class TOMWrapper:
 
     def date_tables(self):
         """
-        Outputs the tables which are marked as date tables within a semantic model.
+        Outputs the tables which are marked as `date tables <https://learn.microsoft.com/power-bi/transform-model/desktop-date-tables>`_ within a semantic model.
 
         Parameters
         ----------
@@ -1895,7 +1893,7 @@ class TOMWrapper:
 
     def is_hybrid_table(self, table_name: str):
         """
-        Identifies if a table is a hybrid table.
+        Identifies if a table is a `hybrid table <https://learn.microsoft.com/power-bi/connect-data/service-dataset-modes-understand#hybrid-tables>`_.
 
         Parameters
         ----------
@@ -1925,7 +1923,7 @@ class TOMWrapper:
 
     def is_date_table(self, table_name: str):
         """
-        Identifies if a table is marked as a date table.
+        Identifies if a table is marked as a `date tables <https://learn.microsoft.com/power-bi/transform-model/desktop-date-tables>`_.
 
         Parameters
         ----------
@@ -1939,18 +1937,11 @@ class TOMWrapper:
         """
         import Microsoft.AnalysisServices.Tabular as TOM
 
-        isDateTable = False
-        t = self.model.Tables[table_name]
-
-        if t.DataCategory == "Time":
-            if any(c.IsKey and c.DataType == TOM.DataType.DateTime for c in t.Columns):
-                isDateTable = True
-
-        return isDateTable
+        return any(c.IsKey and c.DataType == TOM.DataType.DateTime for c in self.all_columns() if c.Parent.Name == table_name and c.Parent.DataCategory == 'Time')
 
     def mark_as_date_table(self, table_name: str, column_name: str):
         """
-        Marks a table as a date table.
+        Marks a table as a `date table <https://learn.microsoft.com/power-bi/transform-model/desktop-date-tables>`_.
 
         Parameters
         ----------
@@ -1983,7 +1974,7 @@ class TOMWrapper:
         )
         """
         df = fabric.evaluate_dax(
-            dataset=self.dataset, workspace=self.workspace, dax_string=daxQuery
+            dataset=self._dataset, workspace=self._workspace, dax_string=daxQuery
         )
         value = df["1"].iloc[0]
         if value != "1":
@@ -2001,7 +1992,7 @@ class TOMWrapper:
 
     def has_aggs(self):
         """
-        Identifies if a semantic model has any aggregations.
+        Identifies if a semantic model has any `aggregations <https://learn.microsoft.com/power-bi/transform-model/aggregations-advanced>`_.
 
         Parameters
         ----------
@@ -2012,17 +2003,11 @@ class TOMWrapper:
             Indicates if the semantic model has any aggregations.
         """
 
-        hasAggs = False
-
-        for c in self.all_columns():
-            if c.AlterateOf is not None:
-                hasAggs = True
-
-        return hasAggs
+        return any(c.AlternateOf is not None for c in self.all_columns())
 
     def is_agg_table(self, table_name: str):
         """
-        Identifies if a table has aggregations.
+        Identifies if a table has `aggregations <https://learn.microsoft.com/power-bi/transform-model/aggregations-advanced>`_.
 
         Parameters
         ----------
@@ -2041,7 +2026,7 @@ class TOMWrapper:
 
     def has_hybrid_table(self):
         """
-        Identifies if a semantic model has a hybrid table.
+        Identifies if a semantic model has a `hybrid table <https://learn.microsoft.com/power-bi/connect-data/service-dataset-modes-understand#hybrid-tables>`_.
 
         Parameters
         ----------
@@ -2050,19 +2035,13 @@ class TOMWrapper:
         -------
         bool
             Indicates if the semantic model has a hybrid table.
-        """
-
-        hasHybridTable = False
+        """    
 
-        for t in self.model.Tables:
-            if self.is_hybrid_table(table_name=t.Name):
-                hasHybridTable = True
-
-        return hasHybridTable
+        return any(self.is_hybrid_table(table_name=t.Name) for t in self.model.Tables)
 
     def has_date_table(self):
         """
-        Identifies if a semantic model has a table marked as a date table.
+        Identifies if a semantic model has a table marked as a `date table <https://learn.microsoft.com/power-bi/transform-model/desktop-date-tables>`_.
 
         Parameters
         ----------
@@ -2073,17 +2052,11 @@ class TOMWrapper:
             Indicates if the semantic model has a table marked as a date table.
         """
 
-        hasDateTable = False
-
-        for t in self.model.Tables:
-            if self.is_date_table(table_name=t.Name):
-                hasDateTable = True
-
-        return hasDateTable
+        return any(self.is_date_table(table_name=t.Name) for t in self.model.Tables)
 
     def is_direct_lake(self):
         """
-        Identifies if a semantic model is in Direct Lake mode.
+        Identifies if a semantic model is in `Direct Lake <https://learn.microsoft.com/fabric/get-started/direct-lake-overview>`_ mode.
 
         Parameters
         ----------
@@ -2093,6 +2066,7 @@ class TOMWrapper:
         bool
             Indicates if the semantic model is in Direct Lake mode.
         """
+        import Microsoft.AnalysisServices.Tabular as TOM
 
         return any(
             p.Mode == TOM.ModeType.DirectLake
@@ -2102,7 +2076,7 @@ class TOMWrapper:
 
     def is_field_parameter(self, table_name: str):
         """
-        Identifies if a table is a field parameter.
+        Identifies if a table is a `field parameter <https://learn.microsoft.com/power-bi/create-reports/power-bi-field-parameters>`_.
 
         Parameters
         ----------
@@ -2134,7 +2108,7 @@ class TOMWrapper:
 
     def is_auto_date_table(self, table_name: str):
         """
-        Identifies if a table is an auto-date table.
+        Identifies if a table is an `auto date/time table <https://learn.microsoft.com/power-bi/transform-model/desktop-auto-date-time>`_.
 
         Parameters
         ----------
@@ -2174,7 +2148,7 @@ class TOMWrapper:
         status_graphic: Optional[str] = None,
     ):
         """
-        Sets the properties to add/update a KPI for a measure.
+        Sets the properties to add/update a `KPI <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.kpi?view=analysisservices-dotnet>`_ for a measure.
 
         Parameters
         ----------
@@ -2203,47 +2177,48 @@ class TOMWrapper:
 
         if measure_name == target:
             print(
-                f"The 'target' parameter cannot be the same measure as the 'measure_name' parameter."
+                f"{icons.red_dot} The 'target' parameter cannot be the same measure as the 'measure_name' parameter."
             )
             return
 
         if status_graphic is None:
             status_graphic = "Three Circles Colored"
 
-        statusType = ["Linear", "LinearReversed", "Centered", "CenteredReversed"]
-        status_type = status_type.title().replace(" ", "")
-
+        valid_status_types = ["Linear", "LinearReversed", "Centered", "CenteredReversed"]
+        status_type = status_type
         if status_type is None:
             status_type = "Linear"
+        else:
+            status_type = status_type.title().replace(" ", "")
 
-        if status_type not in statusType:
+        if status_type not in valid_status_types:
             print(
-                f"'{status_type}' is an invalid status_type. Please choose from these options: {statusType}."
+                f"{icons.red_dot} '{status_type}' is an invalid status_type. Please choose from these options: {valid_status_types}."
             )
             return
 
         if status_type in ["Linear", "LinearReversed"]:
             if upper_bound is not None or lower_mid_bound is not None:
                 print(
-                    f"The 'upper_mid_bound' and 'lower_mid_bound' parameters are not used in the 'Linear' and 'LinearReversed' status types. Make sure these parameters are set to None."
+                    f"{icons.red_dot} The 'upper_mid_bound' and 'lower_mid_bound' parameters are not used in the 'Linear' and 'LinearReversed' status types. Make sure these parameters are set to None."
                 )
                 return
             elif upper_bound <= lower_bound:
-                print(f"The upper_bound must be greater than the lower_bound.")
+                print(f"{icons.red_dot} The upper_bound must be greater than the lower_bound.")
                 return
 
         if status_type in ["Centered", "CenteredReversed"]:
             if upper_mid_bound is None or lower_mid_bound is None:
                 print(
-                    f"The 'upper_mid_bound' and 'lower_mid_bound' parameters are necessary in the 'Centered' and 'CenteredReversed' status types."
+                    f"{icons.red_dot} The 'upper_mid_bound' and 'lower_mid_bound' parameters are necessary in the 'Centered' and 'CenteredReversed' status types."
                 )
                 return
             elif upper_bound <= upper_mid_bound:
-                print(f"The upper_bound must be greater than the upper_mid_bound.")
+                print(f"{icons.red_dot} The upper_bound must be greater than the upper_mid_bound.")
             elif upper_mid_bound <= lower_mid_bound:
-                print(f"The upper_mid_bound must be greater than the lower_mid_bound.")
+                print(f"{icons.red_dot} The upper_mid_bound must be greater than the lower_mid_bound.")
             elif lower_mid_bound <= lower_bound:
-                print(f"The lower_mid_bound must be greater than the lower_bound.")
+                print(f"{icons.red_dot} The lower_mid_bound must be greater than the lower_bound.")
 
         try:
             table_name = next(
@@ -2251,7 +2226,7 @@ class TOMWrapper:
             )
         except:
             print(
-                f"The '{measure_name}' measure does not exist in the '{self.dataset}' semantic model within the '{self.workspace}'."
+                f"{icons.red_dot} The '{measure_name}' measure does not exist in the '{self._dataset}' semantic model within the '{self._workspace}'."
             )
             return
 
@@ -2277,7 +2252,7 @@ class TOMWrapper:
 
         if status_graphic not in graphics:
             print(
-                f"The '{status_graphic}' status graphic is not valid. Please choose from these options: {graphics}."
+                f"{icons.red_dot} The '{status_graphic}' status graphic is not valid. Please choose from these options: {graphics}."
             )
             return
 
@@ -2296,7 +2271,7 @@ class TOMWrapper:
                 )
             except:
                 print(
-                    f"The '{target}' measure does not exist in the '{self.dataset}' semantic model within the '{self.workspace}'."
+                    f"{icons.red_dot} The '{target}' measure does not exist in the '{self._dataset}' semantic model within the '{self._workspace}'."
                 )
 
         if measure_target:
@@ -2328,7 +2303,7 @@ class TOMWrapper:
 
     def set_aggregations(self, table_name: str, agg_table_name: str):
         """
-        Sets the aggregations (alternate of) for all the columns in an aggregation table based on a base table.
+        Sets the `aggregations <https://learn.microsoft.com/power-bi/transform-model/aggregations-advanced>`_ (alternate of) for all the columns in an aggregation table based on a base table.
 
         Parameters
         ----------
@@ -2367,7 +2342,7 @@ class TOMWrapper:
         self, table_name: str, column_name: str, value: Optional[bool] = False
     ):
         """
-        Sets the IsAvailableInMdx property on a column.
+        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.
 
         Parameters
         ----------
@@ -2385,7 +2360,7 @@ class TOMWrapper:
         self, table_name: str, column_name: str, value: Optional[str] = None
     ):
         """
-        Sets the SummarizeBy property on a column.
+        Sets the `SummarizeBy <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.column.summarizeby?view=analysisservices-dotnet#microsoft-analysisservices-tabular-column-summarizeby>`_ property on a column.
 
         Parameters
         ----------
@@ -2422,7 +2397,7 @@ class TOMWrapper:
 
         if value not in values:
             print(
-                f"'{value}' is not a valid value for the SummarizeBy property. These are the valid values: {values}."
+                f"{icons.red_dot} '{value}' is not a valid value for the SummarizeBy property. These are the valid values: {values}."
             )
             return
 
@@ -2432,7 +2407,7 @@ class TOMWrapper:
 
     def set_direct_lake_behavior(self, direct_lake_behavior: str):
         """
-        Sets the Direct Lake Behavior property for a semantic model.
+        Sets the `Direct Lake Behavior <https://learn.microsoft.com/fabric/get-started/direct-lake-overview#fallback-behavior>`_ property for a semantic model.
 
         Parameters
         ----------
@@ -2454,7 +2429,7 @@ class TOMWrapper:
 
         if direct_lake_behavior not in dlValues:
             print(
-                f"The 'direct_lake_behavior' parameter must be one of these values: {dlValues}."
+                f"{icons.red_dot} The 'direct_lake_behavior' parameter must be one of these values: {dlValues}."
             )
             return
 
@@ -2539,7 +2514,7 @@ class TOMWrapper:
 
     def add_field_parameter(self, table_name: str, objects: List[str]):
         """
-        Adds a table to the semantic model.
+        Adds a `field parameter <https://learn.microsoft.com/power-bi/create-reports/power-bi-field-parameters>`_ to the semantic model.
 
         Parameters
         ----------
@@ -2551,12 +2526,14 @@ class TOMWrapper:
             Measures may be formatted as '[Measure Name]' or 'Measure Name'.
         """
 
+        import Microsoft.AnalysisServices.Tabular as TOM
+
         if isinstance(objects, str):
-            print(f"The 'objects' parameter must be a list of columns/measures.")
+            print(f"{icons.red_dot} The 'objects' parameter must be a list of columns/measures.")
             return
         if len(objects) == 1:
             print(
-                f"There must be more than one object (column/measure) within the objects parameter."
+                f"{icons.red_dot} There must be more than one object (column/measure) within the objects parameter."
             )
             return
 
@@ -2595,7 +2572,7 @@ class TOMWrapper:
                     success = True
             if not success:
                 print(
-                    f"The '{obj}' object was not found in the '{self.dataset}' semantic model."
+                    f"{icons.red_dot} The '{obj}' object was not found in the '{self._dataset}' semantic model."
                 )
                 return
             else:
@@ -2631,7 +2608,6 @@ class TOMWrapper:
         )
 
         self.set_extended_property(
-            self=self,
             object=self.model.Tables[table_name].Columns[col2],
             extended_property_type="Json",
             name="ParameterMetadata",
@@ -2649,11 +2625,11 @@ class TOMWrapper:
         ].Columns[col3]
         self.model.Tables[table_name].Columns[table_name].RelatedColumnDetails = rcd
 
-        self.tables_added.append(table_name)
+        self._tables_added.append(table_name)
 
     def remove_vertipaq_annotations(self):
         """
-        Removes the annotations set using the [set_vertipaq_annotations] function.
+        Removes the annotations set using the set_vertipaq_annotations function.
         """
 
         for t in self.model.Tables:
@@ -2683,10 +2659,10 @@ class TOMWrapper:
         """
 
         dfT = fabric.list_tables(
-            dataset=self.dataset, workspace=self.workspace, extended=True
+            dataset=self._dataset, workspace=self._workspace, extended=True
         )
         dfC = fabric.list_columns(
-            dataset=self.dataset, workspace=self.workspace, extended=True
+            dataset=self._dataset, workspace=self._workspace, extended=True
         )
         # intList = ['Total Size']#, 'Data Size', 'Dictionary Size', 'Hierarchy Size']
         dfCSum = dfC.groupby(["Table Name"])["Total Size"].sum().reset_index()
@@ -2698,16 +2674,16 @@ class TOMWrapper:
             how="inner",
         )
         dfP = fabric.list_partitions(
-            dataset=self.dataset, workspace=self.workspace, extended=True
+            dataset=self._dataset, workspace=self._workspace, extended=True
         )
         dfP["Records per Segment"] = round(
             dfP["Record Count"] / dfP["Segment Count"], 2
         )
         dfH = fabric.list_hierarchies(
-            dataset=self.dataset, workspace=self.workspace, extended=True
+            dataset=self._dataset, workspace=self._workspace, extended=True
         )
         dfR = list_relationships(
-            dataset=self.dataset, workspace=self.workspace, extended=True
+            dataset=self._dataset, workspace=self._workspace, extended=True
         )
 
         for t in self.model.Tables:
@@ -3100,7 +3076,7 @@ class TOMWrapper:
         import Microsoft.AnalysisServices.Tabular as TOM
 
         def create_pattern(a, b):
-            return r"(?<!" + a + "\[)(?<!" + a + "'\[)" + b
+            return r"(?<!" + re.escape(a) + r"\[)(?<!" + re.escape(a) + r"'\[)" + re.escape(b)
 
         for obj in self.depends_on(object=object, dependencies=dependencies):
             if obj.ObjectType == TOM.ObjectType.Column:
@@ -3128,7 +3104,7 @@ class TOMWrapper:
         usingView = False
 
         if self.is_direct_lake():
-            df = check_fallback_reason(dataset=self.dataset, workspace=self.workspace)
+            df = check_fallback_reason(dataset=self._dataset, workspace=self._workspace)
             df_filt = df[df["FallbackReasonID"] == 2]
 
             if len(df_filt) > 0:
@@ -3138,7 +3114,7 @@ class TOMWrapper:
 
     def has_incremental_refresh_policy(self, table_name: str):
         """
-        Identifies whether a table has an incremental refresh policy.
+        Identifies whether a table has an `incremental refresh <https://learn.microsoft.com/power-bi/connect-data/incremental-refresh-overview>`_ policy.
 
         Parameters
         ----------
@@ -3161,7 +3137,7 @@ class TOMWrapper:
 
     def show_incremental_refresh_policy(self, table_name: str):
         """
-        Prints the incremental refresh policy for a table.
+        Prints the `incremental refresh <https://learn.microsoft.com/power-bi/connect-data/incremental-refresh-overview>`_ policy for a table.
 
         Parameters
         ----------
@@ -3169,11 +3145,13 @@ class TOMWrapper:
             Name of the table.
         """
 
+        import Microsoft.AnalysisServices.Tabular as TOM
+
         rp = self.model.Tables[table_name].RefreshPolicy
 
         if rp is None:
             print(
-                f"The '{table_name}' table in the '{self.dataset}' semantic model within the '{self.workspace}' workspace does not have an incremental refresh policy."
+                f"{icons.yellow_dot} The '{table_name}' table in the '{self._dataset}' semantic model within the '{self._workspace}' workspace does not have an incremental refresh policy."
             )
         else:
             print(f"Table Name: {table_name}")
@@ -3181,33 +3159,33 @@ class TOMWrapper:
             icGran = str(rp.IncrementalGranularity).lower()
             if rp.RollingWindowPeriods > 1:
                 print(
-                    f"Archive data starting {start_bold}{rp.RollingWindowPeriods} {rwGran}s{end_bold} before refresh date."
+                    f"Archive data starting {icons.start_bold}{rp.RollingWindowPeriods} {rwGran}s{icons.end_bold} before refresh date."
                 )
             else:
                 print(
-                    f"Archive data starting {start_bold}{rp.RollingWindowPeriods} {rwGran}{end_bold} before refresh date."
+                    f"Archive data starting {icons.start_bold}{rp.RollingWindowPeriods} {rwGran}{icons.end_bold} before refresh date."
                 )
             if rp.IncrementalPeriods > 1:
                 print(
-                    f"Incrementally refresh data {start_bold}{rp.IncrementalPeriods} {icGran}s{end_bold} before refresh date."
+                    f"Incrementally refresh data {icons.start_bold}{rp.IncrementalPeriods} {icGran}s{icons.end_bold} before refresh date."
                 )
             else:
                 print(
-                    f"Incrementally refresh data {start_bold}{rp.IncrementalPeriods} {icGran}{end_bold} before refresh date."
+                    f"Incrementally refresh data {icons.start_bold}{rp.IncrementalPeriods} {icGran}{icons.end_bold} before refresh date."
                 )
 
             if rp.Mode == TOM.RefreshPolicyMode.Hybrid:
                 print(
-                    f"{checked} Get the latest data in real time with DirectQuery (Premium only)"
+                    f"{icons.checked} Get the latest data in real time with DirectQuery (Premium only)"
                 )
             else:
                 print(
-                    f"{unchecked} Get the latest data in real time with DirectQuery (Premium only)"
+                    f"{icons.unchecked} Get the latest data in real time with DirectQuery (Premium only)"
                 )
             if rp.IncrementalPeriodsOffset == -1:
-                print(f"{checked} Only refresh complete days")
+                print(f"{icons.checked} Only refresh complete days")
             else:
-                print(f"{unchecked} Only refresh complete days")
+                print(f"{icons.unchecked} Only refresh complete days")
             if len(rp.PollingExpression) > 0:
                 pattern = r"\[([^\]]+)\]"
                 match = re.search(pattern, rp.PollingExpression)
@@ -3215,10 +3193,10 @@ class TOMWrapper:
                     col = match[0][1:-1]
                     fullCol = format_dax_object_name(table_name, col)
                     print(
-                        f"{checked} Detect data changes: {start_bold}{fullCol}{end_bold}"
+                        f"{icons.checked} Detect data changes: {icons.start_bold}{fullCol}{icons.end_bold}"
                     )
             else:
-                print(f"{unchecked} Detect data changes")
+                print(f"{icons.unchecked} Detect data changes")
 
     def update_incremental_refresh_policy(
         self,
@@ -3231,7 +3209,7 @@ class TOMWrapper:
         detect_data_changes_column: Optional[str] = None,
     ):
         """
-        Updates the incremental refresh policy for a table within a semantic model.
+        Updates the `incremental refresh <https://learn.microsoft.com/power-bi/connect-data/incremental-refresh-overview>`_ policy for a table within a semantic model.
 
         Parameters
         ----------
@@ -3339,7 +3317,7 @@ class TOMWrapper:
         detect_data_changes_column: Optional[str] = None,
     ):
         """
-        Adds anincremental refresh policy for a table within a semantic model.
+        Adds an `incremental refresh <https://learn.microsoft.com/power-bi/connect-data/incremental-refresh-overview>`_ policy for a table within a semantic model.
 
         Parameters
         ----------
@@ -3514,7 +3492,7 @@ class TOMWrapper:
         max_parallelism: Optional[int] = 0,
     ):
         """
-        Applies the incremental refresh policy for a table within a semantic model.
+        `Applies the incremental refresh <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.table.applyrefreshpolicy?view=analysisservices-dotnet#microsoft-analysisservices-tabular-table-applyrefreshpolicy(system-boolean-system-int32)>`_ policy for a table within a semantic model.
 
         Parameters
         ----------
@@ -3538,7 +3516,7 @@ class TOMWrapper:
         self, table_name: str, partition_name: str, expression: str
     ):
         """
-        Sets the data coverage definition for a partition.
+        Sets the `data coverage definition <https://learn.microsoft.com/analysis-services/tom/table-partitions?view=asallproducts-allversions>`_ for a partition.
 
         Parameters
         ----------
@@ -3560,12 +3538,12 @@ class TOMWrapper:
 
         if not ht:
             print(
-                f"The data coverage definition property is only applicable to hybrid tables. See the documentation: {doc}."
+                f"{icons.red_dot} The `data coverage definition <https://learn.microsoft.com/analysis-services/tom/table-partitions?view=asallproducts-allversions>`_ property is only applicable to `hybrid tables <https://learn.microsoft.com/power-bi/connect-data/service-dataset-modes-understand#hybrid-tables>`_. See the documentation: {doc}."
             )
             return
         if p.Mode != TOM.ModeType.DirectQuery:
             print(
-                f"The data coverage definition property is only applicable to the DirectQuery partition of a hybrid table. See the documentation: {doc}."
+                f"{icons.red_dot} The `data coverage definition <https://learn.microsoft.com/analysis-services/tom/table-partitions?view=asallproducts-allversions>`_ property is only applicable to the DirectQuery partition of a `hybrid table <https://learn.microsoft.com/power-bi/connect-data/service-dataset-modes-understand#hybrid-tables>`_. See the documentation: {doc}."
             )
             return
 
@@ -3575,7 +3553,7 @@ class TOMWrapper:
 
     def set_encoding_hint(self, table_name: str, column_name: str, value: str):
         """
-        Sets the encoding hint for a column.
+        Sets the `encoding hint <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.encodinghinttype?view=analysisservices-dotnet>`_ for a column.
 
         Parameters
         ----------
@@ -3605,7 +3583,7 @@ class TOMWrapper:
 
     def set_data_type(self, table_name: str, column_name: str, value: str):
         """
-        Sets the data type for a column.
+        Sets the `data type <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.datatype?view=analysisservices-dotnet>`_ for a column.
 
         Parameters
         ----------
@@ -3617,6 +3595,7 @@ class TOMWrapper:
             The data type.
             `Data type valid values <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.datatype?view=analysisservices-dotnet>`_
         """
+        import Microsoft.AnalysisServices.Tabular as TOM
         import System
 
         values = [
@@ -3674,7 +3653,7 @@ class TOMWrapper:
             t = t.capitalize()
             if t not in [time_intel_options]:
                 print(
-                    f"The '{t}' time intelligence variation is not supported. Valid options: {time_intel_options}."
+                    f"{icons.red_dot} The '{t}' time intelligence variation is not supported. Valid options: {time_intel_options}."
                 )
                 return
 
@@ -3685,14 +3664,14 @@ class TOMWrapper:
 
         if table_name is None:
             print(
-                f"The '{measure_name}' is not a valid measure in the '{self.dataset}' semantic model within the '{self.workspace}' workspace."
+                f"{icons.red_dot} The '{measure_name}' is not a valid measure in the '{self._dataset}' semantic model within the '{self._workspace}' workspace."
             )
             return
 
         # Validate date table
         if not self.is_date_table(date_table):
             print(
-                f"{icons.red_dot} The '{date_table}' table is not a valid date table in the '{self.dataset}' wemantic model within the '{self.workspace}' workspace."
+                f"{icons.red_dot} The '{date_table}' table is not a valid date table in the '{self._dataset}' wemantic model within the '{self._workspace}' workspace."
             )
             return
 
@@ -3713,25 +3692,25 @@ class TOMWrapper:
                 )
 
     def close(self):
-        if not self.readonly and self.model is not None:
+        if not self._readonly and self.model is not None:
             self.model.SaveChanges()
 
-            if len(self.tables_added) > 0:
+            if len(self._tables_added) > 0:
                 refresh_semantic_model(
-                    dataset=self.dataset,
-                    tables=self.tables_added,
-                    workspace=self.workspace,
+                    dataset=self._dataset,
+                    tables=self._tables_added,
+                    workspace=self._workspace,
                 )
             self.model = None
 
-        self.tom_server.Dispose()
+        self._tom_server.Dispose()
 
 
 @log
 @contextmanager
 def connect_semantic_model(
     dataset: str, readonly: bool = True, workspace: Optional[str] = None
-):
+) -> Iterator[TOMWrapper]:
     """
     Connects to the Tabular Object Model (TOM) within a semantic model.
 
@@ -3748,7 +3727,7 @@ def connect_semantic_model(
 
     Returns
     -------
-    str
+    typing.Iterator[TOMWrapper]
         A connection to the semantic model's Tabular Object Model.
     """