semantic-link-labs 0.12.1__py3-none-any.whl → 0.12.3__py3-none-any.whl

sempy_labs/graph/__init__.py

@@ -6,16 +6,25 @@ from ._groups import (
     add_group_owners,
     resolve_group_id,
     renew_group,
+    create_group,
+    delete_group,
+    update_group,
 )
 from ._users import (
     resolve_user_id,
     get_user,
     list_users,
     send_mail,
+    create_user,
+    delete_user,
+    update_user,
 )
 from ._teams import (
     list_teams,
 )
+from ._sensitivity_labels import (
+    list_sensitivity_labels,
+)
 
 __all__ = [
     "list_groups",
@@ -30,4 +39,11 @@ __all__ = [
     "list_users",
     "send_mail",
     "list_teams",
+    "create_user",
+    "create_group",
+    "delete_user",
+    "delete_group",
+    "update_user",
+    "update_group",
+    "list_sensitivity_labels",
 ]

sempy_labs/graph/_groups.py

@@ -1,6 +1,6 @@
 import pandas as pd
 from uuid import UUID
-from .._helper_functions import (
+from sempy_labs._helper_functions import (
     _is_valid_uuid,
     _base_api,
     _create_dataframe,
@@ -8,7 +8,7 @@ from .._helper_functions import (
 )
 from sempy._utils._log import log
 import sempy_labs._icons as icons
-from typing import List, Literal
+from typing import List, Literal, Optional
 
 
 @log
@@ -424,3 +424,158 @@ def renew_group(group: str | UUID):
     )
 
     print(f"{icons.green_dot} The '{group}' group has been renewed.")
+
+
+@log
+def create_group(
+    display_name: str,
+    description: Optional[str] = None,
+    mail_enabled: bool = False,
+    security_enabled: bool = True,
+    mail_nickname: str = None,
+    owners: Optional[str | UUID | List[str | UUID]] = None,
+    members: Optional[str | UUID | List[str | UUID]] = None,
+):
+    """
+    Creates a new group.
+
+    This is a wrapper function for the following API: `Create group <https://learn.microsoft.com/graph/api/group-post-groups>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    display_name : str
+        The name of the group.
+    description : str, optional
+        The description of the group.
+    mail_enabled : bool, default=False
+        Whether the group is mail-enabled.
+    security_enabled : bool, default=True
+        Whether the group is security-enabled.
+    mail_nickname : str, default=None
+        The mail alias for the group.
+    owners : str | uuid.UUID | List[str | uuid.UUID], default=None
+        The owners of the group.
+    members : str | uuid.UUID | List[str | uuid.UUID], default=None
+        The members of the group.
+    """
+    from sempy_labs.graph._users import resolve_user_id
+
+    payload = {
+        "displayName": display_name,
+        "description": description,
+        "mailEnabled": mail_enabled,
+        "securityEnabled": security_enabled,
+        "mailNickname": mail_nickname,
+    }
+
+    if owners:
+        if isinstance(owners, str):
+            owners = [owners]
+        user_list = []
+        for o in owners:
+            user_id = resolve_user_id(o)
+            user_list.append(f"https://graph.microsoft.com/v1.0/users/{user_id}")
+        payload["owners@odata.bind"] = user_list
+    if members:
+        if isinstance(members, str):
+            members = [members]
+        user_list = []
+        for m in members:
+            user_id = resolve_user_id(m)
+            user_list.append(f"https://graph.microsoft.com/v1.0/users/{user_id}")
+        payload["members@odata.bind"] = user_list
+
+    _base_api(
+        request="groups",
+        client="graph",
+        payload=payload,
+        method="post",
+        status_codes=201,
+    )
+
+    print(f"{icons.green_dot} The '{display_name}' group has been created.")
+
+
+@log
+def delete_group(group: str | UUID):
+    """
+    Deletes a group.
+
+    This is a wrapper function for the following API: `Delete group <https://learn.microsoft.com/graph/api/group-delete>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    group : str | uuid.UUID
+        The group name or ID.
+    """
+
+    group_id = resolve_group_id(group)
+
+    _base_api(
+        request=f"groups/{group_id}",
+        client="graph",
+        status_codes=204,
+        method="delete",
+    )
+
+    print(f"{icons.green_dot} The '{group}' group has been deleted successfully.")
+
+
+@log
+def update_group(
+    group: str | UUID,
+    display_name: Optional[str] = None,
+    mail_nickname: Optional[str] = None,
+    description: Optional[str] = None,
+    security_enabled: Optional[bool] = None,
+):
+    """
+    Updates a group's properties.
+
+    This is a wrapper function for the following API: `Update group <https://learn.microsoft.com/en-us/graph/api/group-update>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    group : str | uuid.UUID
+        The group name or ID.
+    display_name : str, default=None
+        The new display name for the group.
+    mail_nickname : str, default=None
+        The new mail nickname for the group.
+    description : str, default=None
+        The new description for the group.
+    security_enabled : bool, default=None
+        Whether the group is security-enabled.
+    """
+
+    group_id = resolve_group_id(group)
+
+    payload = {}
+    if display_name:
+        payload["displayName"] = display_name
+    if mail_nickname:
+        payload["mailNickname"] = mail_nickname
+    if description:
+        payload["description"] = description
+    if security_enabled is not None and isinstance(security_enabled, bool):
+        payload["securityEnabled"] = security_enabled
+
+    if not payload:
+        print(f"{icons.info} No properties to update.")
+        return
+
+    _base_api(
+        request=f"groups/{group_id}",
+        client="graph",
+        status_codes=204,
+        payload=payload,
+        method="patch",
+    )
+
+    print(f"{icons.green_dot} The '{group}' group has been updated successfully.")

sempy_labs/graph/_sensitivity_labels.py

@@ -0,0 +1,81 @@
+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,
+)
+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

sempy_labs/graph/_users.py

@@ -301,3 +301,165 @@ def send_mail(
     if attachments:
         printout += f" with {len(attachments)} attachment(s)"
     print(f"{printout}.")
+
+
+@log
+def create_user(
+    display_name: str,
+    user_principal_name: str,
+    mail_nickname: str,
+    password: str,
+    account_enabled: bool = True,
+    force_change_password_next_sign_in: bool = True,
+):
+    """
+    Creates a new user.
+
+    This is a wrapper function for the following API: `Create User <https://learn.microsoft.com/graph/api/user-post-users>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    display_name : str
+        The name to display in the address book for the user.
+    user_principal_name : str
+        The user principal name (someuser@contoso.com).
+    mail_nickname : str
+        The mail alias for the user.
+    password : str
+        The initial password for the user.
+    account_enabled : bool, default=True
+        Whether the account is enabled. Default is True.
+    force_change_password_next_sign_in : bool, default=True
+        Whether the user must change their password on next sign-in. Default is True.
+    """
+
+    payload = {
+        "accountEnabled": account_enabled,
+        "displayName": display_name,
+        "mailNickname": mail_nickname,
+        "userPrincipalName": user_principal_name,
+        "passwordProfile": {
+            "forceChangePasswordNextSignIn": force_change_password_next_sign_in,
+            "password": password,
+        },
+    }
+
+    _base_api(
+        request="users",
+        client="graph",
+        status_codes=201,
+        payload=payload,
+        method="post",
+    )
+
+    print(f"{icons.green_dot} The '{display_name}' user has been created successfully.")
+
+
+@log
+def delete_user(user: str | UUID):
+    """
+    Deletes a user.
+
+    This is a wrapper function for the following API: `Delete User <https://learn.microsoft.com/graph/api/user-delete>`_.
+
+    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 name or ID.
+    """
+
+    user_id = resolve_user_id(user)
+
+    _base_api(
+        request=f"users/{user_id}",
+        client="graph",
+        status_codes=204,
+        method="delete",
+    )
+
+    print(f"{icons.green_dot} The '{user}' user has been deleted successfully.")
+
+
+@log
+def update_user(
+    user: str | UUID,
+    display_name: Optional[str] = None,
+    user_principal_name: Optional[str] = None,
+    given_name: Optional[str] = None,
+    surname: Optional[str] = None,
+    job_title: Optional[str] = None,
+    mail_nickname: Optional[str] = None,
+    my_site: Optional[str] = None,
+    office_location: Optional[str] = None,
+    account_enabled: Optional[bool] = None,
+):
+    """
+    Updates a user's properties.
+
+    This is a wrapper function for the following API: `Update user <https://learn.microsoft.com/graph/api/user-update>`_.
+
+    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 name or ID.
+    display_name : str, default=None
+        The name displayed in the address book for the user.
+    user_principal_name : str, default=None
+        The user principal name (UPN) of the user.
+    given_name : str, default=None
+        The given name (first name) of the user.
+    surname : str, default=None
+        The user's surname (family name or last name).
+    job_title : str, default=None
+        The user's job title.
+    mail_nickname : str, default=None
+        The mail alias for the user. This property must be specified when a user is created.
+    my_site : str, default=None
+        The URL for the user's personal site.
+    office_location : str, default=None
+        The office location in the user's place of business.
+    account_enabled : bool, default=None
+        Whether the account is enabled. If None, the property will not be updated.
+    """
+
+    user_id = resolve_user_id(user)
+
+    payload = {}
+    if display_name is not None:
+        payload["displayName"] = display_name
+    if mail_nickname is not None:
+        payload["mailNickname"] = mail_nickname
+    if user_principal_name is not None:
+        payload["userPrincipalName"] = user_principal_name
+    if given_name is not None:
+        payload["givenName"] = given_name
+    if job_title is not None:
+        payload["jobTitle"] = job_title
+    if my_site is not None:
+        payload["mySite"] = my_site
+    if office_location is not None:
+        payload["officeLocation"] = office_location
+    if surname is not None:
+        payload["surname"] = surname
+    if account_enabled is not None and isinstance(account_enabled, bool):
+        payload["accountEnabled"] = account_enabled
+
+    if not payload:
+        print(f"{icons.info} No properties to update.")
+        return
+
+    _base_api(
+        request=f"users/{user_id}",
+        client="graph",
+        status_codes=204,
+        payload=payload,
+        method="patch",
+    )
+
+    print(f"{icons.green_dot} The '{user}' user has been updated successfully.")

sempy_labs/lakehouse/_shortcuts.py

@@ -396,17 +396,22 @@ def list_shortcuts(
             # Cache and use it to getitem type and name
             source_item_type = None
             source_item_name = None
-            dfI = source_items_df[
-                source_items_df["Workspace Id"] == source_workspace_id
-            ]
-            if dfI.empty:
-                dfI = fabric.list_items(workspace=source_workspace_id)
-                source_items_df = pd.concat([source_items_df, dfI], ignore_index=True)
-
-            dfI_filt = dfI[dfI["Id"] == source_item_id]
-            if not dfI_filt.empty:
-                source_item_type = dfI_filt["Type"].iloc[0]
-                source_item_name = dfI_filt["Display Name"].iloc[0]
+            try:
+                dfI = source_items_df[
+                    source_items_df["Workspace Id"] == source_workspace_id
+                ]
+                if dfI.empty:
+                    dfI = fabric.list_items(workspace=source_workspace_id)
+                    source_items_df = pd.concat(
+                        [source_items_df, dfI], ignore_index=True
+                    )
+
+                dfI_filt = dfI[dfI["Id"] == source_item_id]
+                if not dfI_filt.empty:
+                    source_item_type = dfI_filt["Type"].iloc[0]
+                    source_item_name = dfI_filt["Display Name"].iloc[0]
+            except Exception:
+                pass
 
             rows.append(
                 {

sempy_labs/report/_bpareporttemplate/.pbi/localSettings.json

@@ -0,0 +1,9 @@
+{
+  "version": "1.0",
+  "remoteArtifacts": [
+    {
+      "reportId": "6a91c344-dba8-4ebf-bedb-e07134f2a204"
+    }
+  ],
+  "securityBindingsSignature": "AQAAANCMnd8BFdERjHoAwE/Cl+sBAAAAMAVu7l76YU6Sl11KOiJdgQAAAAACAAAAAAAQZgAAAAEAACAAAAD1Ty+c7tZLT9/Sjguxhn/5ivfLWfUMNtgudyJ3BKzzZgAAAAAOgAAAAAIAACAAAABAyGf+iKMwvmNtcoRczjgebeIm0nlc9SFYTBYv3N7yvVADAADQN3JsIsvJUcKKc9WMo2EhiE21odezpd35tb+yudHwA/RYhypMA3fwiCTwArLefBZQ3vZ7KYh4MjihXS07i9o1XVqxAmDoli83Yhs/Wei+0HIfYOT5HOVHLUEul5x41Yx/7Bdfhc881SK6IoaJogBdwsiJVxPne+niMYqJQA6qLEPyJ33g6ucUxLA40lwdbN2cMWFzRn6tymmicDPwH0hcGPDMWwseAU+OuUeidkneRWhUGs6lkiiXLiO6kmY5RKq+S4FdtR19/e1B6EjAd94zSw+M5jQzYxn4eCZzWYiB+8Zd/jy07lfyLoGwagNqiQzbcNONqQd5w0n+8/+n4zGkBi2UojfRXoGaYDirQeZMTbt3pfPx2PArxsJ8dF0iT634pHiCF1ZFdtY+79JaFLUUG+Yf7JJv8IxuuuF74tAp4NYmuOij4hTDaf8Jafa5IoRVh7ICkwrjJyVQ8dG7I3tr0VvR+toBPG3Zlbm9BijcaBxhh1AINhnRAIkENOnPFQVH7l3Ml7B60H8Tst6ic3ihCCMYjtmN+NNWqFrJKT2trilh5TAxN+ei4H5fPwM9S7zb2bH5jhExcYTtoe7iCzxOvBsoYoFM+7FMjn9R2FATNICktYdbKDo1Of+u4oZ1+RsvBHQBVaMhSCoZ7+K5T5pZayNK3V2UID3wOuLOYvouxXXr4NVFsdgiV2oMuxTWeqmd/4bLxeqe3uTkGFmQU4mumF2YVsNbdO3IcRXhhrCCZ27ffzXBsH+lE3EhusD37Z0dsVbVVlG8AHXCh7Atgd8n73/eSI5mvj36DCOSRBVauItIATIa2FXueKA7vU6lRDYBSX8FCC2qkeN6dWpMoN5uXXEBsb5Yot1Fgrovcyl5lk7rh772Xon4FaIYFHZpklsY3JK5EXp3bF8UOE6ByN1ZucmkGgYRcTT/up/Uc86TLN6env9XXL4FQYPlReiOGWKBLVi9OoXGRLDshspniULtV3EwQ6WsjF2AyQ+WdLj3bbWKzG5Mg9jvANLrjycZAGWskh4X5JDGiv4TiJmnYQ/xPZAKKiowpVIHikLeG76uXFI+bxtpihV9+DaEJy4UxisHQxwuvUsQs38u3SHgpJmT8CNssZl41+T/IJdoQwJFLUAAAACnUQZGV9DvcOyrj8HBpXBVB5PuOQDxLB4HZOevHqCB5dc5z787E93B51QmN7I15fF6GCdWwN5f94gv1er2dtN3"
+}

sempy_labs/report/_bpareporttemplate/.platform

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/fabric/gitIntegration/platformProperties/2.0.0/schema.json",
+  "metadata": {
+    "type": "Report",
+    "displayName": "BPAReport"
+  },
+  "config": {
+    "version": "2.0",
+    "logicalId": "a201f2cd-fd25-465f-bfbc-33b151e38b31"
+  }
+}

sempy_labs/report/_reportwrapper.py

@@ -935,9 +935,6 @@ class ReportWrapper:
         """
         Shows a list of all modified `visual interactions <https://learn.microsoft.com/power-bi/create-reports/service-reports-visual-interactions?tabs=powerbi-desktop>`_ used in the report.
 
-        Parameters
-        ----------
-
         Returns
         -------
         pandas.DataFrame
@@ -980,6 +977,56 @@ class ReportWrapper:
 
         return df
 
+    def list_visual_calculations(self) -> pd.DataFrame:
+        """
+        Shows a list of all `visual calculations <https://learn.microsoft.com/power-bi/transform-model/desktop-visual-calculations-overview>`_.
+
+        Returns
+        -------
+        pandas.DataFrame
+            A pandas dataframe containing a list of all visual calculations within the report.
+        """
+
+        self._ensure_pbir()
+
+        columns = {
+            "Page Display Name": "str",
+            "Visual Name": "str",
+            "Name": "str",
+            "Language": "str",
+            "Expression": "str",
+        }
+
+        df = _create_dataframe(columns=columns)
+        visual_mapping = self._visual_page_mapping()
+
+        rows = []
+        for v in self.__all_visuals():
+            path = v.get("path")
+            payload = v.get("payload")
+            page_name = visual_mapping.get(path)[0]
+            page_display_name = visual_mapping.get(path)[1]
+            visual_name = payload.get("name")
+            matches = parse("$..field.NativeVisualCalculation").find(payload)
+            if matches:
+                for match in matches:
+                    m = match.value
+                    rows.append(
+                        {
+                            "Page Display Name": page_display_name,
+                            "Page Name": page_name,
+                            "Visual Name": visual_name,
+                            "Name": m.get("Name"),
+                            "Language": m.get("Language"),
+                            "Expression": m.get("Expression"),
+                        }
+                    )
+
+        if rows:
+            df = pd.DataFrame(rows, columns=list(columns.keys()))
+
+        return df
+
     def list_pages(self) -> pd.DataFrame:
         """
         Shows a list of all pages in the report.
@@ -1651,7 +1698,7 @@ class ReportWrapper:
         bookmarks = [
             o
             for o in self._report_definition.get("parts")
-            if o.get("path").endswith("/bookmark.json")
+            if o.get("path").endswith(".bookmark.json")
         ]
 
         rows = []
@@ -2069,8 +2116,8 @@ class ReportWrapper:
         df = dfCV[dfCV["Used in Report"] == False]
 
         if not df.empty:
-            cv_remove = df["Custom Visual Name"].values()
-            cv_remove_display = df["Custom Visual Display Name"].values()
+            cv_remove = df["Custom Visual Name"].values
+            cv_remove_display = df["Custom Visual Display Name"].values
         else:
             print(
                 f"{icons.red_dot} There are no unnecessary custom visuals in the '{self._report_name}' report within the '{self._workspace_name}' workspace."