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

sempy_labs/_mounted_data_factories.py

@@ -1,6 +1,6 @@
 import pandas as pd
 from typing import Optional
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_id,
     _base_api,
     _create_dataframe,
@@ -49,19 +49,19 @@ def list_mounted_data_factories(
         uses_pagination=True,
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Mounted Data Factory Name": v.get("displayName"),
-                "Mounted Data Factory Id": v.get("id"),
-                "Description": v.get("description"),
-            }
-
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "Mounted Data Factory Name": v.get("displayName"),
+                    "Mounted Data Factory Id": v.get("id"),
+                    "Description": v.get("description"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
         _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df

sempy_labs/_notebooks.py

@@ -1,7 +1,7 @@
 import sempy.fabric as fabric
 import pandas as pd
 import sempy_labs._icons as icons
-from typing import Optional
+from typing import Optional, List
 import base64
 import requests
 from sempy._utils._log import log
@@ -12,9 +12,10 @@ from sempy_labs._helper_functions import (
     _base_api,
     resolve_item_id,
     create_item,
+    _create_dataframe,
 )
 from sempy.fabric.exceptions import FabricHTTPException
-import os
+from os import PathLike
 from uuid import UUID
 
 _notebook_prefix = "notebook-content."
@@ -114,6 +115,7 @@ def import_notebook_from_web(
     description: Optional[str] = None,
     workspace: Optional[str | UUID] = None,
     overwrite: bool = False,
+    folder: Optional[str | PathLike] = None,
 ):
     """
     Creates a new notebook within a workspace based on a Jupyter notebook hosted in the web.
@@ -136,6 +138,9 @@ def import_notebook_from_web(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     overwrite : bool, default=False
         If set to True, overwrites the existing notebook in the workspace if it exists.
+    folder : str | os.PathLike, default=None
+        The folder within the workspace where the notebook will be created.
+        Defaults to None which places the notebook in the root of the workspace.
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
@@ -161,6 +166,7 @@ def import_notebook_from_web(
             workspace=workspace_id,
             description=description,
             format="ipynb",
+            folder=folder,
         )
     elif len(dfI_filt) > 0 and overwrite:
         print(f"{icons.info} Overwrite of notebooks is currently not supported.")
@@ -181,6 +187,7 @@ def create_notebook(
     description: Optional[str] = None,
     workspace: Optional[str | UUID] = None,
     format: Optional[str] = None,
+    folder: Optional[str | PathLike] = None,
 ):
     """
     Creates a new notebook with a definition within a workspace.
@@ -203,6 +210,9 @@ def create_notebook(
     format : str, default=None
         If 'ipynb' is provided than notebook_content should be standard ipynb format
         otherwise notebook_content should be GIT friendly format
+    folder : str | os.PathLike, default=None
+        The folder within the workspace where the notebook will be created.
+        Defaults to None which places the notebook in the root of the workspace.
     """
 
     notebook_payload = base64.b64encode(notebook_content).decode("utf-8")
@@ -226,6 +236,7 @@ def create_notebook(
         workspace=workspace,
         description=description,
         definition=definition_payload,
+        folder=folder,
     )
 
 
@@ -287,3 +298,141 @@ def update_notebook_definition(
     print(
         f"{icons.green_dot} The '{name}' notebook was updated within the '{workspace_name}' workspace."
     )
+
+
+@log
+def list_notebooks(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Shows the notebooks within a workspace.
+
+    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 SQL endpoints within a workspace.
+    """
+
+    columns = {
+        "Notebook Id": "string",
+        "Notebook Name": "string",
+        "Description": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/notebooks", uses_pagination=True
+    )
+
+    rows = []
+    for r in responses:
+        for v in r.get("value", []):
+            rows.append(
+                {
+                    "Notebook Id": v.get("id"),
+                    "Notebook Name": v.get("displayName"),
+                    "Description": v.get("description"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+
+    return df
+
+
+@log
+def search_notebooks(
+    search_string: str,
+    notebook: Optional[str | UUID] = None,
+    workspace: Optional[str | UUID | List[str | UUID]] = None,
+) -> pd.DataFrame:
+    """
+    Searches notebooks within a workspace or across multiple workspaces for a given search string.
+
+    Parameters
+    ----------
+    search_string : str
+        The string to search for within the notebook definitions.
+    notebook : str | uuid.UUID, default=None
+        The name or ID of a specific notebook to search within.
+        Defaults to None which searches across all notebooks in the specified workspace(s).
+    workspace : str | uuid.UUID | list, default=None
+        The name or ID of the workspace or a list of workspaces to search within.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+        If a list is provided, it should contain workspace names or IDs.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the notebooks that contain the search string in their definitions.
+        The dataframe includes the workspace name, workspace ID, notebook name, and notebook ID.
+    """
+
+    if not workspace:
+        workspace_id = resolve_workspace_id(workspace)
+        workspace_ids = [workspace_id]
+    elif isinstance(workspace, str):
+        workspace_id = resolve_workspace_id(workspace)
+        workspace_ids = [workspace_id]
+    elif isinstance(workspace, list):
+        workspace_ids = [resolve_workspace_id(ws) for ws in workspace]
+    else:
+        raise ValueError(
+            "Workspace must be a string, UUID, or a list of strings/UUIDs."
+        )
+
+    dfW = fabric.list_workspaces()
+    dfW_filt = dfW[dfW["Id"].isin(workspace_ids)]
+
+    columns = {
+        "Workspace Name": "string",
+        "Workspace Id": "string",
+        "Notebook Name": "string",
+        "Notebook Id": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    rows = []
+    for _, r in dfW_filt.iterrows():
+        w_id = r["Id"]
+        w_name = r["Name"]
+        dfN = list_notebooks(workspace=w_id)
+        if notebook is not None:
+            item_id = resolve_item_id(item=notebook, type="Notebook", workspace=w_id)
+            dfN = dfN[dfN["Notebook Id"] == item_id]
+        for _, n in dfN.iterrows():
+            notebook_id = n["Notebook Id"]
+            notebook_name = n["Notebook Name"]
+            definition = _base_api(
+                request=f"v1/workspaces/{w_id}/notebooks/{notebook_id}/getDefinition",
+                method="post",
+                client="fabric_sp",
+                status_codes=None,
+                lro_return_json=True,
+            )
+            for part in definition.get("definition").get("parts"):
+                payload = _decode_b64(part["payload"])
+                if part["path"] == "notebook-content.py":
+                    if search_string in payload:
+                        rows.append(
+                            {
+                                "Workspace Name": w_name,
+                                "Workspace Id": w_id,
+                                "Notebook Name": notebook_name,
+                                "Notebook Id": notebook_id,
+                            }
+                        )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+
+    return df

sempy_labs/_one_lake_integration.py

@@ -2,7 +2,7 @@ import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy._utils._log import log
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
     resolve_workspace_id,

sempy_labs/_query_scale_out.py

@@ -1,6 +1,6 @@
 import sempy.fabric as fabric
 import pandas as pd
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
     _update_dataframe_datatypes,

sempy_labs/_refresh_semantic_model.py

@@ -1,6 +1,6 @@
 import sempy.fabric as fabric
 import time
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     _get_partition_map,
     _process_and_display_chart,

sempy_labs/_semantic_models.py

@@ -1,7 +1,7 @@
 from uuid import UUID
 from typing import Optional, List
 import pandas as pd
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     _create_dataframe,
     _base_api,
     _update_dataframe_datatypes,
@@ -298,39 +298,41 @@ def list_semantic_model_datasources(
         client="fabric_sp",
     )
 
-    dfs = []
+    rows = []
     for item in response.json().get("value", []):
         ds_type = item.get("datasourceType")
         conn_details = item.get("connectionDetails", {})
         ds_id = item.get("datasourceId")
         gateway_id = item.get("gatewayId")
         if expand_details:
-            new_data = {
-                "Datasource Type": ds_type,
-                "Connection Server": conn_details.get("server"),
-                "Connection Database": conn_details.get("database"),
-                "Connection Path": conn_details.get("path"),
-                "Connection Account": conn_details.get("account"),
-                "Connection Domain": conn_details.get("domain"),
-                "Connection Kind": conn_details.get("kind"),
-                "Connection Email Address": conn_details.get("emailAddress"),
-                "Connection URL": conn_details.get("url"),
-                "Connection Class Info": conn_details.get("classInfo"),
-                "Connection Login Server": conn_details.get("loginServer"),
-                "Datasource Id": ds_id,
-                "Gateway Id": gateway_id,
-            }
-            dfs.append(pd.DataFrame(new_data, index=[0]))
+            rows.append(
+                {
+                    "Datasource Type": ds_type,
+                    "Connection Server": conn_details.get("server"),
+                    "Connection Database": conn_details.get("database"),
+                    "Connection Path": conn_details.get("path"),
+                    "Connection Account": conn_details.get("account"),
+                    "Connection Domain": conn_details.get("domain"),
+                    "Connection Kind": conn_details.get("kind"),
+                    "Connection Email Address": conn_details.get("emailAddress"),
+                    "Connection URL": conn_details.get("url"),
+                    "Connection Class Info": conn_details.get("classInfo"),
+                    "Connection Login Server": conn_details.get("loginServer"),
+                    "Datasource Id": ds_id,
+                    "Gateway Id": gateway_id,
+                }
+            )
         else:
-            new_data = {
-                "Datasource Type": ds_type,
-                "Connection Details": conn_details,
-                "Datasource Id": ds_id,
-                "Gateway Id": gateway_id,
-            }
-            dfs.append(pd.DataFrame([new_data]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "Datasource Type": ds_type,
+                    "Connection Details": conn_details,
+                    "Datasource Id": ds_id,
+                    "Gateway Id": gateway_id,
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df

sempy_labs/_spark.py

@@ -1,7 +1,7 @@
 import pandas as pd
 import sempy_labs._icons as icons
 from typing import Optional
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     _update_dataframe_datatypes,
     _base_api,

sempy_labs/_sql.py

@@ -3,7 +3,7 @@ from typing import Optional, Union, List
 from sempy._utils._log import log
 import struct
 from itertools import chain, repeat
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_lakehouse_name_and_id,
     resolve_item_name_and_id,
     resolve_workspace_name_and_id,

sempy_labs/_sql_endpoints.py

@@ -1,7 +1,7 @@
 from typing import Optional, Literal
 from uuid import UUID
 import pandas as pd
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     _base_api,
     _create_dataframe,
     resolve_workspace_name_and_id,
@@ -44,19 +44,19 @@ def list_sql_endpoints(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         request=f"/v1/workspaces/{workspace_id}/sqlEndpoints", uses_pagination=True
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
+            rows.append(
+                {
+                    "SQL Endpoint Id": v.get("id"),
+                    "SQL Endpoint Name": v.get("displayName"),
+                    "Description": v.get("description"),
+                }
+            )
 
-            new_data = {
-                "SQL Endpoint Id": v.get("id"),
-                "SQL Endpoint Name": v.get("displayName"),
-                "Description": v.get("description"),
-            }
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
 
@@ -142,6 +142,7 @@ def refresh_sql_endpoint_metadata(
     result = _base_api(
         request=f"v1/workspaces/{workspace_id}/sqlEndpoints/{sql_endpoint_id}/refreshMetadata?preview=true",
         method="post",
+        client="fabric_sp",
         status_codes=[200, 202],
         lro_return_json=True,
         payload=payload,

sempy_labs/_sqldatabase.py

@@ -1,4 +1,4 @@
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_id,
     _base_api,
     _create_dataframe,
@@ -100,23 +100,23 @@ def list_sql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         client="fabric_sp",
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
             prop = v.get("properties", {})
-            new_data = {
-                "SQL Database Name": v.get("displayName"),
-                "SQL Database Id": v.get("id"),
-                "Description": v.get("description"),
-                "Connection Info": prop.get("connectionInfo"),
-                "Database Name": prop.get("databaseName"),
-                "Server FQDN": prop.get("serverFqdn"),
-            }
-
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "SQL Database Name": v.get("displayName"),
+                    "SQL Database Id": v.get("id"),
+                    "Description": v.get("description"),
+                    "Connection Info": prop.get("connectionInfo"),
+                    "Database Name": prop.get("databaseName"),
+                    "Server FQDN": prop.get("serverFqdn"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
         _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df

sempy_labs/_tags.py

@@ -1,4 +1,4 @@
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     _base_api,
     _create_dataframe,
     _update_dataframe_datatypes,
@@ -40,17 +40,18 @@ def list_tags() -> pd.DataFrame:
         client="fabric_sp",
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Tag Name": v.get("displayName"),
-                "Tag Id": v.get("id"),
-            }
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "Tag Name": v.get("displayName"),
+                    "Tag Id": v.get("id"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
         _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df

sempy_labs/_translations.py

@@ -3,7 +3,7 @@ import pandas as pd
 from typing import List, Optional, Union
 from sempy._utils._log import log
 import sempy_labs._icons as icons
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     get_language_codes,
     _create_spark_session,
 )

sempy_labs/_user_delegation_key.py

@@ -1,5 +1,5 @@
-from sempy_labs.lakehouse._blobs import _request_blob_api
-from sempy_labs._helper_functions import (
+from .lakehouse._blobs import _request_blob_api
+from ._helper_functions import (
     _xml_to_dict,
 )
 from datetime import datetime, timedelta, timezone

sempy_labs/_vertipaq.py

@@ -6,7 +6,7 @@ import os
 import shutil
 import datetime
 import warnings
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     format_dax_object_name,
     save_as_delta_table,
     resolve_workspace_capacity,
@@ -17,8 +17,8 @@ from sempy_labs._helper_functions import (
     resolve_workspace_id,
     resolve_workspace_name,
 )
-from sempy_labs._list_functions import list_relationships, list_tables
-from sempy_labs.lakehouse import lakehouse_attached, get_lakehouse_tables
+from ._list_functions import list_relationships, list_tables
+from .lakehouse import lakehouse_attached, get_lakehouse_tables
 from typing import Optional
 from sempy._utils._log import log
 import sempy_labs._icons as icons

sempy_labs/_vpax.py

@@ -6,7 +6,7 @@ import sys
 from pathlib import Path
 from typing import Optional
 from uuid import UUID
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
     resolve_lakehouse_name_and_id,

sempy_labs/_warehouses.py

@@ -1,4 +1,4 @@
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
@@ -111,23 +111,24 @@ def list_warehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         client="fabric_sp",
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
             prop = v.get("properties", {})
 
-            new_data = {
-                "Warehouse Name": v.get("displayName"),
-                "Warehouse Id": v.get("id"),
-                "Description": v.get("description"),
-                "Connection Info": prop.get("connectionInfo"),
-                "Created Date": prop.get("createdDate"),
-                "Last Updated Time": prop.get("lastUpdatedTime"),
-            }
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "Warehouse Name": v.get("displayName"),
+                    "Warehouse Id": v.get("id"),
+                    "Description": v.get("description"),
+                    "Connection Info": prop.get("connectionInfo"),
+                    "Created Date": prop.get("createdDate"),
+                    "Last Updated Time": prop.get("lastUpdatedTime"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
         _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df

sempy_labs/_workloads.py

@@ -1,7 +1,7 @@
 import pandas as pd
 from typing import Optional
 import sempy_labs._icons as icons
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     _update_dataframe_datatypes,
     _base_api,
     _create_dataframe,

sempy_labs/_workspace_identity.py

@@ -1,4 +1,4 @@
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
 )

sempy_labs/_workspaces.py

@@ -1,7 +1,7 @@
 import pandas as pd
 import sempy_labs._icons as icons
 from typing import Optional
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     resolve_capacity_id,
     _base_api,
@@ -144,21 +144,22 @@ def list_workspace_users(workspace: Optional[str | UUID] = None) -> pd.DataFrame
         client="fabric_sp",
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
             p = v.get("principal", {})
-            new_data = {
-                "User Name": p.get("displayName"),
-                "User ID": p.get("id"),
-                "Type": p.get("type"),
-                "Role": v.get("role"),
-                "Email Address": p.get("userDetails", {}).get("userPrincipalName"),
-            }
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "User Name": p.get("displayName"),
+                    "User ID": p.get("id"),
+                    "Type": p.get("type"),
+                    "Role": v.get("role"),
+                    "Email Address": p.get("userDetails", {}).get("userPrincipalName"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df