semantic-link-labs 0.9.5__py3-none-any.whl → 0.9.7__py3-none-any.whl

sempy_labs/_icons.py

@@ -1,6 +1,6 @@
-green_dot = "\U0001F7E2"
-yellow_dot = "\U0001F7E1"
-red_dot = "\U0001F534"
+green_dot = "\U0001f7e2"
+yellow_dot = "\U0001f7e1"
+red_dot = "\U0001f534"
 in_progress = "⌛"
 checked = "\u2611"
 unchecked = "\u2610"
@@ -8,11 +8,11 @@ start_bold = "\033[1m"
 end_bold = "\033[0m"
 bullet = "\u2022"
 warning = "⚠️"
-error = "\u274C"
+error = "\u274c"
 info = "ℹ️"
 measure_icon = "\u2211"
-table_icon = "\u229E"
-column_icon = "\u229F"
+table_icon = "\u229e"
+column_icon = "\u229f"
 model_bpa_name = "ModelBPA"
 report_bpa_name = "ReportBPA"
 severity_mapping = {warning: "Warning", error: "Error", info: "Info"}

sempy_labs/_kql_databases.py

@@ -17,6 +17,8 @@ def list_kql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List KQL Databases <https://learn.microsoft.com/rest/api/fabric/kqldatabase/items/list-kql-databases>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     workspace : str | uuid.UUID, default=None
@@ -44,7 +46,9 @@ def list_kql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     responses = _base_api(
-        request=f"v1/workspaces/{workspace_id}/kqlDatabases", uses_pagination=True
+        request=f"v1/workspaces/{workspace_id}/kqlDatabases",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:

sempy_labs/_list_functions.py

@@ -605,6 +605,8 @@ def list_lakehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     Shows the lakehouses within a workspace.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     workspace : str | uuid.UUID, default=None
@@ -633,7 +635,9 @@ def list_lakehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/lakehouses", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/lakehouses",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -1172,42 +1176,6 @@ def list_shortcuts(
     return list_shortcuts(lakehouse=lakehouse, workspace=workspace, path=path)
 
 
-def list_capacities() -> pd.DataFrame:
-    """
-    Shows the capacities and their properties.
-
-    Returns
-    -------
-    pandas.DataFrame
-        A pandas dataframe showing the capacities and their properties
-    """
-
-    columns = {
-        "Id": "string",
-        "Display Name": "string",
-        "Sku": "string",
-        "Region": "string",
-        "State": "string",
-        "Admins": "string",
-    }
-    df = _create_dataframe(columns=columns)
-
-    response = _base_api(request="/v1.0/myorg/capacities")
-
-    for i in response.json().get("value", []):
-        new_data = {
-            "Id": i.get("id").lower(),
-            "Display Name": i.get("displayName"),
-            "Sku": i.get("sku"),
-            "Region": i.get("region"),
-            "State": i.get("state"),
-            "Admins": [i.get("admins", [])],
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    return df
-
-
 def list_reports_using_semantic_model(
     dataset: str | UUID, workspace: Optional[str | UUID] = None
 ) -> pd.DataFrame:
@@ -1508,7 +1476,9 @@ def list_server_properties(workspace: Optional[str | UUID] = None) -> pd.DataFra
         A pandas dataframe showing a list of the server properties.
     """
 
-    tom_server = fabric.create_tom_server(readonly=True, workspace=workspace)
+    tom_server = fabric.create_tom_server(
+        dataset=None, readonly=True, workspace=workspace
+    )
 
     rows = [
         {

sempy_labs/_managed_private_endpoints.py

@@ -23,6 +23,8 @@ def create_managed_private_endpoint(
 
     This is a wrapper function for the following API: `Managed Private Endpoints - Create Workspace Managed Private Endpoint <https://learn.microsoft.com/rest/api/fabric/core/managed-private-endpoints/create-workspace-managed-private-endpoint>`.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     name: str
@@ -60,6 +62,7 @@ def create_managed_private_endpoint(
         status_codes=[201, 202],
         payload=request_body,
         lro_return_status_code=True,
+        client="fabric_sp",
     )
     _print_success(
         item_name=name,
@@ -77,6 +80,8 @@ def list_managed_private_endpoints(
 
     This is a wrapper function for the following API: `Managed Private Endpoints - List Workspace Managed Private Endpoints <https://learn.microsoft.com/rest/api/fabric/core/managed-private-endpoints/list-workspace-managed-private-endpoints>`.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     workspace : str | uuid.UUID, default=None
@@ -106,7 +111,7 @@ def list_managed_private_endpoints(
     responses = _base_api(
         request=f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints",
         uses_pagination=True,
-        status_codes=200,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -134,6 +139,8 @@ def delete_managed_private_endpoint(
 
     This is a wrapper function for the following API: `Managed Private Endpoints - Delete Workspace Managed Private Endpoint <https://learn.microsoft.com/rest/api/fabric/core/managed-private-endpoints/delete-workspace-managed-private-endpoint>`.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     managed_private_endpoint: str | uuid.UUID
@@ -162,7 +169,7 @@ def delete_managed_private_endpoint(
     _base_api(
         request=f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints/{item_id}",
         method="delete",
-        status_codes=200,
+        client="fabric_sp",
     )
 
     _print_success(

sempy_labs/_mirrored_databases.py

@@ -22,6 +22,8 @@ def list_mirrored_databases(workspace: Optional[str | UUID] = None) -> pd.DataFr
 
     This is a wrapper function for the following API: `Items - List Mirrored Databases <https://learn.microsoft.com/rest/api/fabric/mirroredwarehouse/items/list-mirrored-databases>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     workspace : str | uuid.UUID, default=None
@@ -50,8 +52,8 @@ def list_mirrored_databases(workspace: Optional[str | UUID] = None) -> pd.DataFr
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     responses = _base_api(
         request=f"/v1/workspaces/{workspace_id}/mirroredDatabases",
-        status_codes=200,
         uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:

sempy_labs/_ml_experiments.py

@@ -73,7 +73,7 @@ def create_ml_experiment(
     name: str
         Name of the ML experiment.
     description : str, default=None
-        A description of the environment.
+        A description of the ML experiment.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID.
         Defaults to None which resolves to the workspace of the attached lakehouse

sempy_labs/_model_bpa.py

@@ -6,7 +6,6 @@ from IPython.display import display, HTML
 from sempy_labs._model_dependencies import get_model_calc_dependencies
 from sempy_labs._helper_functions import (
     format_dax_object_name,
-    resolve_lakehouse_name,
     create_relationship_name,
     save_as_delta_table,
     resolve_workspace_capacity,
@@ -389,13 +388,7 @@ def run_model_bpa(
         dfExport = finalDF.copy()
         delta_table_name = "modelbparesults"
 
-        lakehouse_id = fabric.get_lakehouse_id()
-        lake_workspace = fabric.get_workspace_id()
-        lakehouse = resolve_lakehouse_name(
-            lakehouse_id=lakehouse_id, workspace=lake_workspace
-        )
-
-        lakeT = get_lakehouse_tables(lakehouse=lakehouse, workspace=lake_workspace)
+        lakeT = get_lakehouse_tables()
         lakeT_filt = lakeT[lakeT["Table Name"] == delta_table_name]
 
         dfExport["Severity"].replace(icons.severity_mapping, inplace=True)
@@ -403,9 +396,7 @@ def run_model_bpa(
         if len(lakeT_filt) == 0:
             runId = 1
         else:
-            max_run_id = _get_column_aggregate(
-                lakehouse=lakehouse, table_name=delta_table_name
-            )
+            max_run_id = _get_column_aggregate(table_name=delta_table_name)
             runId = max_run_id + 1
 
         now = datetime.datetime.now()

sempy_labs/_model_bpa_bulk.py

@@ -2,11 +2,12 @@ import sempy.fabric as fabric
 import pandas as pd
 import datetime
 from sempy_labs._helper_functions import (
-    resolve_lakehouse_name,
     save_as_delta_table,
     resolve_workspace_capacity,
     retry,
     _get_column_aggregate,
+    resolve_workspace_id,
+    resolve_lakehouse_name_and_id,
 )
 from sempy_labs.lakehouse import (
     get_lakehouse_tables,
@@ -16,6 +17,7 @@ from sempy_labs._model_bpa import run_model_bpa
 from typing import Optional, List
 from sempy._utils._log import log
 import sempy_labs._icons as icons
+from uuid import UUID
 
 
 @log
@@ -23,7 +25,7 @@ def run_model_bpa_bulk(
     rules: Optional[pd.DataFrame] = None,
     extended: bool = False,
     language: Optional[str] = None,
-    workspace: Optional[str | List[str]] = None,
+    workspace: Optional[str | UUID | List[str | UUID]] = None,
     skip_models: Optional[str | List[str]] = ["ModelBPA", "Fabric Capacity Metrics"],
     skip_models_in_workspace: Optional[dict] = None,
 ):
@@ -41,8 +43,8 @@ def run_model_bpa_bulk(
     language : str, default=None
         The language (code) in which the rules will appear. For example, specifying 'it-IT' will show the Rule Name, Category and Description in Italian.
         Defaults to None which resolves to English.
-    workspace : str | List[str], default=None
-        The workspace or list of workspaces to scan.
+    workspace : str | uuid.UUID | List[str | uuid.UUID], default=None
+        The workspace or list of workspaces to scan. Supports both the workspace name and the workspace id.
         Defaults to None which scans all accessible workspaces.
     skip_models : str | List[str], default=['ModelBPA', 'Fabric Capacity Metrics']
         The semantic models to always skip when running this analysis.
@@ -66,17 +68,12 @@ def run_model_bpa_bulk(
 
     now = datetime.datetime.now()
     output_table = "modelbparesults"
-    lakehouse_workspace = fabric.resolve_workspace_name()
-    lakehouse_id = fabric.get_lakehouse_id()
-    lakehouse = resolve_lakehouse_name(
-        lakehouse_id=lakehouse_id, workspace=lakehouse_workspace
-    )
-    lakeT = get_lakehouse_tables(lakehouse=lakehouse, workspace=lakehouse_workspace)
+    lakeT = get_lakehouse_tables()
     lakeT_filt = lakeT[lakeT["Table Name"] == output_table]
-    if len(lakeT_filt) == 0:
+    if lakeT_filt.empty:
         runId = 1
     else:
-        max_run_id = _get_column_aggregate(lakehouse=lakehouse, table_name=output_table)
+        max_run_id = _get_column_aggregate(table_name=output_table)
         runId = max_run_id + 1
 
     if isinstance(workspace, str):
@@ -86,14 +83,14 @@ def run_model_bpa_bulk(
     if workspace is None:
         dfW_filt = dfW.copy()
     else:
-        dfW_filt = dfW[dfW["Name"].isin(workspace)]
+        dfW_filt = dfW[(dfW["Name"].isin(workspace)) | (dfW["Id"].isin(workspace))]
 
-    if len(dfW_filt) == 0:
+    if dfW_filt.empty:
         raise ValueError(
             f"{icons.red_dot} There are no valid workspaces to assess. This is likely due to not having proper permissions to the workspace(s) entered in the 'workspace' parameter."
         )
 
-    for i, r in dfW_filt.iterrows():
+    for _, r in dfW_filt.iterrows():
         wksp = r["Name"]
         wksp_id = r["Id"]
         capacity_id, capacity_name = resolve_workspace_capacity(workspace=wksp)
@@ -108,7 +105,7 @@ def run_model_bpa_bulk(
             dfD = dfD[~dfD["Dataset Name"].isin(skip_models_wkspc)]
 
         # Exclude default semantic models
-        if len(dfD) > 0:
+        if not dfD.empty:
             dfI = fabric.list_items(workspace=wksp)
             filtered_df = dfI.groupby("Display Name").filter(
                 lambda x: set(["Warehouse", "SemanticModel"]).issubset(set(x["Type"]))
@@ -118,7 +115,7 @@ def run_model_bpa_bulk(
             skip_models.extend(default_semantic_models)
             dfD_filt = dfD[~dfD["Dataset Name"].isin(skip_models)]
 
-            if len(dfD_filt) > 0:
+            if not dfD_filt.empty:
                 for _, r2 in dfD_filt.iterrows():
                     dataset_id = r2["Dataset Id"]
                     dataset_name = r2["Dataset Name"]
@@ -161,7 +158,7 @@ def run_model_bpa_bulk(
                         )
                         print(e)
 
-                if len(df) == 0:
+                if df.empty:
                     print(
                         f"{icons.yellow_dot} No BPA results to save for the '{wksp}' workspace."
                     )
@@ -170,7 +167,7 @@ def run_model_bpa_bulk(
 
                     # Append save results individually for each workspace (so as not to create a giant dataframe)
                     print(
-                        f"{icons.in_progress} Saving the Model BPA results of the '{wksp}' workspace to the '{output_table}' within the '{lakehouse}' lakehouse within the '{lakehouse_workspace}' workspace..."
+                        f"{icons.in_progress} Saving the Model BPA results of the '{wksp}' workspace to the '{output_table}' within the lakehouse attached to this notebook..."
                     )
 
                     schema = {
@@ -195,8 +192,8 @@ def run_model_bpa_bulk(
 @log
 def create_model_bpa_semantic_model(
     dataset: Optional[str] = icons.model_bpa_name,
-    lakehouse: Optional[str] = None,
-    lakehouse_workspace: Optional[str] = None,
+    lakehouse: Optional[str | UUID] = None,
+    lakehouse_workspace: Optional[str | UUID] = None,
 ):
     """
     Dynamically generates a Direct Lake semantic model based on the 'modelbparesults' delta table which contains the Best Practice Analyzer results.
@@ -209,16 +206,15 @@ def create_model_bpa_semantic_model(
     ----------
     dataset : str, default='ModelBPA'
         Name of the semantic model to be created.
-    lakehouse : str, default=None
+    lakehouse : str | uuid.UUID, default=None
         Name of the Fabric lakehouse which contains the 'modelbparesults' delta table.
         Defaults to None which resolves to the default lakehouse attached to the notebook.
-    lakehouse_workspace : str, default=None
+    lakehouse_workspace : str | uuid.UUID, default=None
         The workspace in which the 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.
     """
 
-    from sempy_labs._helper_functions import resolve_lakehouse_name
     from sempy_labs.directlake import (
         generate_shared_expression,
         add_table_to_direct_lake_semantic_model,
@@ -226,22 +222,21 @@ def create_model_bpa_semantic_model(
     from sempy_labs import create_blank_semantic_model, refresh_semantic_model
     from sempy_labs.tom import connect_semantic_model
 
-    lakehouse_workspace = fabric.resolve_workspace_name(lakehouse_workspace)
-
-    if lakehouse is None:
-        lakehouse_id = fabric.get_lakehouse_id()
-        lakehouse = resolve_lakehouse_name(
-            lakehouse_id=lakehouse_id, workspace=lakehouse_workspace
-        )
+    lakehouse_workspace_id = resolve_workspace_id(workspace=lakehouse_workspace)
+    (lakehouse_id, lakehouse_name) = resolve_lakehouse_name_and_id(
+        lakehouse=lakehouse, workspace=lakehouse_workspace_id
+    )
 
     # Generate the shared expression based on the lakehouse and lakehouse workspace
     expr = generate_shared_expression(
-        item_name=lakehouse, item_type="Lakehouse", workspace=lakehouse_workspace
+        item_name=lakehouse_name,
+        item_type="Lakehouse",
+        workspace=lakehouse_workspace_id,
     )
 
     # Create blank model
     create_blank_semantic_model(
-        dataset=dataset, workspace=lakehouse_workspace, overwrite=True
+        dataset=dataset, workspace=lakehouse_workspace_id, overwrite=True
     )
 
     @retry(
@@ -250,7 +245,7 @@ def create_model_bpa_semantic_model(
     )
     def dyn_connect():
         with connect_semantic_model(
-            dataset=dataset, readonly=True, workspace=lakehouse_workspace
+            dataset=dataset, readonly=True, workspace=lakehouse_workspace_id
         ) as tom:
 
             tom.model
@@ -259,7 +254,7 @@ def create_model_bpa_semantic_model(
     icons.sll_tags.append("ModelBPABulk")
     table_exists = False
     with connect_semantic_model(
-        dataset=dataset, readonly=False, workspace=lakehouse_workspace
+        dataset=dataset, readonly=False, workspace=lakehouse_workspace_id
     ) as tom:
         t_name = "BPAResults"
         t_name_full = f"'{t_name}'"
@@ -274,11 +269,11 @@ def create_model_bpa_semantic_model(
             dataset=dataset,
             table_name=t_name,
             lakehouse_table_name="modelbparesults",
-            workspace=lakehouse_workspace,
+            workspace=lakehouse_workspace_id,
             refresh=False,
         )
     with connect_semantic_model(
-        dataset=dataset, readonly=False, workspace=lakehouse_workspace
+        dataset=dataset, readonly=False, workspace=lakehouse_workspace_id
     ) as tom:
         # Fix column names
         for c in tom.all_columns():
@@ -377,4 +372,4 @@ def create_model_bpa_semantic_model(
         # tom.add_measure(table_name=t_name, measure_name='Rules Followed', expression="[Rules] - [Rules Violated]")
 
     # Refresh the model
-    refresh_semantic_model(dataset=dataset, workspace=lakehouse_workspace)
+    refresh_semantic_model(dataset=dataset, workspace=lakehouse_workspace_id)

sempy_labs/_model_bpa_rules.py

@@ -556,7 +556,7 @@ def model_bpa_rules(
                 "Warning",
                 "Use the DIVIDE function for division",
                 lambda obj, tom: re.search(
-                    r"\]\s*\/(?!\/)(?!\*)\" or \"\)\s*\/(?!\/)(?!\*)",
+                    r"\]\s*\/(?!\/)(?!\*)|\)\s*\/(?!\/)(?!\*)",
                     obj.Expression,
                     flags=re.IGNORECASE,
                 ),

sempy_labs/_one_lake_integration.py

@@ -5,6 +5,7 @@ from sempy._utils._log import log
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
+    resolve_workspace_id,
 )
 import sempy_labs._icons as icons
 from uuid import UUID
@@ -43,7 +44,7 @@ def export_model_to_onelake(
         destination_workspace = workspace_name
         destination_workspace_id = workspace_id
     else:
-        destination_workspace_id = fabric.resolve_workspace_id(destination_workspace)
+        destination_workspace_id = resolve_workspace_id(workspace=destination_workspace)
 
     tmsl = f"""
     {{

sempy_labs/_semantic_models.py

@@ -7,6 +7,7 @@ from sempy_labs._helper_functions import (
     _update_dataframe_datatypes,
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
+    delete_item,
 )
 import sempy_labs._icons as icons
 
@@ -115,3 +116,22 @@ def enable_semantic_model_scheduled_refresh(
         print(
             f"{icons.green_dot} Scheduled refresh for the '{dataset_name}' within the '{workspace_name}' workspace has been enabled."
         )
+
+
+def delete_semantic_model(dataset: str | UUID, workspace: Optional[str | UUID] = None):
+    """
+    Deletes a semantic model.
+
+    This is a wrapper function for the following API: `Items - Delete Semantic Model <https://learn.microsoft.com/rest/api/fabric/semanticmodel/items/delete-semantic-model>`_.
+
+    Parameters
+    ----------
+    dataset: str | uuid.UUID
+        Name or ID of the semantic model.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    delete_item(item=dataset, type="SemanticModel", workspace=workspace)

sempy_labs/_sql.py

@@ -60,14 +60,18 @@ class ConnectBase:
                 item=item, workspace=workspace_id, type=endpoint_type.capitalize()
             )
 
+        endpoint_for_url = (
+            "sqlDatabases" if endpoint_type == "sqldatabase" else f"{endpoint_type}s"
+        )
+
         # Get the TDS endpoint
         response = _base_api(
-            request=f"v1/workspaces/{workspace_id}/{endpoint_type}s/{resource_id}"
+            request=f"v1/workspaces/{workspace_id}/{endpoint_for_url}/{resource_id}"
         )
 
         if endpoint_type == "warehouse":
             tds_endpoint = response.json().get("properties", {}).get("connectionString")
-        if endpoint_type == "sqldatabase":
+        elif endpoint_type == "sqldatabase":
             tds_endpoint = response.json().get("properties", {}).get("serverFqdn")
         else:
             tds_endpoint = (