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

sempy_labs/report/_save_report.py

@@ -3,9 +3,9 @@ import base64
 import json
 import sempy.fabric as fabric
 import sempy_labs._icons as icons
-from sempy_labs.report._generate_report import get_report_definition
-from sempy_labs._generate_semantic_model import get_semantic_model_definition
-from sempy_labs._helper_functions import (
+from ._generate_report import get_report_definition
+from .._generate_semantic_model import get_semantic_model_definition
+from .._helper_functions import (
     _mount,
     resolve_workspace_name_and_id,
     resolve_item_name,

sempy_labs/theme/_org_themes.py

@@ -1,6 +1,6 @@
 import pandas as pd
 from uuid import UUID
-from sempy_labs._helper_functions import (
+from .._helper_functions import (
     _is_valid_uuid,
     _base_api,
     _update_dataframe_datatypes,
@@ -24,8 +24,8 @@ def list_org_themes() -> pd.DataFrame:
     """
     Lists all `organizational themes <https://www.linkedin.com/pulse/organizational-themes-preview-pbicorevisuals-j7jxe/>`_ in Power BI. Note that this uses an internal API and may break at any time.
 
-    Returns:
-    --------
+    Returns
+    -------
     pandas.DataFrame
         A dataframe containing the details of the organizational themes.
     """
@@ -67,6 +67,19 @@ def list_org_themes() -> pd.DataFrame:
 
 
 def resolve_theme_id(theme: str | UUID):
+    """
+    Resolves the ID of an organization theme by its name or ID.
+
+    Parameters
+    ----------
+    theme : str | uuid.UUID
+        The name or ID of the organization theme.
+
+    Returns
+    -------
+    uuid.UUID
+        The ID of the organization theme.
+    """
 
     if _is_valid_uuid(theme):
         return theme
@@ -83,13 +96,13 @@ def get_org_theme_json(theme: str | UUID) -> dict:
     """
     Retrieves the JSON representation of an organization theme by its name or ID.
 
-    Parameters:
+    Parameters
     ----------
     theme : str | uuid.UUID
         The name or ID of the organization theme.
 
-    Returns:
-    --------
+    Returns
+    -------
     dict
         The JSON representation of the organization theme.
     """

sempy_labs/tom/__init__.py

@@ -1,3 +1,3 @@
-from sempy_labs.tom._model import TOMWrapper, connect_semantic_model
+from ._model import TOMWrapper, connect_semantic_model
 
 __all__ = ["TOMWrapper", "connect_semantic_model"]

sempy_labs/tom/_model.py

@@ -6,7 +6,7 @@ import os
 import json
 from datetime import datetime
 from decimal import Decimal
-from sempy_labs._helper_functions import (
+from .._helper_functions import (
     format_dax_object_name,
     generate_guid,
     _make_list_unique,
@@ -18,9 +18,9 @@ from sempy_labs._helper_functions import (
     resolve_lakehouse_id,
     _validate_weight,
 )
-from sempy_labs._list_functions import list_relationships
-from sempy_labs._refresh_semantic_model import refresh_semantic_model
-from sempy_labs.directlake._dl_helper import check_fallback_reason
+from .._list_functions import list_relationships
+from .._refresh_semantic_model import refresh_semantic_model
+from ..directlake._dl_helper import check_fallback_reason
 from contextlib import contextmanager
 from typing import List, Iterator, Optional, Union, TYPE_CHECKING, Literal
 from sempy._utils._log import log
@@ -28,7 +28,7 @@ import sempy_labs._icons as icons
 import ast
 from uuid import UUID
 import sempy_labs._authentication as auth
-from sempy_labs.lakehouse._lakehouse import lakehouse_attached
+from ..lakehouse._lakehouse import lakehouse_attached
 
 
 if TYPE_CHECKING:
@@ -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}]"

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]