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

sempy_labs/_generate_semantic_model.py

@@ -1,14 +1,17 @@
-import sempy
 import sempy.fabric as fabric
 import pandas as pd
-import json, base64, time, os
-from typing import List, Optional, Union
+import json
+import base64
+import time
+import os
+from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_lakehouse_name,
     resolve_workspace_name_and_id,
 )
 from sempy_labs.lakehouse._lakehouse import lakehouse_attached
 import sempy_labs._icons as icons
+from sempy.fabric.exceptions import FabricHTTPException
 
 
 def create_blank_semantic_model(
@@ -32,12 +35,14 @@ def create_blank_semantic_model(
     """
 
     if workspace is None:
-        workspace_id = fabric.get_workspace_id()
-        workspace = fabric.resolve_workspace_name(workspace_id)
+        workspace = fabric.resolve_workspace_name()
 
-    if compatibility_level < 1500:
-        print(f"{icons.red_dot} Compatiblity level must be at least 1500.")
-        return
+    min_compat = 1500
+
+    if compatibility_level < min_compat:
+        raise ValueError(
+            f"{icons.red_dot} Compatiblity level must be at least {min_compat}."
+        )
 
     tmsl = f"""
   {{
@@ -90,10 +95,9 @@ def create_semantic_model_from_bim(
     dfI_filt = dfI[(dfI["Display Name"] == dataset)]
 
     if len(dfI_filt) > 0:
-        print(
-            f"WARNING: '{dataset}' already exists as a semantic model in the '{workspace}' workspace."
+        raise ValueError(
+            f"{icons.red_dot} '{dataset}' already exists as a semantic model in the '{workspace}' workspace."
         )
-        return
 
     client = fabric.FabricRestClient()
     defPBIDataset = {"version": "1.0", "settings": {}}
@@ -131,7 +135,7 @@ def create_semantic_model_from_bim(
 
     if response.status_code == 201:
         print(
-            f"The '{dataset}' semantic model has been created within the '{workspace}' workspace."
+            f"{icons.green_dot} The '{dataset}' semantic model has been created within the '{workspace}' workspace."
         )
         print(response.json())
     elif response.status_code == 202:
@@ -144,67 +148,75 @@ def create_semantic_model_from_bim(
             response_body = json.loads(response.content)
         response = client.get(f"/v1/operations/{operationId}/result")
         print(
-            f"The '{dataset}' semantic model has been created within the '{workspace}' workspace."
+            f"{icons.green_dot} The '{dataset}' semantic model has been created within the '{workspace}' workspace."
         )
         print(response.json())
 
 
 def deploy_semantic_model(
-    dataset: str,
-    new_dataset: Optional[str] = None,
-    workspace: Optional[str] = None,
-    new_dataset_workspace: Optional[str] = None,
+    source_dataset: str,
+    source_workspace: Optional[str] = None,
+    target_dataset: Optional[str] = None,
+    target_workspace: Optional[str] = None,
+    refresh_target_dataset: Optional[bool] = True,
 ):
     """
     Deploys a semantic model based on an existing semantic model.
 
     Parameters
     ----------
-    dataset : str
+    source_dataset : str
         Name of the semantic model to deploy.
-    new_dataset: str
-        Name of the new semantic model to be created.
-    workspace : str, default=None
+    source_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.
-    new_dataset_workspace : str, default=None
+    target_dataset: str
+        Name of the new semantic model to be created.
+    target_workspace : str, default=None
         The Fabric workspace name in which the new semantic model will be deployed.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
+    refresh_target_dataset : bool, default=True
+        If set to True, this will initiate a full refresh of the target semantic model in the target workspace.
 
     Returns
     -------
 
     """
 
-    if workspace is None:
-        workspace_id = fabric.get_workspace_id()
-        workspace = fabric.resolve_workspace_name(workspace_id)
+    from sempy_labs import refresh_semantic_model
+
+    source_workspace = fabric.resolve_workspace_name(source_workspace)
 
-    if new_dataset_workspace is None:
-        new_dataset_workspace = workspace
+    if target_workspace is None:
+        target_workspace = source_workspace
 
-    if new_dataset is None:
-        new_dataset = dataset
+    if target_dataset is None:
+        target_dataset = source_dataset
 
-    if new_dataset == dataset and new_dataset_workspace == workspace:
+    if target_dataset == source_dataset and target_workspace == source_workspace:
         print(
-            f"The 'dataset' and 'new_dataset' parameters have the same value. And, the 'workspace' and 'new_dataset_workspace' parameters have the same value. At least one of these must be different. Please update the parameters."
+            f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters have the same value. And, the 'workspace' and 'new_dataset_workspace' "
+            f"parameters have the same value. At least one of these must be different. Please update the parameters."
         )
         return
 
-    bim = get_semantic_model_bim(dataset=dataset, workspace=workspace)
+    bim = get_semantic_model_bim(dataset=source_dataset, workspace=source_workspace)
 
     create_semantic_model_from_bim(
-        dataset=new_dataset, bim_file=bim, workspace=new_dataset_workspace
+        dataset=target_dataset, bim_file=bim, workspace=target_workspace
     )
 
+    if refresh_target_dataset:
+        refresh_semantic_model(dataset=target_dataset, workspace=target_workspace)
+
 
 def get_semantic_model_bim(
     dataset: str,
     workspace: Optional[str] = None,
     save_to_file_name: Optional[str] = None,
+    lakehouse_workspace: Optional[str] = None,
 ):
     """
     Extracts the Model.bim file for a given semantic model.
@@ -214,11 +226,15 @@ def get_semantic_model_bim(
     dataset : str
         Name of the semantic model.
     workspace : str, default=None
-        The Fabric workspace name.
+        The Fabric workspace name in which the semantic model 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.
     save_to_file_name : str, default=None
         If specified, saves the Model.bim as a file in the lakehouse attached to the notebook.
+    lakehouse_workspace : str, default=None
+        The Fabric workspace name in which the lakehouse attached to the workspace 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
     -------
@@ -227,29 +243,20 @@ def get_semantic_model_bim(
     """
 
     (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    if lakehouse_workspace is None:
+        lakehouse_workspace = workspace
 
-    objType = "SemanticModel"
+    fmt = "TMSL"
     client = fabric.FabricRestClient()
-    itemList = fabric.list_items(workspace=workspace, type=objType)
+    itemList = fabric.list_items(workspace=workspace, type="SemanticModel")
     itemListFilt = itemList[(itemList["Display Name"] == dataset)]
     itemId = itemListFilt["Id"].iloc[0]
     response = client.post(
-        f"/v1/workspaces/{workspace_id}/items/{itemId}/getDefinition"
+        f"/v1/workspaces/{workspace_id}/items/{itemId}/getDefinition?format={fmt}",
+        lro_wait=True,
     )
 
-    if response.status_code == 200:
-        res = response.json()
-    elif response.status_code == 202:
-        operationId = response.headers["x-ms-operation-id"]
-        response = client.get(f"/v1/operations/{operationId}")
-        response_body = json.loads(response.content)
-        while response_body["status"] != "Succeeded":
-            time.sleep(3)
-            response = client.get(f"/v1/operations/{operationId}")
-            response_body = json.loads(response.content)
-        response = client.get(f"/v1/operations/{operationId}/result")
-        res = response.json()
-    df_items = pd.json_normalize(res["definition"]["parts"])
+    df_items = pd.json_normalize(response.json()["definition"]["parts"])
     df_items_filt = df_items[df_items["path"] == "model.bim"]
     payload = df_items_filt["payload"].iloc[0]
     bimFile = base64.b64decode(payload).decode("utf-8")
@@ -258,13 +265,12 @@ def get_semantic_model_bim(
     if save_to_file_name is not None:
         lakeAttach = lakehouse_attached()
         if lakeAttach is False:
-            print(
-                f"In order to save the model.bim file, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook."
+            raise ValueError(
+                f"{icons.red_dot} In order to save the model.bim file, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook."
             )
-            return
 
         lakehouse_id = fabric.get_lakehouse_id()
-        lakehouse = resolve_lakehouse_name(lakehouse_id, workspace)
+        lakehouse = resolve_lakehouse_name(lakehouse_id, lakehouse_workspace)
         folderPath = "/lakehouse/default/Files"
         fileExt = ".bim"
         if not save_to_file_name.endswith(fileExt):

sempy_labs/_helper_functions.py

@@ -1,4 +1,3 @@
-import sempy
 import sempy.fabric as fabric
 import re
 import pandas as pd
@@ -200,7 +199,9 @@ def resolve_dataset_name(dataset_id: UUID, workspace: Optional[str] = None):
     return obj
 
 
-def resolve_lakehouse_name(lakehouse_id: Optional[UUID] = None, workspace: Optional[str] = None):
+def resolve_lakehouse_name(
+    lakehouse_id: Optional[UUID] = None, workspace: Optional[str] = None
+):
     """
     Obtains the name of the Fabric lakehouse.
 
@@ -223,7 +224,7 @@ def resolve_lakehouse_name(lakehouse_id: Optional[UUID] = None, workspace: Optio
     if workspace is None:
         workspace_id = fabric.get_workspace_id()
         workspace = fabric.resolve_workspace_name(workspace_id)
-    
+
     if lakehouse_id is None:
         lakehouse_id = fabric.get_lakehouse_id()
 
@@ -420,16 +421,14 @@ def save_as_delta_table(
     write_mode = write_mode.lower()
 
     if write_mode not in writeModes:
-        print(
+        raise ValueError(
             f"{icons.red_dot} Invalid 'write_type' parameter. Choose from one of the following values: {writeModes}."
         )
-        return
 
     if " " in delta_table_name:
-        print(
+        raise ValueError(
             f"{icons.red_dot} Invalid 'delta_table_name'. Delta tables in the lakehouse cannot have spaces in their names."
         )
-        return
 
     dataframe.columns = dataframe.columns.str.replace(" ", "_")
 
@@ -476,10 +475,9 @@ def language_validate(language: str):
     elif len(df_filt2) == 1:
         lang = df_filt2["Language"].iloc[0]
     else:
-        print(
-            f"The '{language}' language is not a valid language code. Please refer to this link for a list of valid language codes: {url}."
+        raise ValueError(
+            f"{icons.red_dot} The '{language}' language is not a valid language code. Please refer to this link for a list of valid language codes: {url}."
         )
-        return
 
     return lang
 

sempy_labs/_icons.py

@@ -7,3 +7,18 @@ unchecked = "\u2610"
 start_bold = "\033[1m"
 end_bold = "\033[0m"
 bullet = "\u2022"
+warning = "⚠️"
+data_type_mapping = {
+    "string": "String",
+    "bigint": "Int64",
+    "int": "Int64",
+    "smallint": "Int64",
+    "boolean": "Boolean",
+    "timestamp": "DateTime",
+    "date": "DateTime",
+    "decimal(38,18)": "Decimal",
+    "double": "Double",
+}
+measure_icon = "\u2211"
+table_icon = "\u229E"
+column_icon = "\u229F"