semantic-link-labs 0.11.2__py3-none-any.whl → 0.12.0__py3-none-any.whl

sempy_labs/_clear_cache.py

@@ -1,5 +1,5 @@
 import sempy.fabric as fabric
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     is_default_semantic_model,
     _get_adls_client,
     resolve_workspace_name_and_id,

sempy_labs/_connections.py

@@ -1,8 +1,8 @@
 import pandas as pd
 from typing import Optional
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     _is_valid_uuid,
-    resolve_workspace_name_and_id,
+    resolve_workspace_id,
     _update_dataframe_datatypes,
     _base_api,
     _create_dataframe,
@@ -10,8 +10,9 @@ from ._helper_functions import (
 )
 from uuid import UUID
 import sempy_labs._icons as icons
-from ._gateways import _resolve_gateway_id
+from sempy_labs._gateways import _resolve_gateway_id
 from sempy._utils._log import log
+import warnings
 
 
 @log
@@ -68,13 +69,13 @@ def delete_connection_role_assignment(connection: str | UUID, role_assignment_id
 @log
 def _resolve_connection_id(connection: str | UUID) -> UUID:
 
-    dfC = list_connections()
     if _is_valid_uuid(connection):
-        dfC_filt = dfC[dfC["Connection Id"] == connection]
-    else:
-        dfC_filt = dfC[dfC["Connection Name"] == connection]
+        return connection
+
+    dfC = list_connections()
+    dfC_filt = dfC[dfC["Connection Name"] == connection]
 
-    if len(dfC_filt) == 0:
+    if dfC_filt.empty:
         raise ValueError(
             f"{icons.red_dot} The '{connection}' is not a valid connection."
         )
@@ -119,16 +120,20 @@ def list_connection_role_assignments(connection: str | UUID) -> pd.DataFrame:
         uses_pagination=True,
     )
 
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Connection Role Assignment Id": v.get("id"),
-                "Principal Id": v.get("principal", {}).get("id"),
-                "Principal Type": v.get("principal", {}).get("type"),
-                "Role": v.get("role"),
-            }
+            rows.append(
+                {
+                    "Connection Role Assignment Id": v.get("id"),
+                    "Principal Id": v.get("principal", {}).get("id"),
+                    "Principal Type": v.get("principal", {}).get("type"),
+                    "Role": v.get("role"),
+                }
+            )
 
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
 
@@ -165,51 +170,57 @@ def list_connections() -> pd.DataFrame:
         request="/v1/connections", client="fabric_sp", uses_pagination=True
     )
 
+    rows = []
     for r in responses:
         for i in r.get("value", []):
             connection_details = i.get("connectionDetails", {})
             credential_details = i.get("credentialDetails", {})
 
-            new_data = {
-                "Connection Id": i.get("id"),
-                "Connection Name": i.get("displayName"),
-                "Gateway Id": i.get("gatewayId"),
-                "Connectivity Type": i.get("connectivityType"),
-                "Connection Path": connection_details.get("path"),
-                "Connection Type": connection_details.get("type"),
-                "Privacy Level": i.get("privacyLevel"),
-                "Credential Type": (
-                    credential_details.get("credentialType")
-                    if credential_details
-                    else None
-                ),
-                "Single Sign On Type": (
-                    credential_details.get("singleSignOnType")
-                    if credential_details
-                    else None
-                ),
-                "Connection Encryption": (
-                    credential_details.get("connectionEncryption")
-                    if credential_details
-                    else None
-                ),
-                "Skip Test Connection": (
-                    credential_details.get("skipTestConnection")
-                    if credential_details
-                    else None
-                ),
-            }
-
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+            rows.append(
+                {
+                    "Connection Id": i.get("id"),
+                    "Connection Name": i.get("displayName"),
+                    "Gateway Id": i.get("gatewayId"),
+                    "Connectivity Type": i.get("connectivityType"),
+                    "Connection Path": connection_details.get("path"),
+                    "Connection Type": connection_details.get("type"),
+                    "Privacy Level": i.get("privacyLevel"),
+                    "Credential Type": (
+                        credential_details.get("credentialType")
+                        if credential_details
+                        else None
+                    ),
+                    "Single Sign On Type": (
+                        credential_details.get("singleSignOnType")
+                        if credential_details
+                        else None
+                    ),
+                    "Connection Encryption": (
+                        credential_details.get("connectionEncryption")
+                        if credential_details
+                        else None
+                    ),
+                    "Skip Test Connection": (
+                        credential_details.get("skipTestConnection")
+                        if credential_details
+                        else None
+                    ),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
 
 @log
 def list_item_connections(
-    item_name: str, item_type: str, workspace: Optional[str | UUID] = None
+    item: Optional[str | UUID] = None,
+    type: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
+    **kwargs,
 ) -> pd.DataFrame:
     """
     Shows the list of connections that the specified item is connected to.
@@ -220,9 +231,9 @@ def list_item_connections(
 
     Parameters
     ----------
-    item_name : str
-        The item name.
-    item_type : str
+    item : str | uuid.UUID
+        The item name or ID.
+    type : str
         The `item type <https://learn.microsoft.com/rest/api/fabric/core/items/update-item?tabs=HTTP#itemtype>`_.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID.
@@ -235,9 +246,32 @@ def list_item_connections(
         A pandas dataframe showing the list of connections that the specified item is connected to.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_type = item_type[0].upper() + item_type[1:]
-    item_id = resolve_item_id(item=item_name, type=item_type, workspace=workspace_id)
+    if "item_name" in kwargs:
+        if item is not None:
+            raise TypeError("Cannot specify both 'item' and 'item_name'")
+        item = kwargs.pop("item_name")
+        warnings.warn(
+            "'item_name' parameter is deprecated, use 'item' instead.",
+            FutureWarning,
+            stacklevel=2,
+        )
+    if "item_type" in kwargs:
+        if type is not None:
+            raise TypeError("Cannot specify both 'type' and 'item_type'")
+        type = kwargs.pop("item_type")
+        warnings.warn(
+            "'item_type' parameter is deprecated, use 'type' instead.",
+            FutureWarning,
+            stacklevel=2,
+        )
+
+    if item is None or type is None:
+        raise TypeError(
+            "Missing required parameters: 'item' and 'type' must be provided either directly or via 'item_name' and 'item_type'."
+        )
+
+    workspace_id = resolve_workspace_id(workspace)
+    item_id = resolve_item_id(item=item, type=type, workspace=workspace_id)
 
     columns = {
         "Connection Name": "string",
@@ -255,18 +289,22 @@ def list_item_connections(
         uses_pagination=True,
     )
 
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Connection Name": v.get("displayName"),
-                "Connection Id": v.get("id"),
-                "Connectivity Type": v.get("connectivityType"),
-                "Connection Type": v.get("connectionDetails", {}).get("type"),
-                "Connection Path": v.get("connectionDetails", {}).get("path"),
-                "Gateway Id": v.get("gatewayId"),
-            }
+            rows.append(
+                {
+                    "Connection Name": v.get("displayName"),
+                    "Connection Id": v.get("id"),
+                    "Connectivity Type": v.get("connectivityType"),
+                    "Connection Type": v.get("connectionDetails", {}).get("type"),
+                    "Connection Path": v.get("connectionDetails", {}).get("path"),
+                    "Gateway Id": v.get("gatewayId"),
+                }
+            )
 
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
 
@@ -293,10 +331,10 @@ def _list_supported_connection_types(
     url = url.rstrip("&")
     responses = _base_api(request=url, client="fabric_sp", uses_pagination=True)
 
-    records = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            records.append(
+            rows.append(
                 {
                     "Connection Type": v.get("type"),
                     "Creation Method": v["creationMethods"][0]["name"],
@@ -310,10 +348,9 @@ def _list_supported_connection_types(
                 }
             )
 
-    if records:
-        df = pd.DataFrame(records)
-
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 

sempy_labs/_dashboards.py

@@ -1,7 +1,7 @@
 from typing import Optional
 from uuid import UUID
 import pandas as pd
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     _create_dataframe,
     _base_api,
     resolve_workspace_id,
@@ -15,6 +15,8 @@ def list_dashboards(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     Shows a list of the dashboards 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
@@ -42,7 +44,9 @@ def list_dashboards(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     workspace_id = resolve_workspace_id(workspace)
 
-    response = _base_api(request=f"/v1.0/myorg/groups/{workspace_id}/dashboards")
+    response = _base_api(
+        request=f"/v1.0/myorg/groups/{workspace_id}/dashboards", client="fabric_sp"
+    )
 
     rows = []
     for v in response.json().get("value", []):

sempy_labs/_data_pipelines.py

@@ -1,6 +1,6 @@
 import pandas as pd
 from typing import Optional
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _decode_b64,
     _base_api,

sempy_labs/_dataflows.py

@@ -1,5 +1,5 @@
 import pandas as pd
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _is_valid_uuid,
     _update_dataframe_datatypes,

sempy_labs/_dax.py

@@ -1,17 +1,17 @@
 import sempy.fabric as fabric
 import pandas as pd
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     format_dax_object_name,
     resolve_dataset_name_and_id,
     _base_api,
     generate_guid,
 )
-from ._model_dependencies import get_model_calc_dependencies
+from sempy_labs._model_dependencies import get_model_calc_dependencies
 from typing import Optional, List, Tuple
 from sempy._utils._log import log
 from uuid import UUID
-from .directlake._warm_cache import _put_columns_into_memory
+from sempy_labs.directlake._warm_cache import _put_columns_into_memory
 import sempy_labs._icons as icons
 import time
 

sempy_labs/_delta_analyzer.py

@@ -5,7 +5,7 @@ import os
 from uuid import UUID
 from typing import Dict, Optional
 import pyarrow.parquet as pq
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     create_abfss_path,
     save_as_delta_table,
     _get_column_aggregate,
@@ -21,11 +21,11 @@ from ._helper_functions import (
     _get_delta_table,
 )
 from sempy._utils._log import log
-from .lakehouse._get_lakehouse_tables import get_lakehouse_tables
-from .lakehouse._lakehouse import (
+from sempy_labs.lakehouse._get_lakehouse_tables import get_lakehouse_tables
+from sempy_labs.lakehouse._lakehouse import (
     lakehouse_attached,
 )
-from .lakehouse._helper import (
+from sempy_labs.lakehouse._helper import (
     is_v_ordered,
 )
 import sempy_labs._icons as icons

sempy_labs/_delta_analyzer_history.py

@@ -1,7 +1,7 @@
 import pandas as pd
 from typing import Optional
 import pyarrow.parquet as pq
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     create_abfss_path,
     resolve_workspace_id,
     resolve_lakehouse_id,

sempy_labs/_deployment_pipelines.py

@@ -1,5 +1,5 @@
 import pandas as pd
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     _is_valid_uuid,
     _base_api,
     _update_dataframe_datatypes,

sempy_labs/_environments.py

@@ -1,7 +1,7 @@
 import pandas as pd
 import sempy_labs._icons as icons
 from typing import Optional
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     resolve_workspace_id,
     _base_api,

sempy_labs/_eventhouses.py

@@ -1,12 +1,12 @@
 import pandas as pd
 from typing import Optional
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     _base_api,
     _create_dataframe,
     _conv_b64,
     delete_item,
     create_item,
-    get_item_definition,
+    _get_item_definition,
     resolve_workspace_id,
 )
 from uuid import UUID
@@ -26,6 +26,8 @@ def create_eventhouse(
 
     This is a wrapper function for the following API: `Items - Create Eventhouse <https://learn.microsoft.com/rest/api/fabric/environment/items/create-eventhouse>`_.
 
+    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
@@ -127,6 +129,8 @@ def delete_eventhouse(name: str, workspace: Optional[str | UUID] = None):
 
     This is a wrapper function for the following API: `Items - Delete Eventhouse <https://learn.microsoft.com/rest/api/fabric/environment/items/delete-eventhouse>`_.
 
+    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
@@ -151,6 +155,8 @@ def get_eventhouse_definition(
 
     This is a wrapper function for the following API: `Items - Get Eventhouse Definition <https://learn.microsoft.com/rest/api/fabric/eventhouse/items/get-eventhouse-definition>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     eventhouse : str
@@ -168,7 +174,7 @@ def get_eventhouse_definition(
         The eventhouse definition in .json format or as a pandas dataframe.
     """
 
-    return get_item_definition(
+    return _get_item_definition(
         item=eventhouse,
         type="Eventhouse",
         workspace=workspace,

sempy_labs/_eventstreams.py

@@ -1,6 +1,6 @@
 import pandas as pd
 from typing import Optional
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     _base_api,
     delete_item,
     _create_dataframe,

sempy_labs/_external_data_shares.py

@@ -2,11 +2,13 @@ from uuid import UUID
 import pandas as pd
 from typing import Optional, List
 import sempy_labs._icons as icons
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
     resolve_item_id,
+    resolve_item_name_and_id,
+    resolve_workspace_id,
 )
 from sempy._utils._log import log
 
@@ -24,6 +26,8 @@ def create_external_data_share(
 
     This is a wrapper function for the following API: `External Data Shares - Create External Data Share <https://learn.microsoft.com/rest/api/fabric/core/external-data-shares/create-external-data-share>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     item_name : str
@@ -53,6 +57,7 @@ def create_external_data_share(
         method="post",
         status_codes=201,
         payload=payload,
+        client="fabric_sp",
     )
     print(
         f"{icons.green_dot} An external data share was created for the '{item_name}' {item_type} within the '{workspace_name}' workspace for the {paths} paths."
@@ -71,6 +76,8 @@ def revoke_external_data_share(
 
     This is a wrapper function for the following API: `External Data Shares - Revoke External Data Share <https://learn.microsoft.com/rest/api/fabric/core/external-data-shares/revoke-external-data-share`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     external_data_share_id : uuid.UUID
@@ -91,6 +98,7 @@ def revoke_external_data_share(
     _base_api(
         request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}/revoke",
         method="post",
+        client="fabric_sp",
     )
     print(
         f"{icons.green_dot} The '{external_data_share_id}' external data share for the '{item_name}' {item_type} within the '{workspace_name}' workspace has been revoked."
@@ -106,6 +114,8 @@ def list_external_data_shares_in_item(
 
     This is a wrapper function for the following API: `External Data Shares - List External Data Shares In Item <https://learn.microsoft.com/rest/api/fabric/core/external-data-shares/list-external-data-shares-in-item`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     item_name : str
@@ -123,7 +133,7 @@ def list_external_data_shares_in_item(
         A pandas dataframe showing a list of the external data shares that exist for the specified item.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    workspace_id = resolve_workspace_id(workspace)
     item_id = resolve_item_id(item=item_name, type=item_type, workspace=workspace_id)
 
     columns = {
@@ -145,6 +155,7 @@ def list_external_data_shares_in_item(
     responses = _base_api(
         request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares",
         uses_pagination=True,
+        client="fabric_sp",
     )
 
     rows = []
@@ -174,3 +185,46 @@ def list_external_data_shares_in_item(
         df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
+
+
+@log
+def delete_external_data_share(
+    external_data_share_id: UUID,
+    item: str | UUID,
+    item_type: str,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Deletes the specified external data share.
+
+    This is a wrapper function for the following API: `External Data Shares Provider - Delete External Data Share <https://learn.microsoft.com/rest/api/fabric/core/external-data-shares-provider/delete-external-data-share`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    external_data_share_id : uuid.UUID
+        The external data share ID.
+    item : str | uuid.UUID
+        The item name or ID.
+    item_type : str
+        The `item type <https://learn.microsoft.com/rest/api/fabric/core/items/list-items?tabs=HTTP#itemtype>`_.
+    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.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (item_name, item_id) = resolve_item_name_and_id(
+        item=item, type=item_type, workspace=workspace_id
+    )
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}",
+        method="delete",
+        client="fabric_sp",
+    )
+    print(
+        f"{icons.green_dot} The '{external_data_share_id}' external data share for the '{item_name}' {item_type} within the '{workspace_name}' workspace has been revoked."
+    )

sempy_labs/_gateways.py

@@ -77,16 +77,16 @@ def list_gateways() -> pd.DataFrame:
 @log
 def _resolve_gateway_id(gateway: str | UUID) -> UUID:
 
-    dfG = list_gateways()
     if _is_valid_uuid(gateway):
-        dfG_filt = dfG[dfG["Gateway Id"] == gateway]
+        return gateway
     else:
+        dfG = list_gateways()
         dfG_filt = dfG[dfG["Gateway Name"] == gateway]
 
-    if len(dfG_filt) == 0:
-        raise ValueError(f"{icons.red_dot} The '{gateway}' does not exist.")
+        if dfG_filt.empty:
+            raise ValueError(f"{icons.red_dot} The '{gateway}' gateway does not exist.")
 
-    return dfG_filt["Gateway Id"].iloc[0]
+        return dfG_filt["Gateway Id"].iloc[0]
 
 
 @log
@@ -472,7 +472,10 @@ def update_vnet_gateway(
 
 @log
 def bind_semantic_model_to_gateway(
-    dataset: str | UUID, gateway: str | UUID, workspace: Optional[str | UUID] = None
+    dataset: str | UUID,
+    gateway: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    data_source_object_ids: Optional[list[UUID]] = None,
 ):
     """
     Binds the specified dataset from the specified workspace to the specified gateway.
@@ -488,9 +491,11 @@ def bind_semantic_model_to_gateway(
     gateway : str | uuid.UUID
         The name or ID of the gateway.
     workspace : str | uuid.UUID, default=None
-        The Fabric workspace name.
+        The 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.
+    data_source_object_ids : list[uuid.UUID], default=None
+        A list of data source object IDs to bind to the gateway.
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
@@ -502,6 +507,8 @@ def bind_semantic_model_to_gateway(
     payload = {
         "gatewayObjectId": gateway_id,
     }
+    if data_source_object_ids is not None:
+        payload["datasourceObjectIds"] = data_source_object_ids
 
     _base_api(
         request=f"/v1.0/myorg/groups/{workspace_id}/datasets/{dataset_id}/Default.BindToGateway",