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

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]

sempy_labs/_dax_query_view.py

@@ -1,57 +0,0 @@
-from typing import Optional
-from uuid import UUID
-from ._helper_functions import (
-    resolve_dataset_id,
-    _get_fabric_context_setting,
-    resolve_workspace_id,
-)
-from sempy._utils._log import log
-import gzip
-import base64
-import urllib.parse
-
-
-@log
-def generate_dax_query_view_url(
-    dataset: str | UUID, dax_string: str, workspace: Optional[str | UUID] = None
-):
-    """
-    Prints a URL based on query provided. This URL opens `DAX query view <https://learn.microsoft.com/power-bi/transform-model/dax-query-view>`_ in the Power BI service, connected to the semantic model and using the query provided.
-
-    Parameters
-    ----------
-    dataset : str | uuid.UUID
-        The semantic model name or ID.
-    dax_string : str
-        The DAX query string.
-    workspace : str | uuid.UUID, default=None
-        The 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.
-    """
-
-    workspace_id = resolve_workspace_id(workspace=workspace)
-    dataset_id = resolve_dataset_id(dataset=dataset, workspace=workspace_id)
-
-    prefix = _get_fabric_context_setting(name="spark.trident.pbienv").lower()
-
-    if prefix == "prod":
-        prefix = "app"
-
-    def gzip_base64_urlsafe(input_string):
-        # Compress the string with gzip
-        compressed_data = gzip.compress(input_string.encode("utf-8"))
-
-        # Encode the compressed data in base64
-        base64_data = base64.b64encode(compressed_data)
-
-        # Make the base64 string URL-safe
-        urlsafe_data = urllib.parse.quote_plus(base64_data.decode("utf-8"))
-
-        return urlsafe_data
-
-    formatted_query = gzip_base64_urlsafe(dax_string)
-
-    url = f"https://{prefix}.powerbi.com/groups/{workspace_id}/modeling/{dataset_id}/daxQueryView?query={formatted_query}"
-
-    print(url)

sempy_labs/_ml_models.py

@@ -1,111 +0,0 @@
-import pandas as pd
-from typing import Optional
-from ._helper_functions import (
-    resolve_workspace_id,
-    _base_api,
-    delete_item,
-    _create_dataframe,
-    create_item,
-)
-from uuid import UUID
-from sempy._utils._log import log
-
-
-@log
-def list_ml_models(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
-    """
-    Shows the ML models within a workspace.
-
-    This is a wrapper function for the following API: `Items - List ML Models <https://learn.microsoft.com/rest/api/fabric/mlmodel/items/list-ml-models>`_.
-
-    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 ML models within a workspace.
-    """
-
-    columns = {
-        "ML Model Name": "string",
-        "ML Model Id": "string",
-        "Description": "string",
-    }
-    df = _create_dataframe(columns=columns)
-
-    workspace_id = resolve_workspace_id(workspace)
-
-    responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/mlModels",
-        status_codes=200,
-        uses_pagination=True,
-    )
-
-    rows = []
-    for r in responses:
-        for v in r.get("value", []):
-            model_id = v.get("id")
-            modelName = v.get("displayName")
-            desc = v.get("description")
-
-            rows.append(
-                {
-                    "ML Model Name": modelName,
-                    "ML Model Id": model_id,
-                    "Description": desc,
-                }
-            )
-
-    if rows:
-        df = pd.DataFrame(rows, columns=list(columns.keys()))
-
-    return df
-
-
-@log
-def create_ml_model(
-    name: str, description: Optional[str] = None, workspace: Optional[str | UUID] = None
-):
-    """
-    Creates a Fabric ML model.
-
-    This is a wrapper function for the following API: `Items - Create ML Model <https://learn.microsoft.com/rest/api/fabric/mlmodel/items/create-ml-model>`_.
-
-    Parameters
-    ----------
-    name: str
-        Name of the ML model.
-    description : str, default=None
-        A description of the ML model.
-    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.
-    """
-
-    create_item(name=name, description=description, type="MLModel", workspace=workspace)
-
-
-@log
-def delete_ml_model(name: str | UUID, workspace: Optional[str | UUID] = None):
-    """
-    Deletes a Fabric ML model.
-
-    This is a wrapper function for the following API: `Items - Delete ML Model <https://learn.microsoft.com/rest/api/fabric/mlmodel/items/delete-ml-model>`_.
-
-    Parameters
-    ----------
-    name: str | uuid.UUID
-        Name or ID of the ML model.
-    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=name, type="MLModel", workspace=workspace)

sempy_labs/_variable_libraries.py

@@ -1,92 +0,0 @@
-from ._helper_functions import (
-    resolve_workspace_id,
-    _base_api,
-    _create_dataframe,
-    _update_dataframe_datatypes,
-    delete_item,
-)
-import pandas as pd
-from typing import Optional
-from uuid import UUID
-from sempy._utils._log import log
-
-
-@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/warehouse/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)