semantic-link-labs 0.7.2__py3-none-any.whl → 0.7.4__py3-none-any.whl

sempy_labs/_workspaces.py

@@ -0,0 +1,294 @@
+import sempy.fabric as fabric
+import pandas as pd
+import sempy_labs._icons as icons
+from typing import Optional
+from sempy_labs._helper_functions import (
+    resolve_workspace_name_and_id,
+    pagination,
+    resolve_capacity_id,
+)
+from sempy.fabric.exceptions import FabricHTTPException
+
+
+def delete_user_from_workspace(email_address: str, workspace: Optional[str] = None):
+    """
+    Removes a user from a workspace.
+
+    Parameters
+    ----------
+    email_address : str
+        The email address of the user.
+    workspace : str, default=None
+        The name of the workspace.
+        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
+    -------
+    """
+
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    client = fabric.PowerBIRestClient()
+    response = client.delete(f"/v1.0/myorg/groups/{workspace_id}/users/{email_address}")
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    print(
+        f"{icons.green_dot} The '{email_address}' user has been removed from accessing the '{workspace}' workspace."
+    )
+
+
+def update_workspace_user(
+    email_address: str,
+    role_name: str,
+    principal_type: Optional[str] = "User",
+    workspace: Optional[str] = None,
+):
+    """
+    Updates a user's role within a workspace.
+
+    Parameters
+    ----------
+    email_address : str
+        The email address of the user.
+    role_name : str
+        The `role <https://learn.microsoft.com/rest/api/power-bi/groups/add-group-user#groupuseraccessright>`_ of the user within the workspace.
+    principal_type : str, default='User'
+        The `principal type <https://learn.microsoft.com/rest/api/power-bi/groups/add-group-user#principaltype>`_.
+    workspace : str, default=None
+        The name of the workspace.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    role_names = icons.workspace_roles
+    role_name = role_name.capitalize()
+    if role_name not in role_names:
+        raise ValueError(
+            f"{icons.red_dot} Invalid role. The 'role_name' parameter must be one of the following: {role_names}."
+        )
+    principal_types = icons.principal_types
+    principal_type = principal_type.capitalize()
+    if principal_type not in principal_types:
+        raise ValueError(
+            f"{icons.red_dot} Invalid princpal type. Valid options: {principal_types}."
+        )
+
+    request_body = {
+        "emailAddress": email_address,
+        "groupUserAccessRight": role_name,
+        "principalType": principal_type,
+        "identifier": email_address,
+    }
+
+    client = fabric.PowerBIRestClient()
+    response = client.put(f"/v1.0/myorg/groups/{workspace_id}/users", json=request_body)
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    print(
+        f"{icons.green_dot} The '{email_address}' user has been updated to a '{role_name}' within the '{workspace}' workspace."
+    )
+
+
+def list_workspace_users(workspace: Optional[str] = None) -> pd.DataFrame:
+    """
+    A list of all the users of a workspace and their roles.
+
+    Parameters
+    ----------
+    workspace : str, default=None
+        The name of the workspace.
+        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 the users of a workspace and their properties.
+    """
+
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    df = pd.DataFrame(columns=["User Name", "Email Address", "Role", "Type", "User ID"])
+    client = fabric.FabricRestClient()
+    response = client.get(f"/v1/workspaces/{workspace_id}/roleAssignments")
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    responses = pagination(client, response)
+
+    for r in responses:
+        for v in r.get("value", []):
+            p = v.get("principal", {})
+            new_data = {
+                "User Name": p.get("displayName"),
+                "User ID": p.get("id"),
+                "Type": p.get("type"),
+                "Role": v.get("role"),
+                "Email Address": p.get("userDetails", {}).get("userPrincipalName"),
+            }
+            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df
+
+
+def add_user_to_workspace(
+    email_address: str,
+    role_name: str,
+    principal_type: Optional[str] = "User",
+    workspace: Optional[str] = None,
+):
+    """
+    Adds a user to a workspace.
+
+    Parameters
+    ----------
+    email_address : str
+        The email address of the user.
+    role_name : str
+        The `role <https://learn.microsoft.com/rest/api/power-bi/groups/add-group-user#groupuseraccessright>`_ of the user within the workspace.
+    principal_type : str, default='User'
+        The `principal type <https://learn.microsoft.com/rest/api/power-bi/groups/add-group-user#principaltype>`_.
+    workspace : str, default=None
+        The name of the workspace.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    role_names = icons.workspace_roles
+    role_name = role_name.capitalize()
+    if role_name not in role_names:
+        raise ValueError(
+            f"{icons.red_dot} Invalid role. The 'role_name' parameter must be one of the following: {role_names}."
+        )
+    plural = "n" if role_name == "Admin" else ""
+    principal_types = icons.principal_types
+    principal_type = principal_type.capitalize()
+    if principal_type not in principal_types:
+        raise ValueError(
+            f"{icons.red_dot} Invalid princpal type. Valid options: {principal_types}."
+        )
+
+    client = fabric.PowerBIRestClient()
+
+    request_body = {
+        "emailAddress": email_address,
+        "groupUserAccessRight": role_name,
+        "principalType": principal_type,
+        "identifier": email_address,
+    }
+
+    response = client.post(
+        f"/v1.0/myorg/groups/{workspace_id}/users", json=request_body
+    )
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    print(
+        f"{icons.green_dot} The '{email_address}' user has been added as a{plural} '{role_name}' within the '{workspace}' workspace."
+    )
+
+
+def assign_workspace_to_capacity(capacity_name: str, workspace: Optional[str] = None):
+    """
+    Assigns a workspace to a capacity.
+
+    Parameters
+    ----------
+    capacity_name : str
+        The name of the capacity.
+    workspace : str, default=None
+        The name of the Fabric workspace.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    capacity_id = resolve_capacity_id(capacity_name=capacity_name)
+
+    request_body = {"capacityId": capacity_id}
+
+    client = fabric.FabricRestClient()
+    response = client.post(
+        f"/v1/workspaces/{workspace_id}/assignToCapacity",
+        json=request_body,
+    )
+
+    if response.status_code not in [200, 202]:
+        raise FabricHTTPException(response)
+    print(
+        f"{icons.green_dot} The '{workspace}' workspace has been assigned to the '{capacity_name}' capacity."
+    )
+
+
+def unassign_workspace_from_capacity(workspace: Optional[str] = None):
+    """
+    Unassigns a workspace from its assigned capacity.
+
+    Parameters
+    ----------
+    workspace : str, default=None
+        The name of the Fabric workspace.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    # https://learn.microsoft.com/en-us/rest/api/fabric/core/workspaces/unassign-from-capacity?tabs=HTTP
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    client = fabric.FabricRestClient()
+    response = client.post(f"/v1/workspaces/{workspace_id}/unassignFromCapacity")
+
+    if response.status_code not in [200, 202]:
+        raise FabricHTTPException(response)
+    print(
+        f"{icons.green_dot} The '{workspace}' workspace has been unassigned from its capacity."
+    )
+
+
+def list_workspace_role_assignments(workspace: Optional[str] = None) -> pd.DataFrame:
+    """
+    Shows the members of a given workspace.
+
+    Parameters
+    ----------
+    workspace : str, default=None
+        The Fabric workspace name.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the members of a given workspace and their roles.
+    """
+
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    df = pd.DataFrame(columns=["User Name", "User Email", "Role Name", "Type"])
+
+    client = fabric.FabricRestClient()
+    response = client.get(f"/v1/workspaces/{workspace_id}/roleAssignments")
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    responses = pagination(client, response)
+
+    for r in responses:
+        for i in r.get("value", []):
+            principal = i.get("principal", {})
+            new_data = {
+                "User Name": principal.get("displayName"),
+                "Role Name": i.get("role"),
+                "Type": principal.get("type"),
+                "User Email": principal.get("userDetails", {}).get("userPrincipalName"),
+            }
+            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df

sempy_labs/directlake/__init__.py

@@ -1,3 +1,4 @@
+from sempy_labs.directlake._generate_shared_expression import generate_shared_expression
 from sempy_labs.directlake._directlake_schema_compare import direct_lake_schema_compare
 from sempy_labs.directlake._directlake_schema_sync import direct_lake_schema_sync
 from sempy_labs.directlake._dl_helper import (
@@ -31,6 +32,7 @@ from sempy_labs.directlake._warm_cache import (
 )
 
 __all__ = [
+    "generate_shared_expression",
     "direct_lake_schema_compare",
     "direct_lake_schema_sync",
     "check_fallback_reason",

sempy_labs/directlake/_directlake_schema_compare.py

@@ -6,7 +6,6 @@ from sempy_labs._helper_functions import (
 from IPython.display import display
 from sempy_labs.lakehouse import get_lakehouse_columns
 from sempy_labs.directlake._dl_helper import get_direct_lake_source
-from sempy_labs._list_functions import list_tables
 from typing import Optional
 import sempy_labs._icons as icons
 from sempy._utils._log import log
@@ -61,7 +60,7 @@ def direct_lake_schema_compare(
             f"{icons.red_dot} The '{dataset}' semantic model is not in Direct Lake mode."
         )
 
-    dfT = list_tables(dataset, workspace)
+    dfT = fabric.list_tables(dataset=dataset, workspace=workspace)
     dfC = fabric.list_columns(dataset=dataset, workspace=workspace)
     lc = get_lakehouse_columns(lakehouse_name, lakehouse_workspace)
 

sempy_labs/directlake/_directlake_schema_sync.py

@@ -32,7 +32,6 @@ def direct_lake_schema_sync(
 
     sempy.fabric._client._utils._init_analysis_services()
     import Microsoft.AnalysisServices.Tabular as TOM
-    import System
 
     if "lakehouse" in kwargs:
         print(
@@ -99,7 +98,7 @@ def direct_lake_schema_sync(
                             table_name=table_name,
                             column_name=lakeCName,
                             source_column=lakeCName,
-                            data_type=System.Enum.Parse(TOM.DataType, dt),
+                            data_type=dt,
                         )
                         print(
                             f"{icons.green_dot} The '{lakeCName}' column in the '{lakeTName}' lakehouse table was added to the '{dataset}' semantic model within the '{workspace}' workspace."

sempy_labs/directlake/_dl_helper.py

@@ -126,18 +126,15 @@ def generate_direct_lake_semantic_model(
     expr = get_shared_expression(lakehouse=lakehouse, workspace=lakehouse_workspace)
     dfD = fabric.list_datasets(workspace=workspace)
     dfD_filt = dfD[dfD["Dataset Name"] == dataset]
-    dfD_filt_len = len(dfD_filt)
 
-    if dfD_filt_len > 0 and overwrite is False:
+    if len(dfD_filt) > 0 and not overwrite:
         raise ValueError(
             f"{icons.red_dot} The '{dataset}' semantic model within the '{workspace}' workspace already exists. Overwrite is set to False so the new semantic model has not been created."
         )
-    if dfD_filt_len > 0 and overwrite:
-        print(
-            f"{icons.warning} Overwriting the existing '{dataset}' semantic model within the '{workspace}' workspace."
-        )
 
-    create_blank_semantic_model(dataset=dataset, workspace=workspace)
+    create_blank_semantic_model(
+        dataset=dataset, workspace=workspace, overwrite=overwrite
+    )
 
     @retry(
         sleep_time=1,

sempy_labs/directlake/_generate_shared_expression.py

@@ -0,0 +1,85 @@
+import sempy.fabric as fabric
+from sempy_labs._helper_functions import (
+    resolve_lakehouse_name,
+    resolve_lakehouse_id,
+    resolve_warehouse_id,
+)
+from typing import Optional
+import sempy_labs._icons as icons
+from sempy.fabric.exceptions import FabricHTTPException
+
+
+def generate_shared_expression(
+    item_name: Optional[str] = None,
+    item_type: Optional[str] = "Lakehouse",
+    workspace: Optional[str] = None,
+) -> str:
+    """
+    Dynamically generates the M expression used by a Direct Lake model for a given lakehouse/warehouse.
+
+    Parameters
+    ----------
+    item_name : str, default=None
+        The Fabric lakehouse or warehouse name.
+        Defaults to None which resolves to the lakehouse attached to the notebook.
+    item_type : str, default="Lakehouse"
+        The Fabric item name. Valid options: 'Lakehouse', 'Warehouse'.
+    workspace : str, default=None
+        The Fabric workspace used by the item.
+        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
+    -------
+    str
+        Shows the expression which can be used to connect a Direct Lake semantic model to its SQL Endpoint.
+    """
+
+    workspace = fabric.resolve_workspace_name(workspace)
+    workspace_id = fabric.resolve_workspace_id(workspace)
+    item_types = ["Lakehouse", "Warehouse"]
+    item_type = item_type.capitalize()
+    if item_type not in item_types:
+        raise ValueError(
+            f"{icons.red_dot} Invalid item type. Valid options: {item_types}."
+        )
+
+    if item_name is None:
+        item_id = fabric.get_lakehouse_id()
+        item_name = resolve_lakehouse_name(item_id, workspace)
+    elif item_name is not None and item_type == "Lakehouse":
+        item_id = resolve_lakehouse_id(lakehouse=item_name, workspace=workspace)
+    elif item_type == "Warehouse":
+        item_id = resolve_warehouse_id(warehouse=item_name, workspace=workspace)
+
+    client = fabric.FabricRestClient()
+    item_type_rest = f"{item_type.lower()}s"
+    response = client.get(f"/v1/workspaces/{workspace_id}/{item_type_rest}/{item_id}")
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    if item_type == "Lakehouse":
+        prop = response.json()["properties"]["sqlEndpointProperties"]
+        sqlEPCS = prop["connectionString"]
+        sqlepid = prop["id"]
+        provStatus = prop["provisioningStatus"]
+    elif item_type == "Warehouse":
+        prop = response.json()["properties"]
+        sqlEPCS = prop["connectionString"]
+        sqlepid = item_id
+        provStatus = None
+
+    if provStatus == "InProgress":
+        raise ValueError(
+            f"{icons.red_dot} The SQL Endpoint for the '{item_name}' lakehouse within the '{workspace}' workspace has not yet been provisioned. Please wait until it has been provisioned."
+        )
+
+    sh = (
+        'let\n\tdatabase = Sql.Database("'
+        + sqlEPCS
+        + '", "'
+        + sqlepid
+        + '")\nin\n\tdatabase'
+    )
+
+    return sh

sempy_labs/directlake/_show_unsupported_directlake_objects.py

@@ -1,6 +1,5 @@
 import sempy.fabric as fabric
 import pandas as pd
-from sempy_labs._list_functions import list_tables
 from sempy_labs._helper_functions import format_dax_object_name
 from typing import Optional, Tuple
 from sempy._utils._log import log
@@ -33,7 +32,7 @@ def show_unsupported_direct_lake_objects(
 
     workspace = fabric.resolve_workspace_name(workspace)
 
-    dfT = list_tables(dataset, workspace)
+    dfT = fabric.list_tables(dataset=dataset, workspace=workspace)
     dfC = fabric.list_columns(dataset=dataset, workspace=workspace)
     dfR = fabric.list_relationships(dataset=dataset, workspace=workspace)
 

sempy_labs/lakehouse/_get_lakehouse_tables.py

@@ -7,6 +7,7 @@ from sempy_labs._helper_functions import (
     resolve_lakehouse_id,
     resolve_lakehouse_name,
     resolve_workspace_name_and_id,
+    pagination,
 )
 from sempy_labs.directlake._guardrails import (
     get_sku_size,
@@ -52,8 +53,6 @@ def get_lakehouse_tables(
         Shows the tables/columns within a lakehouse and their properties.
     """
 
-    from sempy_labs._helper_functions import pagination
-
     df = pd.DataFrame(
         columns=[
             "Workspace Name",
@@ -96,6 +95,9 @@ def get_lakehouse_tables(
 
     responses = pagination(client, response)
 
+    if not responses[0].get("data"):
+        return df
+
     dfs = []
     for r in responses:
         for i in r.get("data", []):
@@ -108,7 +110,9 @@ def get_lakehouse_tables(
                 "Location": i.get("location"),
             }
             dfs.append(pd.DataFrame(new_data, index=[0]))
-    df = pd.concat(dfs, ignore_index=True)
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
 
     if extended:
         sku_value = get_sku_size(workspace)

sempy_labs/migration/_migrate_calctables_to_lakehouse.py

@@ -52,6 +52,11 @@ def migrate_calc_tables_to_lakehouse(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
+    if dataset == new_dataset:
+        raise ValueError(
+            f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters are both set to '{dataset}'. These parameters must be set to different values."
+        )
+
     workspace = fabric.resolve_workspace_name(workspace)
 
     if new_dataset_workspace is None:

sempy_labs/migration/_migrate_calctables_to_semantic_model.py

@@ -48,6 +48,11 @@ def migrate_calc_tables_to_semantic_model(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
+    if dataset == new_dataset:
+        raise ValueError(
+            f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters are both set to '{dataset}'. These parameters must be set to different values."
+        )
+
     workspace = fabric.resolve_workspace_name(workspace)
 
     if new_dataset_workspace is None:

sempy_labs/migration/_migrate_model_objects_to_semantic_model.py

@@ -1,7 +1,6 @@
 import sempy
 import sempy.fabric as fabric
 import re
-from sempy_labs._list_functions import list_tables
 from sempy_labs._helper_functions import (
     create_relationship_name,
     retry,
@@ -43,12 +42,17 @@ def migrate_model_objects_to_semantic_model(
     import Microsoft.AnalysisServices.Tabular as TOM
     import System
 
+    if dataset == new_dataset:
+        raise ValueError(
+            f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters are both set to '{dataset}'. These parameters must be set to different values."
+        )
+
     workspace = fabric.resolve_workspace_name(workspace)
 
     if new_dataset_workspace is None:
         new_dataset_workspace = workspace
 
-    dfT = list_tables(dataset, workspace)
+    dfT = fabric.list_tables(dataset=dataset, workspace=workspace)
     dfC = fabric.list_columns(dataset=dataset, workspace=workspace)
     dfM = fabric.list_measures(dataset=dataset, workspace=workspace)
     dfRole = fabric.get_roles(dataset=dataset, workspace=workspace)

sempy_labs/migration/_migrate_tables_columns_to_semantic_model.py

@@ -1,8 +1,5 @@
 import sempy.fabric as fabric
 import pandas as pd
-import datetime
-import time
-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, retry
 from sempy_labs.lakehouse._lakehouse import lakehouse_attached
@@ -45,9 +42,13 @@ def migrate_tables_columns_to_semantic_model(
         The Fabric workspace used by the lakehouse.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
-
     """
 
+    if dataset == new_dataset:
+        raise ValueError(
+            f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters are both set to '{dataset}'. These parameters must be set to different values."
+        )
+
     workspace = fabric.resolve_workspace_name(workspace)
 
     if new_dataset_workspace is None:
@@ -71,7 +72,7 @@ def migrate_tables_columns_to_semantic_model(
     shEx = get_shared_expression(lakehouse, lakehouse_workspace)
 
     dfC = fabric.list_columns(dataset=dataset, workspace=workspace)
-    dfT = list_tables(dataset, workspace)
+    dfT = fabric.list_tables(dataset=dataset, workspace=workspace)
     dfT.rename(columns={"Type": "Table Type"}, inplace=True)
     dfC = pd.merge(
         dfC,

sempy_labs/migration/_migration_validation.py

@@ -3,6 +3,7 @@ import pandas as pd
 from typing import Optional
 from sempy_labs._list_functions import list_semantic_model_objects
 from sempy._utils._log import log
+import sempy_labs._icons as icons
 
 
 @log
@@ -36,6 +37,11 @@ def migration_validation(
        A pandas dataframe showing a list of objects and whether they were successfully migrated. Also shows the % of objects which were migrated successfully.
     """
 
+    if dataset == new_dataset:
+        raise ValueError(
+            f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters are both set to '{dataset}'. These parameters must be set to different values."
+        )
+
     workspace = fabric.resolve_workspace_name(workspace)
     if new_dataset_workspace is None:
         new_dataset_workspace = workspace