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

sempy_labs/report/_report_functions.py

@@ -19,6 +19,7 @@ from .._helper_functions import (
     _create_spark_session,
     _mount,
     resolve_workspace_id,
+    resolve_item_name_and_id,
 )
 from typing import List, Optional, Union
 from sempy._utils._log import log
@@ -33,14 +34,14 @@ def get_report_json(
     save_to_file_name: Optional[str] = None,
 ) -> dict:
     """
-    Gets the report.json file content of a Power BI report.
+    Gets the report.json file content of a Power BI report. This function only supports reports in the PBIR-Legacy format.
 
     This is a wrapper function for the following API: `Items - Get Report Definition <https://learn.microsoft.com/rest/api/fabric/report/items/get-report-definition>`_.
 
     Parameters
     ----------
-    report : str
-        Name of the Power BI report.
+    report : str | uuid.UUID
+        Name or ID of the Power BI report.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID in which the report exists.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -55,20 +56,27 @@ def get_report_json(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    report_id = resolve_report_id(report=report, workspace=workspace_id)
-    fmt = "PBIR-Legacy"
+    (report_name, report_id) = resolve_item_name_and_id(
+        item=report, type="Report", workspace=workspace_id
+    )
 
     result = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/reports/{report_id}/getDefinition?format={fmt}",
+        request=f"/v1/workspaces/{workspace_id}/reports/{report_id}/getDefinition",
         method="post",
         lro_return_json=True,
         status_codes=None,
     )
-    df_items = pd.json_normalize(result["definition"]["parts"])
-    df_items_filt = df_items[df_items["path"] == "report.json"]
-    payload = df_items_filt["payload"].iloc[0]
-    report_file = _decode_b64(payload)
-    report_json = json.loads(report_file)
+    report_json = None
+    for part in result.get("definition", {}).get("parts", {}):
+        if part.get("path") == "report.json":
+            payload = part.get("payload")
+            report_file = _decode_b64(payload)
+            report_json = json.loads(report_file)
+
+    if not report_json:
+        raise ValueError(
+            f"{icons.red_dot} Unable to retrieve report.json for the '{report_name}' report within the '{workspace_name}' workspace. This function only supports reports in the PBIR-Legacy format."
+        )
 
     if save_to_file_name is not None:
         if not lakehouse_attached():

sempy_labs/report/_report_rebind.py

@@ -1,7 +1,6 @@
-from .._helper_functions import (
-    resolve_dataset_id,
+from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    resolve_report_id,
+    resolve_item_name_and_id,
     _base_api,
     resolve_dataset_name_and_id,
 )
@@ -23,12 +22,14 @@ def report_rebind(
 
     This is a wrapper function for the following API: `Reports - Rebind Report In Group <https://learn.microsoft.com/rest/api/power-bi/reports/rebind-report-in-group>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
-    report : str | List[str]
-        Name(s) of the Power BI report(s).
-    dataset : str
-        Name of the semantic model.
+    report : str | uuid.UUID | List[str | uuid.UUID]
+        Name(s) or ID(s) of the Power BI report(s).
+    dataset : str | uuid.UUID
+        Name or ID of the semantic model.
     report_workspace : str | uuid.UUID, default=None
         The name or ID of the Fabric workspace in which the report resides.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -46,12 +47,19 @@ def report_rebind(
     if dataset_workspace is None:
         dataset_workspace = report_workspace_name
 
+    (dataset_workspace_name, dataset_workspace_id) = resolve_workspace_name_and_id(
+        dataset_workspace
+    )
     if isinstance(report, str):
         report = [report]
 
     for rpt in report:
-        report_id = resolve_report_id(report=rpt, workspace=report_workspace_id)
-        dataset_id = resolve_dataset_id(dataset=dataset, workspace=dataset_workspace)
+        (report_name, report_id) = resolve_item_name_and_id(
+            item=rpt, type="Report", workspace=report_workspace_id
+        )
+        (dataset_name, dataset_id) = resolve_item_name_and_id(
+            item=dataset, type="SemanticModel", workspace=dataset_workspace
+        )
 
         payload = {"datasetId": dataset_id}
 
@@ -59,10 +67,11 @@ def report_rebind(
             request=f"v1.0/myorg/groups/{report_workspace_id}/reports/{report_id}/Rebind",
             method="post",
             payload=payload,
+            client="fabric_sp",
         )
 
         print(
-            f"{icons.green_dot} The '{rpt}' report has been successfully rebinded to the '{dataset}' semantic model."
+            f"{icons.green_dot} The '{report_name}' report within the '{report_workspace_name}' workspace has been successfully rebinded to the '{dataset_name}' semantic model within the '{dataset_workspace_name}' workspace."
         )
 
 
@@ -77,6 +86,8 @@ def report_rebind_all(
     """
     Rebinds all reports across all workspaces which are bound to a specific semantic model to a new semantic model.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     dataset : str

sempy_labs/report/_reportwrapper.py

@@ -2083,7 +2083,7 @@ class ReportWrapper:
             item for item in custom_visuals if item not in cv_remove
         ]
         self.set_json(
-            file_path=self._report_path,
+            file_path=self._report_file_path,
             json_path=json_path,
             json_value=updated_custom_visuals,
         )

sempy_labs/theme/_org_themes.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,
     _update_dataframe_datatypes,
@@ -9,6 +9,7 @@ from .._helper_functions import (
 
 
 _pbi_url_prefix = None
+_theme_url_prefix = "metadata/v202409/organization/themes"
 
 
 def init_pbi_url_prefix():
@@ -44,7 +45,7 @@ def list_org_themes() -> pd.DataFrame:
 
     df = _create_dataframe(columns=columns)
 
-    response = _base_api(request=f"{_pbi_url_prefix}/metadata/organization/themes")
+    response = _base_api(request=f"{_pbi_url_prefix}/{_theme_url_prefix}")
 
     result = response.json().get("orgThemes")
     if result:
@@ -110,9 +111,7 @@ def get_org_theme_json(theme: str | UUID) -> dict:
     init_pbi_url_prefix()
 
     theme_id = resolve_theme_id(theme)
-    response = _base_api(
-        request=f"{_pbi_url_prefix}/metadata/organization/themes/{theme_id}"
-    )
+    response = _base_api(request=f"{_pbi_url_prefix}/{_theme_url_prefix}/{theme_id}")
     return response.json().get("themeJson", {})
 
 
@@ -124,7 +123,7 @@ def delete_org_theme(theme: str | UUID) -> None:
 
     theme_id = resolve_theme_id(theme)
     _base_api(
-        request=f"{_pbi_url_prefix}/metadata/organization/themes/{theme_id}",
+        request=f"{_pbi_url_prefix}/{_theme_url_prefix}/{theme_id}",
         method="delete",
         status_codes=204,
     )

sempy_labs/tom/_model.py

@@ -1200,7 +1200,7 @@ class TOMWrapper:
         entity_name: str,
         expression: Optional[str] = None,
         description: Optional[str] = None,
-        schema_name: str = "dbo",
+        schema_name: str = None,
     ):
         """
         Adds an entity partition to a table within a semantic model.
@@ -1216,7 +1216,7 @@ class TOMWrapper:
             Defaults to None which resolves to the 'DatabaseQuery' expression.
         description : str, default=None
             A description for the partition.
-        schema_name : str, default="dbo"
+        schema_name : str, default=None
             The schema name.
         """
         import Microsoft.AnalysisServices.Tabular as TOM
@@ -1228,7 +1228,8 @@ class TOMWrapper:
             ep.ExpressionSource = self.model.Expressions["DatabaseQuery"]
         else:
             ep.ExpressionSource = self.model.Expressions[expression]
-        ep.SchemaName = schema_name
+        if schema_name:
+            ep.SchemaName = schema_name
         p = TOM.Partition()
         p.Name = table_name
         p.Source = ep
@@ -1236,6 +1237,10 @@ class TOMWrapper:
         if description is not None:
             p.Description = description
 
+        # For the source lineage tag
+        if schema_name is None:
+            schema_name = "dbo"
+
         self.model.Tables[table_name].Partitions.Add(p)
         self.model.Tables[table_name].SourceLineageTag = (
             f"[{schema_name}].[{entity_name}]"
@@ -5122,25 +5127,14 @@ class TOMWrapper:
             Generates the M expression for the import partition.
             """
 
-            if artifact_type == "Lakehouse":
-                type_id = "lakehouseId"
-            elif artifact_type == "Warehouse":
-                type_id = "warehouseId"
-            else:
-                raise NotImplementedError
-
             full_table_name = (
-                f"{schema_name}.{table_name}" if schema_name else table_name
+                f"{schema_name}/{table_name}" if schema_name else table_name
             )
 
-            return f"""let
-                Source = {artifact_type}.Contents(null),
-                #"Workspace" = Source{{[workspaceId="{workspace_id}"]}}[Data],
-                #"Artifact" = #"Workspace"{{[{type_id}="{artifact_id}"]}}[Data],
-                result = #"Artifact"{{[Id="{full_table_name}",ItemKind="Table"]}}[Data]
-            in
-                result
-            """
+            return f"""let\n\tSource = AzureStorage.DataLake("https://onelake.dfs.fabric.microsoft.com/{workspace_id}/{artifact_id}", [HierarchicalNavigation=true]),
+        Tables = Source{{[Name = "Tables"]}}[Content],
+        ExpressionTable = Tables{{[Name = "{full_table_name}"]}}[Content],
+        ToDelta = DeltaLake.Table(ExpressionTable)\nin\n\tToDelta"""
 
         m_expression = _generate_m_expression(
             source_workspace_id,

sempy_labs/variable_library/__init__.py

@@ -0,0 +1,19 @@
+from ._functions import (
+    get_variable_library,
+    list_variables,
+    list_variable_libraries,
+    delete_variable_library,
+    get_variable_library_definition,
+    get_variable_values,
+    get_variable_value,
+)
+
+__all__ = [
+    "get_variable_library",
+    "list_variables",
+    "list_variable_libraries",
+    "delete_variable_library",
+    "get_variable_library_definition",
+    "get_variable_values",
+    "get_variable_value",
+]

sempy_labs/variable_library/_functions.py

@@ -0,0 +1,403 @@
+from sempy_labs._helper_functions import (
+    resolve_item_id,
+    resolve_workspace_id,
+    _base_api,
+    _create_dataframe,
+    _update_dataframe_datatypes,
+    delete_item,
+    _decode_b64,
+)
+import pandas as pd
+from typing import Any, Optional, List, Union
+from uuid import UUID
+from sempy._utils._log import log
+import json
+import sempy_labs._icons as icons
+
+
+@log
+def get_variable_library(
+    variable_library: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Returns properties of the specified variable library.
+
+    This is a wrapper function for the following API: `Items - Get Variable Library <https://learn.microsoft.com/rest/api/fabric/variablelibrary/items/get-variable-library>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    variable_library : str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the properties of the variable library.
+    """
+
+    columns = {
+        "Variable Library Name": "string",
+        "Variable Library Id": "string",
+        "Description": "string",
+        "Active Value Set Name": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+    variable_library_id = resolve_item_id(
+        item=variable_library, type="VariableLibrary", workspace=workspace
+    )
+
+    response = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/variableLibraries/{variable_library_id}",
+        client="fabric_sp",
+    )
+
+    result = response.json()
+    prop = result.get("properties", {})
+
+    if prop:
+        df = pd.DataFrame(
+            [
+                {
+                    "Variable Library Name": result.get("displayName"),
+                    "Variable Library Id": result.get("id"),
+                    "Description": result.get("description"),
+                    "Active Value Set Name": prop.get("activeValueSetName"),
+                }
+            ],
+            columns=list(columns.keys()),
+        )
+
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def list_variable_libraries(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Shows the variable libraries within a workspace.
+
+    This is a wrapper function for the following API: `Items - List Variable Libraries <https://learn.microsoft.com/rest/api/fabric/variablelibrary/items/list-variable-libraries>`_.
+
+    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
+        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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the variable libraries within a workspace.
+    """
+
+    columns = {
+        "Variable Library Name": "string",
+        "Variable Library Id": "string",
+        "Description": "string",
+        "Active Value Set Name": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/VariableLibraries",
+        uses_pagination=True,
+        client="fabric_sp",
+    )
+
+    rows = []
+    for r in responses:
+        for v in r.get("value", []):
+            prop = v.get("properties", {})
+
+            rows.append(
+                {
+                    "Variable Library Name": v.get("displayName"),
+                    "Variable Library Id": v.get("id"),
+                    "Description": v.get("description"),
+                    "Active Value Set Name": prop.get("activeValueSetName"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def delete_variable_library(
+    variable_library: str | UUID, workspace: Optional[str | UUID] = None
+):
+    """
+    Deletes a variable library.
+
+    This is a wrapper function for the following API: `Items - Delete Variable Library https://learn.microsoft.com/rest/api/fabric/variablelibrary/items/delete-variable-library>`_.
+
+    Parameters
+    ----------
+    navariable_libraryme: str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+    """
+
+    delete_item(item=variable_library, type="VariableLibrary", workspace=workspace)
+
+
+@log
+def get_variable_library_definition(
+    variable_library: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    decode: bool = True,
+    return_dataframe: bool = False,
+) -> dict | pd.DataFrame:
+    """
+    Gets the definition of a variable library.
+
+    This is a wrapper function for the following API: `Items - Get Variable Library Definition <https://learn.microsoft.com/rest/api/fabric/variablelibrary/items/delete-variable-library>`_.
+
+    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
+        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.
+
+    Returns
+    -------
+    dict | pandas.DataFrame
+        A dictionary showing the definition or a pandas dataframe showing the definition.
+    """
+
+    workspace_id = resolve_workspace_id(workspace)
+    variable_library_id = resolve_item_id(
+        item=variable_library, type="VariableLibrary", workspace=workspace
+    )
+
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/variableLibraries/{variable_library_id}/getDefinition",
+        method="post",
+        client="fabric_sp",
+        status_codes=None,
+        lro_return_json=True,
+    )
+
+    if decode:
+        definition = {"definition": {"parts": []}}
+
+        for part in result.get("definition", {}).get("parts", []):
+            path = part.get("path")
+            payload = _decode_b64(part.get("payload"))
+            definition["definition"]["parts"].append({"path": path, "payload": payload})
+    else:
+        definition = result.copy()
+
+    if return_dataframe:
+        df = pd.DataFrame(definition["definition"]["parts"])
+        df.columns = ["Path", "Payload", "Payload Type"]
+        return df
+    else:
+        return definition
+
+
+@log
+def list_variables(
+    variable_library: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Lists the variables in a variable library.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    variable_library : str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the variables within a variable library.
+    """
+
+    result = get_variable_library_definition(
+        variable_library=variable_library,
+        workspace=workspace,
+        decode=True,
+        return_dataframe=False,
+    )
+
+    columns = {
+        "Variable Name": "string",
+        "Note": "string",
+        "Type": "string",
+        "Value": "string",
+    }
+
+    df = _create_dataframe(columns=columns)
+
+    rows = []
+    for part in result.get("definition").get("parts"):
+        path = part.get("path")
+        payload = json.loads(part.get("payload"))
+        if path == "variables.json":
+
+            for variable in payload.get("variables", []):
+                rows.append(
+                    {
+                        "Variable Name": variable.get("name"),
+                        "Note": variable.get("note"),
+                        "Type": variable.get("type"),
+                        "Value": variable.get("value"),
+                    }
+                )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+
+    for part in result.get("definition", {}).get("parts", []):
+        path = part.get("path")
+        if path.startswith("valueSets") and path.endswith(".json"):
+            payload = json.loads(part.get("payload"))
+            value_set_name = payload.get("name")
+
+            # Initialize the new column with None (or pd.NA)
+            df[value_set_name] = None
+
+            for override in payload.get("variableOverrides", []):
+                variable_name = override.get("name")
+                variable_value = override.get("value")
+
+                # Set the value in the appropriate row and column
+                df.loc[df["Variable Name"] == variable_name, value_set_name] = (
+                    variable_value
+                )
+
+    return df
+
+
+@log
+def get_variable_values(
+    variable_names: List[str],
+    variable_library: Union[str, UUID],
+    workspace: Optional[Union[str, UUID]] = None,
+    value_set: Optional[str] = None,
+) -> dict:
+    """
+    Gets the values of multiple variables from a variable library with a single call to list_variables.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    variable_names : List[str]
+        A list of variable names to retrieve.
+    variable_library : str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+    value_set : str, default=None
+        The name of the value set to use for variable overrides.
+        If None, the active value set of the variable library will be used.
+
+    Returns
+    -------
+    dict
+        Dictionary mapping variable names to their corresponding values.
+    """
+
+    if isinstance(variable_names, str):
+        variable_names = [variable_names]
+
+    if value_set is None:
+        vl_df = get_variable_library(
+            variable_library=variable_library, workspace=workspace
+        )
+        if vl_df.empty:
+            raise ValueError(
+                f"{icons.red_dot} The variable library '{variable_library}' does not exist within the '{workspace}' workspace."
+            )
+        value_set = vl_df["Active Value Set Name"].iloc[0]
+
+    df = list_variables(variable_library=variable_library, workspace=workspace)
+    found_variables = df[df["Variable Name"].isin(variable_names)]
+
+    missing = set(variable_names) - set(found_variables["Variable Name"])
+    if missing:
+        raise ValueError(
+            f"{icons.red_dot} The following variables do not exist in the '{variable_library}' variable library: {', '.join(missing)}"
+        )
+
+    if value_set == "Default value set":
+        value_set = "Value"
+    if value_set not in df.columns:
+        raise ValueError(
+            f"{icons.red_dot} The value set '{value_set}' does not exist in the variable library '{variable_library}' within the '{workspace}' workspace."
+        )
+
+    return dict(zip(found_variables["Variable Name"], found_variables[value_set]))
+
+
+@log
+def get_variable_value(
+    variable_name: str,
+    variable_library: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    value_set: Optional[str] = None,
+) -> Any:
+    """
+    Gets the value of a single variable in a variable library.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    variable_name : str
+        Name of the variable.
+    variable_library : str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+    value_set : str, default=None
+        The name of the value set to use for variable overrides.
+        If None, the active value set of the variable library will be used.
+
+    Returns
+    -------
+    Any
+        The value of the variable.
+    """
+
+    return get_variable_values(
+        variable_names=[variable_name],
+        variable_library=variable_library,
+        workspace=workspace,
+        value_set=value_set,
+    )[variable_name]