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

sempy_labs/lakehouse/_get_lakehouse_columns.py

@@ -8,11 +8,12 @@ from sempy_labs._helper_functions import (
     resolve_lakehouse_id,
 )
 from typing import Optional
+from sempy._utils._log import log
 
-
+@log
 def get_lakehouse_columns(
     lakehouse: Optional[str] = None, workspace: Optional[str] = None
-):
+) -> pd.DataFrame:
     """
     Shows the tables and columns of a lakehouse and their respective properties.
 
@@ -47,7 +48,7 @@ def get_lakehouse_columns(
 
     workspace = fabric.resolve_workspace_name(workspace)
 
-    if lakehouse == None:
+    if lakehouse is None:
         lakehouse_id = fabric.get_lakehouse_id()
         lakehouse = resolve_lakehouse_name(lakehouse_id, workspace)
     else:

sempy_labs/lakehouse/_get_lakehouse_tables.py

@@ -1,3 +1,4 @@
+import sempy
 import sempy.fabric as fabric
 import pandas as pd
 from pyspark.sql import SparkSession
@@ -14,15 +15,17 @@ from sempy_labs.directlake._guardrails import (
 )
 from sempy_labs.lakehouse._lakehouse import lakehouse_attached
 from typing import Optional
+import sempy_labs._icons as icons
+from sempy._utils._log import log
 
-
+@log
 def get_lakehouse_tables(
     lakehouse: Optional[str] = None,
     workspace: Optional[str] = None,
     extended: Optional[bool] = False,
     count_rows: Optional[bool] = False,
     export: Optional[bool] = False,
-):
+) -> pd.DataFrame:
     """
     Shows the tables of a lakehouse and their respective properties. Option to include additional properties relevant to Direct Lake guardrails.
 
@@ -61,7 +64,7 @@ def get_lakehouse_tables(
 
     (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    if lakehouse == None:
+    if lakehouse is None:
         lakehouse_id = fabric.get_lakehouse_id()
         lakehouse = resolve_lakehouse_name(lakehouse_id, workspace)
     else:
@@ -80,7 +83,7 @@ def get_lakehouse_tables(
         tType = i["type"]
         tFormat = i["format"]
         tLocation = i["location"]
-        if extended == False:
+        if not extended:
             new_data = {
                 "Workspace Name": workspace,
                 "Lakehouse Name": lakehouse,
@@ -170,11 +173,9 @@ def get_lakehouse_tables(
 
     if export:
         lakeAttach = lakehouse_attached()
-        if lakeAttach == False:
-            print(
-                f"In order to save the report.json file, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook."
-            )
-            return
+        if lakeAttach is False:
+            raise ValueError(f"{icons.red_dot} In order to save the report.json file, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook.")
+            
         spark = SparkSession.builder.getOrCreate()
 
         lakehouse_id = fabric.get_lakehouse_id()
@@ -234,7 +235,7 @@ def get_lakehouse_tables(
                     export_df[c] = export_df[c].astype(bool)
 
         print(
-            f"Saving Lakehouse table properties to the '{lakeTName}' table in the lakehouse...\n"
+            f"{icons.in_progress} Saving Lakehouse table properties to the '{lakeTName}' table in the lakehouse...\n"
         )
         now = datetime.datetime.now()
         export_df["Timestamp"] = now
@@ -244,7 +245,7 @@ def get_lakehouse_tables(
         spark_df = spark.createDataFrame(export_df)
         spark_df.write.mode("append").format("delta").saveAsTable(lakeTName)
         print(
-            f"\u2022 Lakehouse table properties have been saved to the '{lakeTName}' delta table."
+            f"{icons.bullet} Lakehouse table properties have been saved to the '{lakeTName}' delta table."
         )
 
     return df

sempy_labs/lakehouse/_lakehouse.py

@@ -4,7 +4,8 @@ from tqdm.auto import tqdm
 from pyspark.sql import SparkSession
 from sempy_labs._helper_functions import resolve_lakehouse_name
 from typing import List, Optional, Union
-
+import sempy_labs._icons as icons
+from sempy._utils._log import log
 
 def lakehouse_attached() -> bool:
     """
@@ -24,7 +25,7 @@ def lakehouse_attached() -> bool:
     else:
         return False
 
-
+@log
 def optimize_lakehouse_tables(
     tables: Optional[Union[str, List[str]]] = None,
     lakehouse: Optional[str] = None,
@@ -49,11 +50,9 @@ def optimize_lakehouse_tables(
     from sempy_labs.lakehouse._get_lakehouse_tables import get_lakehouse_tables
     from delta import DeltaTable
 
-    if workspace == None:
-        workspace_id = fabric.get_workspace_id()
-        workspace = fabric.resolve_workspace_name(workspace_id)
+    workspace = fabric.resolve_workspace_name(workspace)
 
-    if lakehouse == None:
+    if lakehouse is None:
         lakehouse_id = fabric.get_lakehouse_id()
         lakehouse = resolve_lakehouse_name(lakehouse_id, workspace)
 
@@ -80,6 +79,6 @@ def optimize_lakehouse_tables(
         deltaTable = DeltaTable.forPath(spark, tablePath)
         deltaTable.optimize().executeCompaction()
         print(
-            f"The '{tableName}' table has been optimized. ({str(i)}/{str(tableCount)})"
+            f"{icons.green_dot} The '{tableName}' table has been optimized. ({str(i)}/{str(tableCount)})"
         )
         i += 1

sempy_labs/lakehouse/_shortcuts.py

@@ -1,12 +1,11 @@
 import sempy
 import sempy.fabric as fabric
-import pandas as pd
 from sempy_labs._helper_functions import (
     resolve_lakehouse_name,
     resolve_lakehouse_id,
     resolve_workspace_name_and_id,
 )
-from typing import List, Optional, Union
+from typing import Optional
 import sempy_labs._icons as icons
 
 
@@ -42,7 +41,7 @@ def create_shortcut_onelake(
     sourceWorkspaceId = fabric.resolve_workspace_id(source_workspace)
     sourceLakehouseId = resolve_lakehouse_id(source_lakehouse, source_workspace)
 
-    if destination_workspace == None:
+    if destination_workspace is None:
         destination_workspace = source_workspace
 
     destinationWorkspaceId = fabric.resolve_workspace_id(destination_workspace)
@@ -50,7 +49,7 @@ def create_shortcut_onelake(
         destination_lakehouse, destination_workspace
     )
 
-    if shortcut_name == None:
+    if shortcut_name is None:
         shortcut_name = table_name
 
     client = fabric.FabricRestClient()
@@ -80,9 +79,7 @@ def create_shortcut_onelake(
         else:
             print(response.status_code)
     except Exception as e:
-        print(
-            f"{icons.red_dot} Failed to create a shortcut for the '{table_name}' table: {e}"
-        )
+        raise ValueError(f"{icons.red_dot} Failed to create a shortcut for the '{table_name}' table.") from e
 
 
 def create_shortcut(
@@ -117,16 +114,13 @@ def create_shortcut(
     sourceValues = list(source_titles.keys())
 
     if source not in sourceValues:
-        print(
-            f"{icons.red_dot} The 'source' parameter must be one of these values: {sourceValues}."
-        )
-        return
+        raise ValueError(f"{icons.red_dot} The 'source' parameter must be one of these values: {sourceValues}.")
 
     sourceTitle = source_titles[source]
 
     (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    if lakehouse == None:
+    if lakehouse is None:
         lakehouse_id = fabric.get_lakehouse_id()
     else:
         lakehouse_id = resolve_lakehouse_id(lakehouse, workspace)
@@ -157,103 +151,8 @@ def create_shortcut(
             )
         else:
             print(response.status_code)
-    except:
-        print(
-            f"{icons.red_dot} Failed to create a shortcut for the '{shortcut_name}' table."
-        )
-
-
-def list_shortcuts(
-    lakehouse: Optional[str] = None, workspace: Optional[str] = None
-) -> pd.DataFrame:
-    """
-    Shows all shortcuts which exist in a Fabric lakehouse.
-
-    Parameters
-    ----------
-    lakehouse : str, default=None
-        The Fabric lakehouse name.
-        Defaults to None which resolves to the lakehouse attached to the notebook.
-    workspace : str, default=None
-        The name of the Fabric workspace in which lakehouse resides.
-        Defaults to None which resolves to the workspace of the attached lakehouse
-        or if no lakehouse attached, resolves to the workspace of the notebook.
-
-    Returns
-    -------
-    pandas.DataFrame
-        A pandas dataframe showing all the shortcuts which exist in the specified lakehouse.
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    if lakehouse == None:
-        lakehouse_id = fabric.get_lakehouse_id()
-        lakehouse = resolve_lakehouse_name(lakehouse_id, workspace)
-    else:
-        lakehouse_id = resolve_lakehouse_id(lakehouse, workspace)
-
-    df = pd.DataFrame(
-        columns=[
-            "Shortcut Name",
-            "Shortcut Path",
-            "Source",
-            "Source Lakehouse Name",
-            "Source Workspace Name",
-            "Source Path",
-            "Source Connection ID",
-            "Source Location",
-            "Source SubPath",
-        ]
-    )
-
-    client = fabric.FabricRestClient()
-    response = client.get(
-        f"/v1/workspaces/{workspace_id}/items/{lakehouse_id}/shortcuts"
-    )
-    if response.status_code == 200:
-        for s in response.json()["value"]:
-            shortcutName = s["name"]
-            shortcutPath = s["path"]
-            source = list(s["target"].keys())[0]
-            (
-                sourceLakehouseName,
-                sourceWorkspaceName,
-                sourcePath,
-                connectionId,
-                location,
-                subpath,
-            ) = (None, None, None, None, None, None)
-            if source == "oneLake":
-                sourceLakehouseId = s["target"][source]["itemId"]
-                sourcePath = s["target"][source]["path"]
-                sourceWorkspaceId = s["target"][source]["workspaceId"]
-                sourceWorkspaceName = fabric.resolve_workspace_name(sourceWorkspaceId)
-                sourceLakehouseName = resolve_lakehouse_name(
-                    sourceLakehouseId, sourceWorkspaceName
-                )
-            else:
-                connectionId = s["target"][source]["connectionId"]
-                location = s["target"][source]["location"]
-                subpath = s["target"][source]["subpath"]
-
-            new_data = {
-                "Shortcut Name": shortcutName,
-                "Shortcut Path": shortcutPath,
-                "Source": source,
-                "Source Lakehouse Name": sourceLakehouseName,
-                "Source Workspace Name": sourceWorkspaceName,
-                "Source Path": sourcePath,
-                "Source Connection ID": connectionId,
-                "Source Location": location,
-                "Source SubPath": subpath,
-            }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    print(
-        f"This function relies on an API which is not yet official as of May 21, 2024. Once the API becomes official this function will work as expected."
-    )
-    return df
+    except Exception as e:
+        raise ValueError(f"{icons.red_dot} Failed to create a shortcut for the '{shortcut_name}' table.") from e
 
 
 def delete_shortcut(
@@ -277,7 +176,7 @@ def delete_shortcut(
 
     (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    if lakehouse == None:
+    if lakehouse is None:
         lakehouse_id = fabric.get_lakehouse_id()
         lakehouse = resolve_lakehouse_name(lakehouse_id, workspace)
     else:
@@ -293,4 +192,4 @@ def delete_shortcut(
             f"{icons.green_dot} The '{shortcut_name}' shortcut in the '{lakehouse}' within the '{workspace}' workspace has been deleted."
         )
     else:
-        print(f"{icons.red_dot} The '{shortcut_name}' has not been deleted.")
+        raise ValueError(f"{icons.red_dot} The '{shortcut_name}' has not been deleted.")

sempy_labs/migration/__init__.py

@@ -14,7 +14,9 @@ from sempy_labs.migration._migrate_tables_columns_to_semantic_model import (
 )
 from sempy_labs.migration._migration_validation import (
     migration_validation,
-    # list_semantic_model_objects
+)
+from sempy_labs.migration._refresh_calc_tables import (
+    refresh_calc_tables,
 )
 
 __all__ = [
@@ -25,5 +27,5 @@ __all__ = [
     "migrate_model_objects_to_semantic_model",
     "migrate_tables_columns_to_semantic_model",
     "migration_validation",
-    # list_semantic_model_objects
+    "refresh_calc_tables"
 ]

sempy_labs/migration/_create_pqt_file.py

@@ -11,7 +11,7 @@ import sempy_labs._icons as icons
 
 @log
 def create_pqt_file(
-    dataset: str, workspace: Optional[str] = None, file_name: Optional[str] = None
+    dataset: str, workspace: Optional[str] = None, file_name: Optional[str] = 'PowerQueryTemplate'
 ):
     """
     Dynamically generates a `Power Query Template <https://learn.microsoft.com/power-query/power-query-template>`_ file based on the semantic model. The .pqt file is saved within the Files section of your lakehouse.
@@ -24,25 +24,16 @@ def create_pqt_file(
         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.
-    file_name : str, default=None
+    file_name : str, default='PowerQueryTemplate'
         The name of the Power Query Template file to be generated.
-        Defaults to None which resolves to 'PowerQueryTemplate'.
     """
 
-    if file_name is None:
-        file_name = "PowerQueryTemplate"
-
     lakeAttach = lakehouse_attached()
 
-    if lakeAttach == False:
-        print(
-            f"{icons.red_dot} In order to run the 'create_pqt_file' function, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook."
-        )
-        return
+    if lakeAttach is False:
+        raise ValueError(f"{icons.red_dot} In order to run the 'create_pqt_file' function, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook.")
 
-    if workspace == None:
-        workspace_id = fabric.get_workspace_id()
-        workspace = fabric.resolve_workspace_name(workspace_id)
+    workspace = fabric.resolve_workspace_name(workspace)
 
     folderPath = "/lakehouse/default/Files"
     subFolderPath = os.path.join(folderPath, "pqtnewfolder")

sempy_labs/migration/_migrate_calctables_to_lakehouse.py

@@ -8,7 +8,7 @@ from sempy_labs._helper_functions import (
     resolve_lakehouse_id,
     create_abfss_path,
 )
-from sempy_labs._tom import connect_semantic_model
+from sempy_labs.tom import connect_semantic_model
 from pyspark.sql import SparkSession
 from typing import List, Optional, Union
 from sempy._utils._log import log
@@ -52,16 +52,16 @@ def migrate_calc_tables_to_lakehouse(
 
     workspace = fabric.resolve_workspace_name(workspace)
 
-    if new_dataset_workspace == None:
+    if new_dataset_workspace is None:
         new_dataset_workspace = workspace
 
-    if lakehouse_workspace == None:
+    if lakehouse_workspace is None:
         lakehouse_workspace = new_dataset_workspace
         lakehouse_workspace_id = fabric.resolve_workspace_id(lakehouse_workspace)
     else:
         lakehouse_workspace_id = fabric.resolve_workspace_id(lakehouse_workspace)
 
-    if lakehouse == None:
+    if lakehouse is None:
         lakehouse_id = fabric.get_lakehouse_id()
         lakehouse = resolve_lakehouse_name(lakehouse_id, lakehouse_workspace)
     else:
@@ -288,16 +288,16 @@ def migrate_field_parameters(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    from .HelperFunctions import format_dax_object_name
+    from sempy_labs import format_dax_object_name
 
     sempy.fabric._client._utils._init_analysis_services()
     import Microsoft.AnalysisServices.Tabular as TOM
 
-    if workspace == None:
+    if workspace is None:
         workspace_id = fabric.get_workspace_id()
         workspace = fabric.resolve_workspace_name(workspace_id)
 
-    if new_dataset_workspace == None:
+    if new_dataset_workspace is None:
         new_dataset_workspace = workspace
 
     dfC = fabric.list_columns(dataset=dataset, workspace=workspace)

sempy_labs/migration/_migrate_calctables_to_semantic_model.py

@@ -3,7 +3,7 @@ import sempy.fabric as fabric
 import re, datetime, time
 from sempy_labs.lakehouse._get_lakehouse_tables import get_lakehouse_tables
 from sempy_labs._helper_functions import resolve_lakehouse_name
-from sempy_labs._tom import connect_semantic_model
+from sempy_labs.tom import connect_semantic_model
 from typing import Optional
 from sempy._utils._log import log
 import sempy_labs._icons as icons
@@ -46,12 +46,12 @@ def migrate_calc_tables_to_semantic_model(
 
     workspace = fabric.resolve_workspace_name(workspace)
 
-    if new_dataset_workspace == None:
+    if new_dataset_workspace is None:
         new_dataset_workspace = workspace
 
-    if lakehouse_workspace == None:
+    if lakehouse_workspace is None:
         lakehouse_workspace = new_dataset_workspace
-    if lakehouse == None:
+    if lakehouse is None:
         lakehouse_id = fabric.get_lakehouse_id()
         lakehouse = resolve_lakehouse_name(lakehouse_id, lakehouse_workspace)
 

sempy_labs/migration/_migrate_model_objects_to_semantic_model.py

@@ -3,12 +3,11 @@ import sempy.fabric as fabric
 import re, datetime, time
 from sempy_labs._list_functions import list_tables
 from sempy_labs._helper_functions import create_relationship_name
-from sempy_labs._tom import connect_semantic_model
+from sempy_labs.tom import connect_semantic_model
 from typing import Optional
 from sempy._utils._log import log
 import sempy_labs._icons as icons
 
-
 @log
 def migrate_model_objects_to_semantic_model(
     dataset: str,
@@ -39,13 +38,9 @@ def migrate_model_objects_to_semantic_model(
     import Microsoft.AnalysisServices.Tabular as TOM
     import System
 
-    if workspace == None:
-        workspace_id = fabric.get_workspace_id()
-        workspace = fabric.resolve_workspace_name(workspace_id)
-    else:
-        workspaceId = fabric.resolve_workspace_id(workspace)
+    workspace = fabric.resolve_workspace_name(workspace)
 
-    if new_dataset_workspace == None:
+    if new_dataset_workspace is None:
         new_dataset_workspace = workspace
 
     dfT = list_tables(dataset, workspace)

sempy_labs/migration/_migrate_tables_columns_to_semantic_model.py

@@ -6,7 +6,7 @@ from sempy_labs._list_functions import list_tables
 from sempy_labs.directlake._get_shared_expression import get_shared_expression
 from sempy_labs._helper_functions import resolve_lakehouse_name
 from sempy_labs.lakehouse._lakehouse import lakehouse_attached
-from sempy_labs._tom import connect_semantic_model
+from sempy_labs.tom import connect_semantic_model
 from typing import List, Optional, Union
 from sempy._utils._log import log
 import sempy_labs._icons as icons
@@ -50,13 +50,13 @@ def migrate_tables_columns_to_semantic_model(
 
     workspace = fabric.resolve_workspace_name(workspace)
 
-    if new_dataset_workspace == None:
+    if new_dataset_workspace is None:
         new_dataset_workspace = workspace
 
-    if lakehouse_workspace == None:
+    if lakehouse_workspace is None:
         lakehouse_workspace = new_dataset_workspace
 
-    if lakehouse == None:
+    if lakehouse is None:
         lakehouse_id = fabric.get_lakehouse_id()
         lakehouse = resolve_lakehouse_name(lakehouse_id, lakehouse_workspace)
 
@@ -158,8 +158,8 @@ def migrate_tables_columns_to_semantic_model(
             f"{icons.red_dot} Lakehouse not attached to notebook and lakehouse/lakehouse_workspace are not specified. Please add your lakehouse to this notebook or specify the lakehouse/lakehouse_workspace parameters."
         )
         print(
-            f"To attach a lakehouse to a notebook, go to the the 'Explorer' window to the left, click 'Lakehouses' to add your lakehouse to this notebook"
+            "To attach a lakehouse to a notebook, go to the the 'Explorer' window to the left, click 'Lakehouses' to add your lakehouse to this notebook"
         )
         print(
-            f"\nLearn more here: https://learn.microsoft.com/fabric/data-engineering/lakehouse-notebook-explore#add-or-remove-a-lakehouse"
+            "\nLearn more here: https://learn.microsoft.com/fabric/data-engineering/lakehouse-notebook-explore#add-or-remove-a-lakehouse"
         )