semantic-link-labs 0.12.2__py3-none-any.whl → 0.12.4__py3-none-any.whl

sempy_labs/graph/_groups.py

@@ -55,7 +55,7 @@ def list_groups() -> pd.DataFrame:
         A pandas dataframe showing a list of groups and their properties.
     """
 
-    result = _base_api(request="groups", client="graph").json()
+    result = _base_api(request="groups", client="graph", uses_pagination=True)
 
     columns = {
         "Group Id": "string",
@@ -76,24 +76,25 @@ def list_groups() -> pd.DataFrame:
     df = _create_dataframe(columns=columns)
 
     rows = []
-    for v in result.get("value"):
-        rows.append(
-            {
-                "Group Id": v.get("id"),
-                "Group Name": v.get("displayName"),
-                "Mail": v.get("mail"),
-                "Description": v.get("description"),
-                "Classification": v.get("classification"),
-                "Mail Enabled": v.get("mailEnabled"),
-                "Security Enabled": v.get("securityEnabled"),
-                "Created Date Time": v.get("createdDateTime"),
-                "Expiration Date Time": v.get("expirationDateTime"),
-                "Renewed Date Time": v.get("renewedDateTime"),
-                "Deleted Date Time": v.get("deletedDateTime"),
-                "Visibility": v.get("visibility"),
-                "Security Identifier": v.get("securityIdentifier"),
-            }
-        )
+    for r in result:
+        for v in r.get("value", []):
+            rows.append(
+                {
+                    "Group Id": v.get("id"),
+                    "Group Name": v.get("displayName"),
+                    "Mail": v.get("mail"),
+                    "Description": v.get("description"),
+                    "Classification": v.get("classification"),
+                    "Mail Enabled": v.get("mailEnabled"),
+                    "Security Enabled": v.get("securityEnabled"),
+                    "Created Date Time": v.get("createdDateTime"),
+                    "Expiration Date Time": v.get("expirationDateTime"),
+                    "Renewed Date Time": v.get("renewedDateTime"),
+                    "Deleted Date Time": v.get("deletedDateTime"),
+                    "Visibility": v.get("visibility"),
+                    "Security Identifier": v.get("securityIdentifier"),
+                }
+            )
 
     if rows:
         df = pd.DataFrame(rows, columns=list(columns.keys()))
@@ -190,7 +191,9 @@ def list_group_members(group: str | UUID) -> pd.DataFrame:
 
     group_id = resolve_group_id(group)
 
-    result = _base_api(request=f"groups/{group_id}/members", client="graph").json()
+    result = _base_api(
+        request=f"groups/{group_id}/members", client="graph", uses_pagination=True
+    )
 
     columns = {
         "Member Id": "string",
@@ -209,22 +212,23 @@ def list_group_members(group: str | UUID) -> pd.DataFrame:
     df = _create_dataframe(columns=columns)
 
     rows = []
-    for v in result.get("value"):
-        rows.append(
-            {
-                "Member Id": v.get("id"),
-                "Member Name": v.get("displayName"),
-                "User Principal Name": v.get("userPrincipalName"),
-                "Mail": v.get("mail"),
-                "Job Title": v.get("jobTitle"),
-                "Office Location": v.get("officeLocation"),
-                "Mobile Phone": v.get("mobilePhone"),
-                "Business Phones": str(v.get("businessPhones")),
-                "Preferred Language": v.get("preferredLanguage"),
-                "Given Name": v.get("givenName"),
-                "Surname": v.get("surname"),
-            }
-        )
+    for r in result:
+        for v in r.get("value", []):
+            rows.append(
+                {
+                    "Member Id": v.get("id"),
+                    "Member Name": v.get("displayName"),
+                    "User Principal Name": v.get("userPrincipalName"),
+                    "Mail": v.get("mail"),
+                    "Job Title": v.get("jobTitle"),
+                    "Office Location": v.get("officeLocation"),
+                    "Mobile Phone": v.get("mobilePhone"),
+                    "Business Phones": str(v.get("businessPhones")),
+                    "Preferred Language": v.get("preferredLanguage"),
+                    "Given Name": v.get("givenName"),
+                    "Surname": v.get("surname"),
+                }
+            )
 
     if rows:
         df = pd.DataFrame(rows, columns=list(columns.keys()))
@@ -254,7 +258,9 @@ def list_group_owners(group: str | UUID) -> pd.DataFrame:
 
     group_id = resolve_group_id(group)
 
-    result = _base_api(request=f"groups/{group_id}/owners", client="graph").json()
+    result = _base_api(
+        request=f"groups/{group_id}/owners", client="graph", uses_pagination=True
+    )
 
     columns = {
         "Owner Id": "string",
@@ -273,22 +279,23 @@ def list_group_owners(group: str | UUID) -> pd.DataFrame:
     df = _create_dataframe(columns=columns)
 
     rows = []
-    for v in result.get("value"):
-        rows.append(
-            {
-                "Owner Id": v.get("id"),
-                "Owner Name": v.get("displayName"),
-                "User Principal Name": v.get("userPrincipalName"),
-                "Mail": v.get("mail"),
-                "Job Title": v.get("jobTitle"),
-                "Office Location": v.get("officeLocation"),
-                "Mobile Phone": v.get("mobilePhone"),
-                "Business Phones": str(v.get("businessPhones")),
-                "Preferred Language": v.get("preferredLanguage"),
-                "Given Name": v.get("givenName"),
-                "Surname": v.get("surname"),
-            }
-        )
+    for r in result:
+        for v in r.get("value", []):
+            rows.append(
+                {
+                    "Owner Id": v.get("id"),
+                    "Owner Name": v.get("displayName"),
+                    "User Principal Name": v.get("userPrincipalName"),
+                    "Mail": v.get("mail"),
+                    "Job Title": v.get("jobTitle"),
+                    "Office Location": v.get("officeLocation"),
+                    "Mobile Phone": v.get("mobilePhone"),
+                    "Business Phones": str(v.get("businessPhones")),
+                    "Preferred Language": v.get("preferredLanguage"),
+                    "Given Name": v.get("givenName"),
+                    "Surname": v.get("surname"),
+                }
+            )
 
     if rows:
         df = pd.DataFrame(rows, columns=list(columns.keys()))

sempy_labs/graph/_sensitivity_labels.py

@@ -0,0 +1,120 @@
+import pandas as pd
+from uuid import UUID
+from typing import Optional
+from sempy_labs._helper_functions import (
+    _base_api,
+    _create_dataframe,
+    _update_dataframe_datatypes,
+    _is_valid_uuid,
+)
+from sempy._utils._log import log
+
+
+@log
+def list_sensitivity_labels(user: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Get a list of `sensitivity label <https://learn.microsoft.com/graph/api/resources/security-sensitivitylabel>`_ objects associated with a user or organization.
+
+    This is a wrapper function for the following API: `List sensitivityLabels https://learn.microsoft.com/graph/api/security-informationprotection-list-sensitivitylabels>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    user : str | uuid.UUID
+        The user ID or user principal name.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing a list of `sensitivity label <https://learn.microsoft.com/graph/api/resources/security-sensitivitylabel>`_ objects associated with a user or organization.
+    """
+    from sempy_labs.graph import resolve_user_id
+
+    url = "/security/informationProtection/sensitivityLabels"
+
+    if user is not None:
+        user_id = resolve_user_id(user=user)
+        url = f"users/{user_id}{url}"
+
+    result = _base_api(request=url, client="graph").json()
+
+    columns = {
+        "Sensitivity Label Id": "str",
+        "Sensitivity Label Name": "str",
+        "Description": "str",
+        "Color": "str",
+        "Sensitivity": "int",
+        "Tooltip": "str",
+        "Is Active": "bool",
+        "Is Appliable": "bool",
+        "Has Protection": "bool",
+        "Parent Sensitivity Label Id": "str",
+        "Parent Sensitivity Label Name": "str",
+    }
+    df = _create_dataframe(columns=columns)
+
+    rows = []
+    for item in result.get("value", []):
+        row = {
+            "Sensitivity Label Id": item.get("id"),
+            "Sensitivity Label Name": item.get("name"),
+            "Description": item.get("description"),
+            "Color": item.get("color"),
+            "Sensitivity": item.get("sensitivity"),
+            "Tooltip": item.get("tooltip"),
+            "Is Active": item.get("isActive"),
+            "Is Appliable": item.get("isAppliable"),
+            "Has Protection": item.get("hasProtection"),
+            "Parent Sensitivity Label Id": (
+                item.get("parent", {}).get("id") if item.get("parent") else None
+            ),
+            "Parent Sensitivity Label Name": (
+                item.get("parent", {}).get("name") if item.get("parent") else None
+            ),
+        }
+        rows.append(row)
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def resolve_sensitivity_label_id(
+    label: str | UUID, user: Optional[str | UUID] = None
+) -> UUID | None:
+    """
+    Resolve a sensitivity label name or ID to its corresponding sensitivity label ID.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    label : str | uuid.UUID
+        The name or ID of the sensitivity label.
+    user : str | uuid.UUID, default=None
+        The user ID or user principal name.
+
+    Returns
+    -------
+    uuid.UUID | None
+        The ID of the sensitivity label if found, otherwise None.
+    """
+
+    if _is_valid_uuid(label):
+        return str(label)
+
+    df = list_sensitivity_labels(user=user)
+
+    if df.empty:
+        return None
+
+    # Try to find the label by name
+    label_row = df[df["Sensitivity Label Name"] == label]
+    if not label_row.empty:
+        return label_row["Sensitivity Label Id"].iloc[0]
+
+    return None

sempy_labs/graph/_teams.py

@@ -23,7 +23,7 @@ def list_teams() -> pd.DataFrame:
         A pandas dataframe showing a list of teams and their properties.
     """
 
-    result = _base_api(request="teams", client="graph").json()
+    result = _base_api(request="teams", client="graph", uses_pagination=True)
 
     columns = {
         "Team Id": "str",
@@ -43,23 +43,24 @@ def list_teams() -> pd.DataFrame:
     df = _create_dataframe(columns=columns)
 
     rows = []
-    for v in result.get("value"):
-        rows.append(
-            {
-                "Team Id": v.get("id"),
-                "Team Name": v.get("displayName"),
-                "Description": v.get("description"),
-                "Creation Date Time": v.get("createdDateTime"),
-                "Classification": v.get("classification"),
-                "Specialization": v.get("specialization"),
-                "Visibility": v.get("visibility"),
-                "Web Url": v.get("webUrl"),
-                "Archived": v.get("isArchived"),
-                "Favorite By Me": v.get("isFavoriteByMe"),
-                "Discoverable By Me": v.get("isDiscoverableByMe"),
-                "Member Count": v.get("memberCount"),
-            }
-        )
+    for r in result:
+        for v in r.get("value", []):
+            rows.append(
+                {
+                    "Team Id": v.get("id"),
+                    "Team Name": v.get("displayName"),
+                    "Description": v.get("description"),
+                    "Creation Date Time": v.get("createdDateTime"),
+                    "Classification": v.get("classification"),
+                    "Specialization": v.get("specialization"),
+                    "Visibility": v.get("visibility"),
+                    "Web Url": v.get("webUrl"),
+                    "Archived": v.get("isArchived"),
+                    "Favorite By Me": v.get("isFavoriteByMe"),
+                    "Discoverable By Me": v.get("isDiscoverableByMe"),
+                    "Member Count": v.get("memberCount"),
+                }
+            )
 
     if rows:
         df = pd.DataFrame(rows, columns=list(columns.keys()))

sempy_labs/graph/_user_licenses.py

@@ -0,0 +1,96 @@
+from uuid import UUID
+import sempy_labs._icons as icons
+from typing import List, Optional
+from sempy_labs._helper_functions import (
+    _base_api,
+)
+from sempy._utils._log import log
+from sempy_labs.graph._users import resolve_user_id
+
+
+@log
+def add_user_license(
+    user: str | UUID, sku_id: UUID, disabled_plans: Optional[UUID | List[UUID]] = None
+):
+    """
+    Assigns a license to a user.
+
+    This is a wrapper function for the following API: `user: assignLicense <https://learn.microsoft.com/graph/api/user-assignlicense>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    user : str | uuid.UUID
+        The user ID or user principal name.
+    sku_id : uuid.UUID
+        The SKU ID of the license to assign.
+    disabled_plans : Optional[uuid.UUID | List[uuid.UUID]], default=None
+        A single service plan ID or a list of service plan IDs to disable within the assigned license.
+    """
+
+    user_id = resolve_user_id(user)
+
+    payload = {
+        "addLicenses": [
+            {
+                "skuId": sku_id,
+            },
+        ],
+        "removeLicenses": [],
+    }
+
+    if disabled_plans:
+        if isinstance(disabled_plans, str):
+            disabled_plans = [disabled_plans]
+        payload["addLicenses"][0]["disabledPlans"] = disabled_plans
+
+    _base_api(
+        request=f"users/{user_id}/assignLicense",
+        client="graph",
+        method="post",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} The '{sku_id}' license has been assigned to the user '{user}'."
+    )
+
+
+@log
+def remove_user_license(user: str | UUID, sku_ids: UUID | List[UUID]):
+    """
+    Removes a license from a user.
+
+    This is a wrapper function for the following API: `user: assignLicense <https://learn.microsoft.com/graph/api/user-assignlicense>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    user : str | uuid.UUID
+        The user ID or user principal name.
+    sku_id : uuid.UUID
+        The SKU ID of the license to remove.
+    """
+
+    user_id = resolve_user_id(user)
+
+    if isinstance(sku_ids, str):
+        sku_ids = [sku_ids]
+
+    payload = {
+        "addLicenses": [],
+        "removeLicenses": sku_ids,
+    }
+
+    _base_api(
+        request=f"users/{user_id}/assignLicense",
+        client="graph",
+        method="post",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} The '{', '.join([str(s) for s in sku_ids])}' license(s) have been removed from the user '{user}'."
+    )

sempy_labs/graph/_users.py

@@ -8,6 +8,7 @@ from .._helper_functions import (
     _is_valid_uuid,
     _base_api,
     _create_dataframe,
+    _update_dataframe_datatypes,
     _mount,
 )
 from sempy._utils._log import log
@@ -91,7 +92,7 @@ def list_users() -> pd.DataFrame:
         A pandas dataframe showing a list of users and their properties.
     """
 
-    result = _base_api(request="users", client="graph").json()
+    result = _base_api(request="users", client="graph", uses_pagination=True)
 
     columns = {
         "User Id": "string",
@@ -108,21 +109,27 @@ def list_users() -> pd.DataFrame:
 
     df = _create_dataframe(columns=columns)
 
-    for v in result.get("value"):
-        new_data = {
-            "User Id": v.get("id"),
-            "User Principal Name": v.get("userPrincipalName"),
-            "User Name": v.get("displayName"),
-            "Mail": v.get("mail"),
-            "Job Title": v.get("jobTitle"),
-            "Office Location": v.get("officeLocation"),
-            "Mobile Phone": v.get("mobilePhone"),
-            "Business Phones": str(v.get("businessPhones")),
-            "Preferred Language": v.get("preferredLanguage"),
-            "Surname": v.get("surname"),
-        }
-
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+    rows = []
+    for r in result:
+        for v in r.get("value", []):
+            rows.append(
+                {
+                    "User Id": v.get("id"),
+                    "User Principal Name": v.get("userPrincipalName"),
+                    "User Name": v.get("displayName"),
+                    "Mail": v.get("mail"),
+                    "Job Title": v.get("jobTitle"),
+                    "Office Location": v.get("officeLocation"),
+                    "Mobile Phone": v.get("mobilePhone"),
+                    "Business Phones": str(v.get("businessPhones")),
+                    "Preferred Language": v.get("preferredLanguage"),
+                    "Surname": v.get("surname"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 

sempy_labs/lakehouse/_get_lakehouse_tables.py

@@ -33,6 +33,7 @@ def get_lakehouse_tables(
     extended: bool = False,
     count_rows: bool = False,
     export: bool = False,
+    exclude_shortcuts: bool = False,
 ) -> pd.DataFrame:
     """
     Shows the tables of a lakehouse and their respective properties. Option to include additional properties relevant to Direct Lake guardrails.
@@ -60,6 +61,8 @@ def get_lakehouse_tables(
         Obtains a row count for each lakehouse table.
     export : bool, default=False
         Exports the resulting dataframe to a delta table in the lakehouse.
+    exclude_shortcuts : bool, default=False
+        If True, excludes shortcuts.
 
     Returns
     -------
@@ -83,6 +86,9 @@ def get_lakehouse_tables(
         lakehouse=lakehouse, workspace=workspace_id
     )
 
+    # Test if valid lakehouse:
+    x = _base_api(f"v1/workspaces/{workspace_id}/lakehouses/{lakehouse_id}")
+
     if count_rows:  # Setting countrows defaults to extended=True
         extended = True
 
@@ -94,7 +100,7 @@ def get_lakehouse_tables(
             client="fabric_sp",
         )
 
-    except Exception as e:
+    except Exception:
         API_called = False
 
     rows = []
@@ -246,6 +252,32 @@ def get_lakehouse_tables(
         df["Row Count"] = df["Row Count"].astype(int)
         df["Row Count Guardrail Hit"] = df["Row Count"] > df["Row Count Guardrail"]
 
+    if exclude_shortcuts:
+        from sempy_labs.lakehouse._shortcuts import list_shortcuts
+
+        # Exclude shortcuts
+        shortcuts = (
+            list_shortcuts(lakehouse=lakehouse, workspace=workspace)
+            .query("`Shortcut Path`.str.startswith('/Tables')", engine="python")
+            .assign(
+                FullPath=lambda df: df["Shortcut Path"].str.rstrip("/")
+                + "/"
+                + df["Shortcut Name"]
+            )["FullPath"]
+            .tolist()
+        )
+
+        df["FullPath"] = df.apply(
+            lambda x: (
+                f"/Tables/{x['Table Name']}"
+                if pd.isna(x["Schema Name"]) or x["Schema Name"] == ""
+                else f"/Tables/{x['Schema Name']}/{x['Table Name']}"
+            ),
+            axis=1,
+        )
+
+        df = df[~df["FullPath"].isin(shortcuts)].reset_index(drop=True)
+
     if export:
         if not lakehouse_attached():
             raise ValueError(

sempy_labs/lakehouse/_lakehouse.py

@@ -93,7 +93,9 @@ def optimize_lakehouse_tables(
 
     from sempy_labs.lakehouse._get_lakehouse_tables import get_lakehouse_tables
 
-    df = get_lakehouse_tables(lakehouse=lakehouse, workspace=workspace)
+    df = get_lakehouse_tables(
+        lakehouse=lakehouse, workspace=workspace, exclude_shortcuts=True
+    )
     df_delta = df[df["Format"] == "delta"]
 
     if isinstance(tables, str):
@@ -142,7 +144,9 @@ def vacuum_lakehouse_tables(
 
     from sempy_labs.lakehouse._get_lakehouse_tables import get_lakehouse_tables
 
-    df = get_lakehouse_tables(lakehouse=lakehouse, workspace=workspace)
+    df = get_lakehouse_tables(
+        lakehouse=lakehouse, workspace=workspace, exclude_shortcuts=True
+    )
     df_delta = df[df["Format"] == "delta"]
 
     if isinstance(tables, str):