semantic-link-labs 0.10.1__py3-none-any.whl → 0.11.1__py3-none-any.whl

sempy_labs/admin/_git.py

@@ -4,8 +4,10 @@ from sempy_labs._helper_functions import (
 )
 import pandas as pd
 from sempy_labs.admin._basic_functions import list_workspaces
+from sempy._utils._log import log
 
 
+@log
 def list_git_connections() -> pd.DataFrame:
     """
     Shows a list of Git connections.
@@ -38,6 +40,7 @@ def list_git_connections() -> pd.DataFrame:
         uses_pagination=True,
     )
 
+    dfs = []
     for r in responses:
         for v in r.get("value", []):
             git = v.get("gitProviderDetails", {})
@@ -52,16 +55,18 @@ def list_git_connections() -> pd.DataFrame:
                 "Directory Name": git.get("directoryName"),
             }
 
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            dfs.append(pd.DataFrame(new_data, index=[0]))
 
-    dfW = list_workspaces()
-    df = pd.merge(
-        df, dfW[["Id", "Name"]], left_on="Workspace Id", right_on="Id", how="left"
-    )
-    new_col_name = "Workspace Name"
-    df = df.rename(columns={"Name": new_col_name})
-    df.insert(1, new_col_name, df.pop(new_col_name))
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
+        dfW = list_workspaces()
+        df = pd.merge(
+            df, dfW[["Id", "Name"]], left_on="Workspace Id", right_on="Id", how="left"
+        )
+        new_col_name = "Workspace Name"
+        df = df.rename(columns={"Name": new_col_name})
+        df.insert(1, new_col_name, df.pop(new_col_name))
 
-    df = df.drop(columns=["Id"])
+        df = df.drop(columns=["Id"])
 
     return df

sempy_labs/admin/_items.py

@@ -14,8 +14,10 @@ from sempy_labs._helper_functions import (
     _base_api,
     _create_dataframe,
 )
+from sempy._utils._log import log
 
 
+@log
 def _resolve_item_id(
     item: str,
     type: Optional[str] = None,
@@ -39,6 +41,7 @@ def _resolve_item_id(
     return item_id
 
 
+@log
 def _resolve_item_name_and_id(
     item: str,
     type: Optional[str] = None,
@@ -70,6 +73,7 @@ def _resolve_item_name_and_id(
     return item_name, item_id
 
 
+@log
 def list_items(
     capacity: Optional[str | UUID] = None,
     workspace: Optional[str | UUID] = None,
@@ -146,6 +150,7 @@ def list_items(
 
     responses = _base_api(request=url, client="fabric_sp", uses_pagination=True)
 
+    dfs = []
     for r in responses:
         for v in r.get("itemEntities", []):
             new_data = {
@@ -166,7 +171,10 @@ def list_items(
                 "Workspace Id": v.get("workspaceId"),
                 "Capacity Id": v.get("capacityId"),
             }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            dfs.append(pd.DataFrame(new_data, index=[0]))
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
 
     if item is not None:
         if _is_valid_uuid(item):
@@ -177,6 +185,7 @@ def list_items(
     return df
 
 
+@log
 def list_item_access_details(
     item: str | UUID = None,
     type: str = None,
@@ -241,6 +250,7 @@ def list_item_access_details(
         client="fabric_sp",
     )
 
+    dfs = []
     for v in response.json().get("accessDetails", []):
         new_data = {
             "User Id": v.get("principal", {}).get("id"),
@@ -257,6 +267,9 @@ def list_item_access_details(
             "Item Name": item_name,
             "Item Id": item_id,
         }
-        df = pd.concat([df, pd.DataFrame([new_data])], ignore_index=True)
+        dfs.append(pd.DataFrame(new_data, index=[0]))
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
 
     return df

sempy_labs/admin/_reports.py

@@ -8,8 +8,10 @@ from sempy_labs._helper_functions import (
 )
 from uuid import UUID
 import sempy_labs._icons as icons
+from sempy._utils._log import log
 
 
+@log
 def list_reports(
     top: Optional[int] = None,
     skip: Optional[int] = None,
@@ -67,37 +69,36 @@ def list_reports(
 
     url.rstrip("$").rstrip("?")
     response = _base_api(request=url, client="fabric_sp")
-    rows = []
 
+    dfs = []
     for v in response.json().get("value", []):
-        rows.append(
-            {
-                "Report Id": v.get("id"),
-                "Report Name": v.get("name"),
-                "Type": v.get("reportType"),
-                "Web URL": v.get("webUrl"),
-                "Embed URL": v.get("embedUrl"),
-                "Dataset Id": v.get("datasetId"),
-                "Created Date": v.get("createdDateTime"),
-                "Modified Date": v.get("modifiedDateTime"),
-                "Created By": v.get("createdBy"),
-                "Modified By": v.get("modifiedBy"),
-                "Sensitivity Label Id": v.get("sensitivityLabel", {}).get("labelId"),
-                "Users": v.get("users"),
-                "Subscriptions": v.get("subscriptions"),
-                "Workspace Id": v.get("workspaceId"),
-                "Report Flags": v.get("reportFlags"),
-            }
-        )
-
-    if rows:
-        df = pd.DataFrame(rows, columns=list(columns.keys()))
-
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+        new_data = {
+            "Report Id": v.get("id"),
+            "Report Name": v.get("name"),
+            "Type": v.get("reportType"),
+            "Web URL": v.get("webUrl"),
+            "Embed URL": v.get("embedUrl"),
+            "Dataset Id": v.get("datasetId"),
+            "Created Date": v.get("createdDateTime"),
+            "Modified Date": v.get("modifiedDateTime"),
+            "Created By": v.get("createdBy"),
+            "Modified By": v.get("modifiedBy"),
+            "Sensitivity Label Id": v.get("sensitivityLabel", {}).get("labelId"),
+            "Users": v.get("users"),
+            "Subscriptions": v.get("subscriptions"),
+            "Workspace Id": v.get("workspaceId"),
+            "Report Flags": v.get("reportFlags"),
+        }
+        dfs.append(pd.DataFrame(new_data, index=[0]))
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
 
+@log
 def _resolve_report_id(report: str | UUID) -> str:
     if _is_valid_uuid(report):
         return report
@@ -109,6 +110,7 @@ def _resolve_report_id(report: str | UUID) -> str:
         return df_filt["Report Id"].iloc[0]
 
 
+@log
 def list_report_users(report: str | UUID) -> pd.DataFrame:
     """
     Shows a list of users that have access to the specified report.
@@ -144,27 +146,26 @@ def list_report_users(report: str | UUID) -> pd.DataFrame:
     url = f"/v1.0/myorg/admin/reports/{report_id}/users"
     response = _base_api(request=url, client="fabric_sp")
 
-    rows = []
+    dfs = []
     for v in response.json().get("value", []):
-        rows.append(
-            {
-                "User Name": v.get("displayName"),
-                "Email Address": v.get("emailAddress"),
-                "Report User Access Right": v.get("reportUserAccessRight"),
-                "Identifier": v.get("identifier"),
-                "Graph Id": v.get("graphId"),
-                "Principal Type": v.get("principalType"),
-            }
-        )
-
-    if rows:
-        df = pd.DataFrame(rows, columns=list(columns.keys()))
-
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+        new_data = {
+            "User Name": v.get("displayName"),
+            "Email Address": v.get("emailAddress"),
+            "Report User Access Right": v.get("reportUserAccessRight"),
+            "Identifier": v.get("identifier"),
+            "Graph Id": v.get("graphId"),
+            "Principal Type": v.get("principalType"),
+        }
+        dfs.append(pd.DataFrame(new_data, index=[0]))
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
 
+@log
 def list_report_subscriptions(report: str | UUID) -> pd.DataFrame:
     """
     Shows a list of report subscriptions along with subscriber details. This is a preview API call.
@@ -210,30 +211,28 @@ def list_report_subscriptions(report: str | UUID) -> pd.DataFrame:
         client="fabric_sp",
     )
 
-    rows = []
+    dfs = []
     for v in response.json().get("value", []):
-        rows.append(
-            {
-                "Subscription Id": v.get("id"),
-                "Title": v.get("title"),
-                "Artifact Id": v.get("artifactId"),
-                "Artifact Name": v.get("artifactDisplayName"),
-                "Sub Artifact Name": v.get("subArtifactDisplayName"),
-                "Artifact Type": v.get("artifactType"),
-                "Is Enabled": v.get("isEnabled"),
-                "Frequency": v.get("frequency"),
-                "Start Date": v.get("startDate"),
-                "End Date": v.get("endDate"),
-                "Link To Content": v.get("linkToContent"),
-                "Preview Image": v.get("previewImage"),
-                "Attachment Format": v.get("attachmentFormat"),
-                "Users": str(v.get("users")),
-            }
-        )
-
-    if rows:
-        df = pd.DataFrame(rows, columns=list(columns.keys()))
-
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+        new_data = {
+            "Subscription Id": v.get("id"),
+            "Title": v.get("title"),
+            "Artifact Id": v.get("artifactId"),
+            "Artifact Name": v.get("artifactDisplayName"),
+            "Sub Artifact Name": v.get("subArtifactDisplayName"),
+            "Artifact Type": v.get("artifactType"),
+            "Is Enabled": v.get("isEnabled"),
+            "Frequency": v.get("frequency"),
+            "Start Date": v.get("startDate"),
+            "End Date": v.get("endDate"),
+            "Link To Content": v.get("linkToContent"),
+            "Preview Image": v.get("previewImage"),
+            "Attachment Format": v.get("attachmentFormat"),
+            "Users": str(v.get("users")),
+        }
+        dfs.append(pd.DataFrame(new_data, index=[0]))
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df

sempy_labs/admin/_shared.py

@@ -3,8 +3,10 @@ from sempy_labs._helper_functions import (
     _base_api,
     _create_dataframe,
 )
+from sempy._utils._log import log
 
 
+@log
 def list_widely_shared_artifacts(
     api_name: str = "LinksSharedToWholeOrganization",
 ) -> pd.DataFrame:
@@ -55,6 +57,7 @@ def list_widely_shared_artifacts(
         uses_pagination=True,
     )
 
+    dfs = []
     for r in responses:
         for v in r.get("ArtifactAccessEntities", []):
             sharer = v.get("sharer", {})
@@ -71,6 +74,9 @@ def list_widely_shared_artifacts(
                 "Sharer Principal Type": sharer.get("principalType"),
             }
 
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            dfs.append(pd.DataFrame(new_data, index=[0]))
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
 
     return df

sempy_labs/admin/_tags.py

@@ -6,8 +6,10 @@ from uuid import UUID
 from sempy_labs._tags import list_tags
 import sempy_labs._icons as icons
 from typing import List
+from sempy._utils._log import log
 
 
+@log
 def resolve_tag_id(tag: str | UUID):
 
     if _is_valid_uuid(tag):
@@ -22,6 +24,7 @@ def resolve_tag_id(tag: str | UUID):
     return tag_id
 
 
+@log
 def create_tags(tags: str | List[str]):
     """
     Creates a new tag or tags.
@@ -77,6 +80,7 @@ def create_tags(tags: str | List[str]):
     print(f"{icons.green_dot} The '{available_tags}' tag(s) have been created.")
 
 
+@log
 def delete_tag(tag: str | UUID):
     """
     Deletes a tag.
@@ -98,6 +102,7 @@ def delete_tag(tag: str | UUID):
     print(f"{icons.green_dot} The '{tag}' tag has been deleted.")
 
 
+@log
 def update_tag(name: str, tag: str | UUID):
     """
     Updates the name of a tag.

sempy_labs/admin/_tenant.py

@@ -38,6 +38,7 @@ def list_tenant_settings() -> pd.DataFrame:
 
     response = _base_api(request="/v1/admin/tenantsettings", client="fabric_sp")
 
+    dfs = []
     for i in response.json().get("value", []):
         new_data = {
             "Setting Name": i.get("settingName"),
@@ -47,9 +48,11 @@ def list_tenant_settings() -> pd.DataFrame:
             "Tenant Setting Group": i.get("tenantSettingGroup"),
             "Enabled Security Groups": [i.get("enabledSecurityGroups", [])],
         }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+        dfs.append(pd.DataFrame(new_data, index=[0]))
 
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 

sempy_labs/admin/_users.py

@@ -5,8 +5,10 @@ from sempy_labs._helper_functions import (
 )
 from uuid import UUID
 import pandas as pd
+from sempy._utils._log import log
 
 
+@log
 def list_access_entities(
     user_email_address: str,
 ) -> pd.DataFrame:
@@ -43,6 +45,7 @@ def list_access_entities(
         uses_pagination=True,
     )
 
+    dfs = []
     for r in responses:
         for v in r.get("accessEntities", []):
             new_data = {
@@ -54,11 +57,15 @@ def list_access_entities(
                     "additionalPermissions"
                 ),
             }
-            df = pd.concat([df, pd.DataFrame([new_data])], ignore_index=True)
+            dfs.append(pd.DataFrame(new_data, index=[0]))
+
+    if dfs:
+        df = pd.concat(dfs, ignore_index=True)
 
     return df
 
 
+@log
 def list_user_subscriptions(user: str | UUID) -> pd.DataFrame:
     """
     Shows a list of subscriptions for the specified user. This is a preview API call.
@@ -127,7 +134,6 @@ def list_user_subscriptions(user: str | UUID) -> pd.DataFrame:
 
     if rows:
         df = pd.DataFrame(rows, columns=list(columns.keys()))
-
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df

sempy_labs/admin/_workspaces.py

@@ -2,15 +2,21 @@ from sempy_labs._helper_functions import (
     _base_api,
     _build_url,
     _encode_user,
+    _update_dataframe_datatypes,
+    _create_dataframe,
 )
+
 from uuid import UUID
 from typing import Optional
 from sempy_labs.admin._basic_functions import (
     _resolve_workspace_name_and_id,
 )
 import sempy_labs._icons as icons
+import pandas as pd
+from sempy._utils._log import log
 
 
+@log
 def add_user_to_workspace(
     user: str | UUID,
     role: str = "Member",
@@ -68,6 +74,7 @@ def add_user_to_workspace(
     )
 
 
+@log
 def delete_user_from_workspace(
     user: str | UUID,
     workspace: Optional[str | UUID] = None,
@@ -116,6 +123,7 @@ def delete_user_from_workspace(
     )
 
 
+@log
 def restore_deleted_workspace(workspace_id: UUID, name: str, email_address: str):
     """
     Restores a deleted workspace.
@@ -146,3 +154,83 @@ def restore_deleted_workspace(workspace_id: UUID, name: str, email_address: str)
     print(
         f"{icons.green_dot} The '{workspace_id}' workspace has been restored as '{name}'."
     )
+
+
+@log
+def list_orphaned_workspaces(top: int = 100) -> pd.DataFrame:
+    """
+    Shows a list of orphaned workspaces (those with no users or no admins).
+
+    This is a wrapper function for the following API:
+    `Admin - Groups ListGroupsAsAdmin <https://learn.microsoft.com/rest/api/power-bi/admin/groups-get-groups-as-admin>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    top : int, default=100
+        The maximum number of results to return.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing a list of orphaned workspaces.
+    """
+
+    # column structure with proper data types
+    columns = {
+        "Workspace Name": "string",
+        "Workspace Id": "string",
+        "Type": "string",
+        "State": "string",
+        "Is Read Only": "bool",
+        "Is On Dedicated Capacity": "bool",
+        "Capacity Migration Status": "string",
+        "Has Workspace Level Settings": "bool",
+        "Users": "list",
+    }
+
+    df = _create_dataframe(columns=columns)
+
+    url = (
+        "/v1.0/myorg/admin/groups?"
+        "$expand=users&"
+        "$filter=(not users/any()) or "
+        "(not users/any(u: u/groupUserAccessRight eq Microsoft.PowerBI.ServiceContracts.Api.GroupUserAccessRight'Admin'))&"
+        f"$top={top}"
+    )
+
+    response = _base_api(request=url, client="fabric_sp")
+    values = response.json().get("value", [])
+    df_raw = pd.json_normalize(values)
+
+    # friendly names and reorder
+    if not df_raw.empty:
+        df_raw = df_raw.rename(
+            columns={
+                "name": "Workspace Name",
+                "id": "Workspace Id",
+                "type": "Type",
+                "state": "State",
+                "isReadOnly": "Is Read Only",
+                "isOnDedicatedCapacity": "Is On Dedicated Capacity",
+                "capacityMigrationStatus": "Capacity Migration Status",
+                "hasWorkspaceLevelSettings ": "Has Workspace Level Settings",  # Note the space in original
+                "users": "Users",
+            }
+        )
+
+        df = df_raw[list(columns.keys())].copy()
+
+        # Convert empty lists to a more readable format for Users column
+        if "Users" in df.columns:
+            df["Users"] = df["Users"].apply(
+                lambda x: x if (x is not None and len(x) > 0) else []
+            )
+    else:
+        df = _create_dataframe(columns=columns)
+
+    # proper data types
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df

sempy_labs/directlake/_dl_helper.py

@@ -13,6 +13,7 @@ from sempy_labs._helper_functions import (
 )
 
 
+@log
 def check_fallback_reason(
     dataset: str | UUID, workspace: Optional[str | UUID] = None
 ) -> pd.DataFrame:
@@ -195,6 +196,7 @@ def generate_direct_lake_semantic_model(
         refresh_semantic_model(dataset=dataset, workspace=workspace_id)
 
 
+@log
 def get_direct_lake_source(
     dataset: str | UUID, workspace: Optional[str | UUID] = None
 ) -> Tuple[str, str, UUID, UUID]:

sempy_labs/directlake/_generate_shared_expression.py

@@ -8,8 +8,10 @@ from sempy_labs._helper_functions import (
 from typing import Optional
 import sempy_labs._icons as icons
 from uuid import UUID
+from sempy._utils._log import log
 
 
+@log
 def generate_shared_expression(
     item_name: Optional[str] = None,
     item_type: str = "Lakehouse",

sempy_labs/directlake/_get_directlake_lakehouse.py

@@ -1,16 +1,14 @@
 import sempy.fabric as fabric
 from sempy_labs._helper_functions import (
     resolve_lakehouse_id,
-    resolve_lakehouse_name,
-    get_direct_lake_sql_endpoint,
-    resolve_workspace_name_and_id,
-    resolve_dataset_name_and_id,
 )
 from typing import Optional, Tuple
 from uuid import UUID
 import sempy_labs._icons as icons
+from sempy._utils._log import log
 
 
+@log
 def get_direct_lake_lakehouse(
     dataset: str | UUID,
     workspace: Optional[str | UUID] = None,

sempy_labs/directlake/_get_shared_expression.py

@@ -1,7 +1,9 @@
 from typing import Optional
 from uuid import UUID
+from sempy._utils._log import log
 
 
+@log
 def get_shared_expression(
     lakehouse: Optional[str] = None, workspace: Optional[str | UUID] = None
 ) -> str:

sempy_labs/directlake/_guardrails.py

@@ -6,8 +6,10 @@ from uuid import UUID
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
 )
+from sempy._utils._log import log
 
 
+@log
 def get_direct_lake_guardrails() -> pd.DataFrame:
     """
     Shows the guardrails for when Direct Lake semantic models will fallback to Direct Query

sempy_labs/directlake/_update_directlake_model_lakehouse_connection.py

@@ -13,6 +13,7 @@ from uuid import UUID
 import re
 
 
+@log
 def _extract_expression_list(expression):
     """
     Finds the pattern for DL/SQL & DL/OL expressions in the semantic model.
@@ -37,6 +38,7 @@ def _extract_expression_list(expression):
     return result
 
 
+@log
 def _get_direct_lake_expressions(
     dataset: str | UUID, workspace: Optional[str | UUID] = None
 ) -> dict:

sempy_labs/directlake/_warm_cache.py

@@ -182,6 +182,7 @@ def warm_direct_lake_cache_isresident(
     )
 
 
+@log
 def _put_columns_into_memory(dataset, workspace, col_df, return_dataframe: bool = True):
 
     row_limit = 1000000