list item conn

Author: m-kovalsky

src/sempy_labs/_connections.py

@@ -1,17 +1,18 @@
 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,
     resolve_item_id,
 )
 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